FieldVariable Class¶
-
class
NXOpen.Fields.
FieldVariable
¶ Bases:
NXOpen.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 **<tt>f(x,y)</tt></b> are **<tt>x</tt></b> and **<tt>y</tt></b>. 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 **<tt>dependent variables</tt></b>. In NX, a field with a single dependent variable is called a **<tt>scalar field</tt></b>, with three variables of the same measure a **<tt>vector field</tt></b>, all others are simply referred to as fields.
In NX, all variables have a measure and associated unit type specification (see also
NXOpen.Unit
).New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
DefaultValue | Returns the variable’s default value which is value used when evaluating a field and no value is specified |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Logarithmic | Returns the flag indicating if the units for this variable are stored/retrieved as logarithmic units |
Name | Returns the custom name of the object. |
NameVariable | Returns the name variable for this variable. |
NumPoints | Returns the number of points used for this variable when generating a table |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
Units | Returns the units for this variable, which can be None if the variable is unitless. |
VariableBounds | Returns the variable’s minimum and maximum bounds. |
VariableType | Returns the type of variable. |
Methods¶
Method | Description |
---|---|
CreateAttributeIterator | Create an attribute iterator |
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
Prints a representation of this object to the system log file. | |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetName | Sets the custom name of the object. |
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
Enumerations¶
FieldVariableType Enumeration | Variable Types |
FieldVariableValueType Enumeration | Variable value Type |
Structs¶
FieldVariableBounds_Struct Struct | Variable Bounds structure |
Property Detail¶
DefaultValue¶
-
FieldVariable.
DefaultValue
¶ Returns the variable’s default value which is value used when evaluating a field and no value is specified
-------------------------------------
Getter Method
Signature
DefaultValue
Returns: Return type: float New in version NX7.5.2.
License requirements: None.
IsOccurrence¶
-
FieldVariable.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
FieldVariable.
JournalIdentifier
¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------
Getter Method
Signature
JournalIdentifier
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Logarithmic¶
-
FieldVariable.
Logarithmic
¶ Returns the flag indicating if the units for this variable are stored/retrieved as logarithmic units
-------------------------------------
Getter Method
Signature
Logarithmic
Returns: a flag specifying if the variable units are logarithmic Return type: bool New in version NX9.0.0.
License requirements: None.
Name¶
-
FieldVariable.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
NameVariable¶
-
FieldVariable.
NameVariable
¶ Returns the name variable for this variable.
-------------------------------------
Getter Method
Signature
NameVariable
Returns: Units for this Variable Return type: NXOpen.Fields.NameVariable
New in version NX7.5.2.
License requirements: None.
NumPoints¶
-
FieldVariable.
NumPoints
¶ Returns the number of points used for this variable when generating a table
-------------------------------------
Getter Method
Signature
NumPoints
Returns: Return type: int New in version NX7.5.2.
License requirements: None.
OwningComponent¶
-
FieldVariable.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
FieldVariable.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
Prototype¶
-
FieldVariable.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Units¶
-
FieldVariable.
Units
¶ Returns the units for this variable, which can be None if the variable is unitless.
-------------------------------------
Getter Method
Signature
Units
Returns: Units for this Variable Return type: NXOpen.Unit
New in version NX7.5.2.
License requirements: None.
VariableBounds¶
-
FieldVariable.
VariableBounds
¶ Returns the variable’s minimum and maximum bounds.
-------------------------------------
Getter Method
Signature
VariableBounds
Returns: Return type: NXOpen.Fields.FieldVariableBounds_Struct
New in version NX7.5.2.
License requirements: None.
VariableType¶
-
FieldVariable.
VariableType
¶ Returns the type of variable.
-------------------------------------
Getter Method
Signature
VariableType
Returns: Type of Variable Return type: NXOpen.Fields.FieldVariableType
New in version NX7.5.2.
License requirements: None.
Method Detail¶
FindObject¶
-
FieldVariable.
FindObject
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
Print¶
-
FieldVariable.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetName¶
-
FieldVariable.
SetName
¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)
Parameters: name (str) – New in version NX3.0.0.
License requirements: None.