NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Fields::FieldEvaluator Class Reference

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

Inheritance diagram for NXOpen::Fields::FieldEvaluator:
NXOpen::TaggedObject

List of all members.

Public Types

enum  InterpolationEnum {
  InterpolationEnumNone, InterpolationEnumLinear1d, InterpolationEnumNearestNeighbor1d, InterpolationEnumInverseDistanceWeighting1d,
  InterpolationEnumDelaunay2dFast, InterpolationEnumDelaunay2dMedium, InterpolationEnumDelaunay2dAccurate, InterpolationEnumNearestNeighbor2d,
  InterpolationEnumRenkaShepard2d, InterpolationEnumInverseDistanceWeighting2d, InterpolationEnumDelaunay3dFast, InterpolationEnumDelaunay3dMedium,
  InterpolationEnumDelaunay3dAccurate, InterpolationEnumNearestNeighbor3d, InterpolationEnumRenkaShepard3d, InterpolationEnumInverseDistanceWeighting3d,
  InterpolationEnumNearestNeighborNd, InterpolationEnumRenkaShepardNd, InterpolationEnumInverseDistanceWeightingNd
}
 Interpolation type. More...

Public Member Functions

void Delete ()
 Delete this field evaluator; destroys the field evaluator and removes all references to it.
std::vector< double > Evaluate (NXOpen::Fields::FieldVariable *dependentVariable)
 Evaluate the Field at the specified independent variable Fields::FieldVariable values and return the values for the specified dependent variable.
std::vector
< NXOpen::Fields::FieldVariable * > 
GetDependentVariables ()
 Returns the dependent variables for this Fields::FieldEvaluator.
std::vector
< NXOpen::Fields::FieldVariable * > 
GetIndependentVariables ()
 Returns the independent variables for this Fields::FieldEvaluator.
NXOpen::Fields::FieldEvaluator::InterpolationEnum InterpolationMethod ()
 Returns the interpolation method used when this table data is evaluated.
void SetIndependentVariableValues (NXOpen::Fields::FieldVariable *independentVariable, const std::vector< double > &values)
 Sets values at which the Field will be evaluated for this independent variable Fields::FieldVariable .
void SetInterpolationMethod (NXOpen::Fields::FieldEvaluator::InterpolationEnum interpolationMethod)
 Sets the interpolation method used when this table data is evaluated.

Detailed Description

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


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

Created in NX7.5.2.


Member Enumeration Documentation

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.


Member Function Documentation

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 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 Fields::FieldVariable .

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

License requirements : None
Parameters:
dependentVariabledependent variable whose values are to be evaluated

Returns the dependent variables for this Fields::FieldEvaluator.

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

License requirements : None

Returns the independent variables for this Fields::FieldEvaluator.

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

License requirements : None

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 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 Fields::FieldVariable .


Created in NX7.5.2.

License requirements : None

Parameters:
independentVariableindependent variable whose values are being set.
valuesthe values for this independent variable where the field will be evaluated at.

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


Created in NX7.5.2.

License requirements : None

Parameters:
interpolationMethodthe interpolation method

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.