Represents a Field Evaluator which can be used to evaluate a NXOpen::Fields::Field . More...

Inheritance diagram for NXOpen::Fields::FieldEvaluator:

Public Types
enum	InterpolationEnum { InterpolationEnumNone, InterpolationEnumLinear1d, InterpolationEnumNearestNeighbor1d, InterpolationEnumInverseDistanceWeighting1d, InterpolationEnumDelaunay2dFast, InterpolationEnumDelaunay2dMedium, InterpolationEnumDelaunay2dAccurate, InterpolationEnumNearestNeighbor2d, InterpolationEnumRenkaShepard2d, InterpolationEnumInverseDistanceWeighting2d, InterpolationEnumDelaunay3dFast, InterpolationEnumDelaunay3dMedium, InterpolationEnumDelaunay3dAccurate, InterpolationEnumNearestNeighbor3d, InterpolationEnumRenkaShepard3d, InterpolationEnumInverseDistanceWeighting3d, InterpolationEnumNearestNeighborNd, InterpolationEnumRenkaShepardNd, InterpolationEnumInverseDistanceWeightingNd, InterpolationEnumApproxNearestNeighbor2d, InterpolationEnumApproxNearestNeighbor3d, InterpolationEnumApproxNearestNeighborNd, InterpolationEnumAkima1d, InterpolationEnumAkima721d, InterpolationEnumCubic1d, InterpolationEnumBilinear2d, InterpolationEnumBiakima2d, InterpolationEnumBiakima722d, InterpolationEnumBicubic2d, InterpolationEnumAkimaLinear2d, InterpolationEnumAkima72Linear2d, InterpolationEnumCubicLinear2d }
	Interpolation type. More...

enum	InverseDistanceWeightingEnum { InverseDistanceWeightingEnumAll, InverseDistanceWeightingEnumRadius, InverseDistanceWeightingEnumNearestPoints }
	Options for IDW (inverse weighted distance) interpolator. More...

enum	LinearLogOptionEnum { LinearLogOptionEnumLinearLinear, LinearLogOptionEnumLogLinear, LinearLogOptionEnumLinearLog, LinearLogOptionEnumLogLog }
	Log Options for Linear interpolator. More...

enum	ValuesOutsideTableInterpolationEnum { ValuesOutsideTableInterpolationEnumUndefined, ValuesOutsideTableInterpolationEnumExtrapolate, ValuesOutsideTableInterpolationEnumConstant, ValuesOutsideTableInterpolationEnumLinear, ValuesOutsideTableInterpolationEnumParabolic, ValuesOutsideTableInterpolationEnumCubic }
	Options for outside table values interpolation. More...

Public Member Functions
void	Delete ()
	Delete this field evaluator; destroys the field evaluator and removes all references to it. More...

std::vector< double >	Evaluate (NXOpen::Fields::FieldVariable *dependentVariable)
	Evaluate the Field at the specified independent variable NXOpen::Fields::FieldVariable values and return the values for the specified dependent variable. More...

std::vector < NXOpen::Fields::FieldVariable * >	GetDependentVariables ()
	Returns the dependent variables for this NXOpen::Fields::FieldEvaluator. More...

std::vector < NXOpen::Fields::FieldVariable * >	GetIndependentVariables ()
	Returns the independent variables for this NXOpen::Fields::FieldEvaluator. More...

NXOpen::Fields::FieldEvaluator::InterpolationEnum	InterpolationMethod ()
	Returns the interpolation method used when this table data is evaluated. More...

void	SetIndependentVariableValues (NXOpen::Fields::FieldVariable *independentVariable, const std::vector< double > &values)
	Sets values at which the Field will be evaluated for this independent variable NXOpen::Fields::FieldVariable . More...

void	SetInterpolationMethod (NXOpen::Fields::FieldEvaluator::InterpolationEnum interpolationMethod)
	Sets the interpolation method used when this table data is evaluated. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a Field Evaluator which can be used to evaluate a NXOpen::Fields::Field .

Use NXOpen::Fields::Field::GetFieldEvaluator to obtain an instance of this class

Created in NX7.5.2.

Member Enumeration Documentation

enum NXOpen::Fields::FieldEvaluator::InterpolationEnum

Interpolation type.

Enumerator
InterpolationEnumNone	No interpolation method; table can only be used as a lookup.
InterpolationEnumLinear1d	Standard linear interpolation between bounding points.
InterpolationEnumNearestNeighbor1d	Locates the nearest point and returns its value.
InterpolationEnumInverseDistanceWeighting1d	Sum of the weighted value of all points, based on the inverse of the distance.
InterpolationEnumDelaunay2dFast	Triangulates the independent values and uses the bounding triangle, sacrifices accuracy for speed.
InterpolationEnumDelaunay2dMedium	Triangulates the independent values and uses the bounding triangle, compromise between accuracy and speed.
InterpolationEnumDelaunay2dAccurate	Triangulates the independent values and uses the bounding triangle, sacrifices speed for accuracy.
InterpolationEnumNearestNeighbor2d	Locates the nearest point in a plane and returns its value.
InterpolationEnumRenkaShepard2d	Refined inverse distance weighting in 2D space.
InterpolationEnumInverseDistanceWeighting2d	Sum of the weighted value of all points in 2D space, based on the inverse of the distance.
InterpolationEnumDelaunay3dFast	Creates Tetrahedrals using the independent values and uses the bounding tetrahedron, sacrifices accuracy for speed.
InterpolationEnumDelaunay3dMedium	Creates Tetrahedrals using the independent values and uses the bounding tetrahedron, compromise between accuracy and speed.
InterpolationEnumDelaunay3dAccurate	Creates Tetrahedrals using the independent values and uses the bounding tetrahedron, sacrifices speed for accuracy.
InterpolationEnumNearestNeighbor3d	Locates the nearest point in space and returns its value.
InterpolationEnumRenkaShepard3d	Refined inverse distance weighting in 3D space.
InterpolationEnumInverseDistanceWeighting3d	Sum of the weighted value of all points in 3D space, based on the inverse of the distance.
InterpolationEnumNearestNeighborNd	Locates the nearest point in N dimensional space and returns its value.
InterpolationEnumRenkaShepardNd	Refined inverse distance weighting in N dimensional space.
InterpolationEnumInverseDistanceWeightingNd	Sum of the weighted value of all points in N dimensional, based on the inverse of the distance.
InterpolationEnumApproxNearestNeighbor2d	Locates the approximate nearest point in a plane and returns its value.
InterpolationEnumApproxNearestNeighbor3d	Locates the approximate nearest point in space and returns its value.
InterpolationEnumApproxNearestNeighborNd	Locates the approximate nearest point in N dimensional space and returns its value.
InterpolationEnumAkima1d	akima interpolation
InterpolationEnumAkima721d	akima72 interpolation
InterpolationEnumCubic1d	cubic interpolation
InterpolationEnumBilinear2d	linear interpolation in both directions
InterpolationEnumBiakima2d	akima interpolation in both directions
InterpolationEnumBiakima722d	akima72 interpolation in both directions
InterpolationEnumBicubic2d	cubic interpolation in both directions
InterpolationEnumAkimaLinear2d	akima interpolation in x direction, linear in y direction
InterpolationEnumAkima72Linear2d	akima72 interpolation in x direction, linear in y direction
InterpolationEnumCubicLinear2d	cubic interpolation in x direction, linear in y direction

enum NXOpen::Fields::FieldEvaluator::InverseDistanceWeightingEnum

Options for IDW (inverse weighted distance) interpolator.

Enumerator
InverseDistanceWeightingEnumAll	Sum of the weighted value of all points, based on the inverse of the distance.
InverseDistanceWeightingEnumRadius	Sum of the weighted value of points within a radius (as a fraction of the bounding box diagonal), based on the inverse of the distance.
InverseDistanceWeightingEnumNearestPoints	Sum of the weighted value of N nearest points (as a fraction of the total number of points), based on the inverse of the distance.

enum NXOpen::Fields::FieldEvaluator::LinearLogOptionEnum

Log Options for Linear interpolator.

Enumerator
LinearLogOptionEnumLinearLinear	Standard linear interpolation. Both Independent variable and Dependent variable scaling are linear
LinearLogOptionEnumLogLinear	Independent variable scaling is logarithmic (ln), Dependent variable scaling is linear.
LinearLogOptionEnumLinearLog	Independent variable scaling is linear, Dependent variable scaling is logarithmic (ln)
LinearLogOptionEnumLogLog	Both Independent variable and Dependent variable scaling are logarithmic (ln)

enum NXOpen::Fields::FieldEvaluator::ValuesOutsideTableInterpolationEnum

Options for outside table values interpolation.

Enumerator
ValuesOutsideTableInterpolationEnumUndefined	No interpolation result.
ValuesOutsideTableInterpolationEnumExtrapolate	Extrapolates from the boundary out into space using the same interpolation method that the interpolator for interior table values uses.
ValuesOutsideTableInterpolationEnumConstant	Returns the boundary value as interpolation result.
ValuesOutsideTableInterpolationEnumLinear	Extrapolates from the boundary out into space using the linear extrapolation method.
ValuesOutsideTableInterpolationEnumParabolic	Extrapolates from the boundary out into space using the parabolic extrapolation method.
ValuesOutsideTableInterpolationEnumCubic	Extrapolates from the boundary out into space using the cubic extrapolation method.

Member Function Documentation

void NXOpen::Fields::FieldEvaluator::Delete ( )

Delete this field evaluator; destroys the field evaluator and removes all references to it.

Created in NX7.5.2.

License requirements : None

std::vector<double> NXOpen::Fields::FieldEvaluator::Evaluate ( NXOpen::Fields::FieldVariable * dependentVariable )

Evaluate the Field at the specified independent variable NXOpen::Fields::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 NXOpen::Fields::FieldVariable .

Returns: the values evaluated for this dependent variable
Created in NX7.5.2.

License requirements : None

Parameters

dependentVariable dependent variable whose values are to be evaluated

std::vector<NXOpen::Fields::FieldVariable *> NXOpen::Fields::FieldEvaluator::GetDependentVariables ( )

Returns the dependent variables for this NXOpen::Fields::FieldEvaluator.

Returns: dependent variables for this NXOpen::Fields::FieldEvaluator
Created in NX7.5.2.

License requirements : None

std::vector<NXOpen::Fields::FieldVariable *> NXOpen::Fields::FieldEvaluator::GetIndependentVariables ( )

Returns the independent variables for this NXOpen::Fields::FieldEvaluator.

Returns: independent variables for this NXOpen::Fields::FieldEvaluator
Created in NX7.5.2.

License requirements : None

NXOpen::Fields::FieldEvaluator::InterpolationEnum NXOpen::Fields::FieldEvaluator::InterpolationMethod ( )

Returns the interpolation method used when this table data is evaluated.

Created in NX7.5.2.

License requirements : None

void NXOpen::Fields::FieldEvaluator::SetIndependentVariableValues	(	NXOpen::Fields::FieldVariable *	independentVariable,
		const std::vector< double > &	values
	)

Sets values at which the Field will be evaluated for this independent variable NXOpen::Fields::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 NXOpen::Fields::FieldVariable .

Created in NX7.5.2.

License requirements : None

Parameters

independentVariable	independent variable whose values are being set.
values	the values for this independent variable where the field will be evaluated at.

void NXOpen::Fields::FieldEvaluator::SetInterpolationMethod ( NXOpen::Fields::FieldEvaluator::InterpolationEnum interpolationMethod )

Sets the interpolation method used when this table data is evaluated.

Created in NX7.5.2.

License requirements : None

Parameters

interpolationMethod the interpolation method

The documentation for this class was generated from the following file:

Fields_FieldEvaluator.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation