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

Represents the Field Variables. More...

Inheritance diagram for NXOpen::Fields::FieldVariable:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Classes

struct  Bounds
 Variable Bounds structure. More...

Public Types

enum  Type { TypeUnknown = -1, TypeIndependent, TypeDependent }
 Variable Types. More...
enum  ValueType { ValueTypeReal, ValueTypeImaginary, ValueTypeComplexRealImaginary, ValueTypeComplexMagnitudePhase }
 Variable value Type. More...

Public Member Functions

double DefaultValue ()
 Returns the variable's default value which is value used when evaluating a field and no value is specified.
NXOpen::Fields::NameVariableNameVariable ()
 Returns the name variable for this variable.
int NumPoints ()
 Returns the number of points used for this variable when generating a table.
NXOpen::UnitUnits ()
 Returns the units for this variable, which can be NULL if the variable is unitless.
NXOpen::Fields::FieldVariable::Bounds VariableBounds ()
 Returns the variable's minimum and maximum bounds.
NXOpen::Fields::FieldVariable::Type VariableType ()
 Returns the type of variable.

Detailed Description

Represents the Field Variables.


A variable is a symbol on whose value a function, polynomial, etc., depends. For example, the variables in the function f(x,y) are x and y. A function having a single variable is said to be univariate, one having two variables is said to be bivariate, and one having three or more variables is said to be multivariate. In NX, variables in this sense are specifically referred to as independent variables.


In NX, variables are also used to describe the output of a function; these are referred to as the dependent variables. In NX, a field with a single dependent variable is called a scalar field, with three variables of the same measure a vector field, all others are simply referred to as fields.


In NX, all variables have a measure and associated unit type specification (see also Unit ).


Created in NX4.0.0.


Member Enumeration Documentation

Variable Types.

Enumerator:
TypeIndependent 

independent

TypeDependent 

dependent

Variable value Type.

Enumerator:
ValueTypeReal 

real

ValueTypeImaginary 

imaginary

ValueTypeComplexRealImaginary 

complex_real_imaginary

ValueTypeComplexMagnitudePhase 

complex_magnitude_phase


Member Function Documentation

Returns the variable's default value which is value used when evaluating a field and no value is specified.


Created in NX7.5.2.

License requirements : None

Returns the name variable for this variable.


Created in NX7.5.2.

License requirements : None

Returns the number of points used for this variable when generating a table.


Created in NX7.5.2.

License requirements : None

Returns the units for this variable, which can be NULL if the variable is unitless.


Created in NX7.5.2.

License requirements : None

Returns the variable's minimum and maximum bounds.


Created in NX7.5.2.

License requirements : None

Returns the type of variable.


Created in NX7.5.2.

License requirements : None


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