nxopen.fields

Interface FieldVariable

All Superinterfaces:

INXObject, NXObject, Remote, TaggedObject

public interface FieldVariable
extends NXObject

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FieldVariable.Bounds Variable Bounds structure
static class	FieldVariable.Type Variable Types
static class	FieldVariable.ValueType Variable value Type

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat, NXObject.NextUserAttributeData

Method Summary

Modifier and Type	Method and Description
double	defaultValue() Returns the variable's default value which is value used when evaluating a field and no value is specified License requirements: None.
boolean	logarithmic() Returns the flag indicating if the units for this variable are stored/retrieved as logarithmic units License requirements: None.
NameVariable	nameVariable() Returns the name variable for this variable.
int	numPoints() Returns the number of points used for this variable when generating a table License requirements: None.
Unit	units() Returns the units for this variable, which can be null if the variable is unitless.
FieldVariable.Bounds	variableBounds() Returns the variable's minimum and maximum bounds.
FieldVariable.Type	variableType() Returns the type of variable.

Methods inherited from interface nxopen.NXObject

createAttributeIterator, deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getNextUserAttribute, getPdmReferenceAttributeValue, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setPdmReferenceAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

units

Unit units()
    throws NXException,
           RemoteException

Returns the units for this variable, which can be null if the variable is unitless.
License requirements: None.

Created in NX7.5.2

Returns:

Units for this Variable

Throws:

NXException

RemoteException

nameVariable

NameVariable nameVariable()
                   throws NXException,
                          RemoteException

Returns the name variable for this variable.
License requirements: None.

Created in NX7.5.2

Returns:

Units for this Variable

Throws:

NXException

RemoteException

variableType

FieldVariable.Type variableType()
                         throws NXException,
                                RemoteException

Returns the type of variable.
License requirements: None.

Created in NX7.5.2

Returns:

Type of Variable

Throws:

NXException

RemoteException

variableBounds

FieldVariable.Bounds variableBounds()
                             throws NXException,
                                    RemoteException

Returns the variable's minimum and maximum bounds.
License requirements: None.

Created in NX7.5.2

Throws:

NXException

RemoteException

defaultValue

double defaultValue()
             throws NXException,
                    RemoteException

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

Created in NX7.5.2

Throws:

NXException

RemoteException

numPoints

int numPoints()
       throws NXException,
              RemoteException

Returns the number of points used for this variable when generating a table
License requirements: None.

Created in NX7.5.2

Throws:

NXException

RemoteException

logarithmic

boolean logarithmic()
             throws NXException,
                    RemoteException

Returns the flag indicating if the units for this variable are stored/retrieved as logarithmic units
License requirements: None.

Created in NX9.0.0

Returns:

a flag specifying if the variable units are logarithmic

Throws:

NXException

RemoteException