nxopen.fields

Interface FieldEvaluator

All Superinterfaces:

Remote, TaggedObject

public interface FieldEvaluator
extends TaggedObject

Represents a Field Evaluator which can be used to evaluate a Field .
Use Field.getFieldEvaluator() to obtain an instance of this class

Created in NX7.5.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FieldEvaluator.InterpolationEnum Interpolation type
static class	FieldEvaluator.InverseDistanceWeightingEnum Options for IDW (inverse weighted distance) interpolator
static class	FieldEvaluator.LinearLogOptionEnum Log Options for Linear interpolator
static class	FieldEvaluator.ValuesOutsideTableInterpolationEnum Options for outside table values interpolation

Method Summary

Modifier and Type	Method and Description
void	delete() Delete this field evaluator; destroys the field evaluator and removes all references to it.
double[]	evaluate(FieldVariable dependentVariable) Evaluate the Field at the specified independent variable FieldVariable values and return the values for the specified dependent variable.
FieldVariable[]	getDependentVariables() Returns the dependent variables for this FieldEvaluator License requirements: None.
FieldVariable[]	getIndependentVariables() Returns the independent variables for this FieldEvaluator License requirements: None.
FieldEvaluator.InterpolationEnum	interpolationMethod() Returns the interpolation method used when this table data is evaluated.
void	setIndependentVariableValues(FieldVariable independentVariable, double[] values) Sets values at which the Field will be evaluated for this independent variable FieldVariable .
void	setInterpolationMethod(FieldEvaluator.InterpolationEnum interpolationMethod) License requirements: None.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Method Detail

getDependentVariables

FieldVariable[] getDependentVariables()
                               throws NXException,
                                      RemoteException

Returns the dependent variables for this FieldEvaluator
License requirements: None.

Created in NX7.5.2

Returns:

dependent variables for this FieldEvaluator

Throws:

NXException

RemoteException

getIndependentVariables

FieldVariable[] getIndependentVariables()
                                 throws NXException,
                                        RemoteException

Returns the independent variables for this FieldEvaluator
License requirements: None.

Created in NX7.5.2

Returns:

independent variables for this FieldEvaluator

Throws:

NXException

RemoteException

setIndependentVariableValues

void setIndependentVariableValues(FieldVariable independentVariable,
                                  double[] values)
                           throws NXException,
                                  RemoteException

Sets values at which the Field will be evaluated for this independent variable FieldVariable . The number of input values mush be the same for independent variables and these values are assumed to be in the same units as the independent variable FieldVariable .
License requirements: None.

Created in NX7.5.2

Parameters:

independentVariable - independent variable whose values are being set.

values - the values for this independent variable where the field will be evaluated at.

Throws:

NXException

RemoteException

evaluate

double[] evaluate(FieldVariable dependentVariable)
           throws NXException,
                  RemoteException

Evaluate the Field at the specified independent variable FieldVariable values and return the values for the specified dependent variable. The number of output values will be the same as number of independent variables specified and these values will be in the same units as the dependent variable FieldVariable .
License requirements: None.

Created in NX7.5.2

Parameters:

dependentVariable - dependent variable whose values are to be evaluated

Returns:

the values evaluated for this dependent variable

Throws:

NXException

RemoteException

interpolationMethod

FieldEvaluator.InterpolationEnum interpolationMethod()
                                              throws NXException,
                                                     RemoteException

Returns the interpolation method used when this table data is evaluated.
License requirements: None.

Created in NX7.5.2

Returns:

the interpolation method

Throws:

NXException

RemoteException

setInterpolationMethod

void setInterpolationMethod(FieldEvaluator.InterpolationEnum interpolationMethod)
                     throws NXException,
                            RemoteException

License requirements: None.

Created in NX7.5.2

Parameters:

interpolationMethod - the interpolation method

Throws:

NXException

RemoteException

delete

void delete()
     throws NXException,
            RemoteException

Delete this field evaluator; destroys the field evaluator and removes all references to it.
License requirements: None.

Created in NX7.5.2

Throws:

NXException

RemoteException