NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Fields.FieldEvaluator Class Reference

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

Inheritance diagram for NXOpen.Fields.FieldEvaluator:
NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  InterpolationEnum {
  None, Linear1d, NearestNeighbor1d, InverseDistanceWeighting1d,
  Delaunay2dFast, Delaunay2dMedium, Delaunay2dAccurate, NearestNeighbor2d,
  RenkaShepard2d, InverseDistanceWeighting2d, Delaunay3dFast, Delaunay3dMedium,
  Delaunay3dAccurate, NearestNeighbor3d, RenkaShepard3d, InverseDistanceWeighting3d,
  NearestNeighborNd, RenkaShepardNd, InverseDistanceWeightingNd, ApproxNearestNeighbor2d,
  ApproxNearestNeighbor3d, ApproxNearestNeighborNd, Akima1d, Akima721d,
  Cubic1d, Bilinear2d, Biakima2d, Biakima722d,
  Bicubic2d, AkimaLinear2d, Akima72Linear2d, CubicLinear2d
}
 Interpolation type More...
 
enum  InverseDistanceWeightingEnum { All, Radius, NearestPoints, NumNearestPoints }
 Options for IDW (inverse weighted distance) interpolator More...
 
enum  LinearLogOptionEnum { LinearLinear, LogLinear, LinearLog, LogLog }
 Log Options for Linear interpolator More...
 
enum  ValuesOutsideTableInterpolationEnum {
  Undefined, Extrapolate, Constant, Linear,
  Parabolic, Cubic, Userdefined
}
 Options for outside table values interpolation More...
 

Public Member Functions

unsafe void Delete ()
 Delete this field evaluator; destroys the field evaluator and removes all references to it. More...
 
unsafe 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...
 
unsafe
NXOpen.Fields.FieldVariable[] 
GetDependentVariables ()
 Returns the dependent variables for this NXOpen.Fields.FieldEvaluator More...
 
unsafe
NXOpen.Fields.FieldVariable[] 
GetIndependentVariables ()
 Returns the independent variables for this NXOpen.Fields.FieldEvaluator More...
 
unsafe void SetIndependentVariableValues (NXOpen.Fields.FieldVariable independentVariable, double[] values)
 Sets values at which the Field will be evaluated for this independent variable NXOpen.Fields.FieldVariable . More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Fields.FieldEvaluator.InterpolationEnum 
InterpolationMethod [get, set]
 Returns or sets the interpolation method used when this table data is evaluated. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

Interpolation type

Enumerator
None 

No interpolation method; table can only be used as a lookup

Linear1d 

Standard linear interpolation between bounding points

NearestNeighbor1d 

Locates the nearest point and returns its value

InverseDistanceWeighting1d 

Sum of the weighted value of all points, based on the inverse of the distance

Delaunay2dFast 

Triangulates the independent values and uses the bounding triangle, sacrifices accuracy for speed

Delaunay2dMedium 

Triangulates the independent values and uses the bounding triangle, compromise between accuracy and speed

Delaunay2dAccurate 

Triangulates the independent values and uses the bounding triangle, sacrifices speed for accuracy

NearestNeighbor2d 

Locates the nearest point in a plane and returns its value

RenkaShepard2d 

Refined inverse distance weighting in 2D space

InverseDistanceWeighting2d 

Sum of the weighted value of all points in 2D space, based on the inverse of the distance

Delaunay3dFast 

Creates Tetrahedrals using the independent values and uses the bounding tetrahedron, sacrifices accuracy for speed

Delaunay3dMedium 

Creates Tetrahedrals using the independent values and uses the bounding tetrahedron, compromise between accuracy and speed

Delaunay3dAccurate 

Creates Tetrahedrals using the independent values and uses the bounding tetrahedron, sacrifices speed for accuracy

NearestNeighbor3d 

Locates the nearest point in space and returns its value

RenkaShepard3d 

Refined inverse distance weighting in 3D space

InverseDistanceWeighting3d 

Sum of the weighted value of all points in 3D space, based on the inverse of the distance

NearestNeighborNd 

Locates the nearest point in N dimensional space and returns its value

RenkaShepardNd 

Refined inverse distance weighting in N dimensional space

InverseDistanceWeightingNd 

Sum of the weighted value of all points in N dimensional, based on the inverse of the distance

ApproxNearestNeighbor2d 

Locates the approximate nearest point in a plane and returns its value

ApproxNearestNeighbor3d 

Locates the approximate nearest point in space and returns its value

ApproxNearestNeighborNd 

Locates the approximate nearest point in N dimensional space and returns its value

Akima1d 

akima interpolation

Akima721d 

akima72 interpolation

Cubic1d 

cubic interpolation

Bilinear2d 

linear interpolation in both directions

Biakima2d 

akima interpolation in both directions

Biakima722d 

akima72 interpolation in both directions

Bicubic2d 

cubic interpolation in both directions

AkimaLinear2d 

akima interpolation in x direction, linear in y direction

Akima72Linear2d 

akima72 interpolation in x direction, linear in y direction

CubicLinear2d 

cubic interpolation in x direction, linear in y direction

Options for IDW (inverse weighted distance) interpolator

Enumerator
All 

Sum of the weighted value of all points, based on the inverse of the distance

Radius 

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

NearestPoints 

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

NumNearestPoints 

Sum of the weighted value of N nearest points, based on the inverse of the distance

Log Options for Linear interpolator

Enumerator
LinearLinear 

Standard linear interpolation.

Both Independent variable and Dependent variable scaling are linear

LogLinear 

Independent variable scaling is logarithmic (ln), Dependent variable scaling is linear

LinearLog 

Independent variable scaling is linear, Dependent variable scaling is logarithmic (ln)

LogLog 

Both Independent variable and Dependent variable scaling are logarithmic (ln)

Options for outside table values interpolation

Enumerator
Undefined 

No interpolation result

Extrapolate 

Extrapolates from the boundary out into space using the same interpolation method that the interpolator for interior table values uses

Constant 

Returns the boundary value as interpolation result

Linear 

Extrapolates from the boundary out into space using the linear extrapolation method

Parabolic 

Extrapolates from the boundary out into space using the parabolic extrapolation method

Cubic 

Extrapolates from the boundary out into space using the cubic extrapolation method

Userdefined 

Returns the user specified value as the interpolation result

Member Function Documentation

unsafe void NXOpen.Fields.FieldEvaluator.Delete ( )
inline

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

Created in NX7.5.2

License requirements: None.

unsafe double [] NXOpen.Fields.FieldEvaluator.Evaluate ( NXOpen.Fields.FieldVariable  dependentVariable)
inline

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 .

Created in NX7.5.2

License requirements: None.

Parameters
dependentVariabledependent variable whose values are to be evaluated
Returns
the values evaluated for this dependent variable
unsafe NXOpen.Fields.FieldVariable [] NXOpen.Fields.FieldEvaluator.GetDependentVariables ( )
inline

Returns the dependent variables for this NXOpen.Fields.FieldEvaluator

Created in NX7.5.2

License requirements: None.

Returns
dependent variables for this NXOpen.Fields.FieldEvaluator
unsafe NXOpen.Fields.FieldVariable [] NXOpen.Fields.FieldEvaluator.GetIndependentVariables ( )
inline

Returns the independent variables for this NXOpen.Fields.FieldEvaluator

Created in NX7.5.2

License requirements: None.

Returns
independent variables for this NXOpen.Fields.FieldEvaluator
unsafe void NXOpen.Fields.FieldEvaluator.SetIndependentVariableValues ( NXOpen.Fields.FieldVariable  independentVariable,
double[]  values 
)
inline

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
independentVariableindependent variable whose values are being set.
valuesthe values for this independent variable where the field will be evaluated at.

Property Documentation

unsafe NXOpen.Fields.FieldEvaluator.InterpolationEnum NXOpen.Fields.FieldEvaluator.InterpolationMethod
getset

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

Created in NX7.5.2

License requirements to get this property: None.

License requirements to set this property: None.


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