Field Class¶
-
class
NXOpen.Fields.
Field
¶ Bases:
NXOpen.DisplayableObject
Represents an Field abstract class.
Fields represent a way of defining a function for one or more dependent domains/variables (see
NXOpen.Fields.FieldVariable
) based on relationships to one or more independent domains/variables (time, temperature, etc.).Fields are a generic, reusable concept that crosses many areas of functionality. Defined properly, they provide an extendable concept that can service both simple and complicated needs, for example, modeling elements, properties, materials, boundary conditions in CAE/FEM applications.
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
Color | Returns or sets the color of the object. |
IsBlanked | Returns the blank status of this object. |
IsLocked | Returns a value that indicates whether this field is locked against edits. |
IsOccurrence | Returns whether this object is an occurrence or not. |
IsUserField | Returns a value that indicates whether this field is a user created/managed field. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Layer | Returns or sets the layer that the object is in. |
LineFont | Returns or sets the line font of the object. |
LineWidth | Returns or sets the line width of the object. |
Name | Returns the custom name of the object. |
NameLocation | Returns the location of the object’s name. |
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. |
Methods¶
Method | Description |
---|---|
Blank | Blanks the object. |
CopyAsTableToPart | Create a new table field from this field (regardless of type). |
CopyToPart | Copy the field to the target part. |
CreateAttributeIterator | Create an attribute iterator @return A new attribute iterator object |
CreateCopyInPart | Copy the field to the target part. |
CreateTableInPart | Create a new table field from this field (regardless of type). |
Delete | Delete this field; destroys the field and removes all references to it. |
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. |
GetDependentVariables | Returns the dependent variables for this NXOpen.Fields.Field @return dependent variables for this NXOpen.Fields.FieldVariable |
GetDescription | Returns the description of the field. |
GetFieldEvaluator | Returns a field evaluator which can be used to evaluate this field. |
GetIdLabel | Returns the ID/Label of the field. |
GetIndependentVariables | Returns the independent variables for this NXOpen.Fields.Field @return independent variables for this NXOpen.Fields.FieldVariable |
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. |
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. |
GetSpatialMap | Returns the spatial map for the formula field if one exists. |
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 @return |
Highlight | Highlights the object. |
Prints a representation of this object to the system log file. | |
RedisplayObject | Redisplays the object in all views. |
RemoveViewDependency | Remove dependency on all views from an object. |
Rename | Update the name of the field. |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetDescription | Update the description of the field. |
SetIdLabel | Update the ID/Label of the field. |
SetName | Sets the custom name of the object. |
SetNameLocation | Sets the location of the object’s name. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetSpatialMap | Set the spatial map for the formula field. |
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. |
Unblank | Unblanks the object. |
Unhighlight | Unhighlights the object. |
XYGraph | Creates displayed graphs of the Field’s specified independent variable versus all the Field’s dependent variables |
XYGraph3D | Plots or overlays graphs of the Field’s specified x-axis and z-axis independent variables versus the Field’s specified y-axis dependent variable ; returns newly created plot object. |
XYGraphArgand | Plots the Field’s specified independent variable versus all the Field’s scaled dependent variables as an Argand graph; returns newly created plot object(s). |
Property Detail¶
IsLocked¶
-
Field.
IsLocked
¶ Returns a value that indicates whether this field is locked against edits.
-------------------------------------
Getter Method
Signature
IsLocked()
Returns: True if this is locked against edits. Return type: bool New in version NX7.5.2.
License requirements: None.
IsOccurrence¶
-
Field.
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.
IsUserField¶
-
Field.
IsUserField
¶ Returns a value that indicates whether this field is a user created/managed field.
Many fields are created automatically by the system for internal uses. The life of these fields is managed by the objects that own them and so these fields are not consider user fields.
-------------------------------------
Getter Method
Signature
IsUserField()
Returns: True if this is a user created/managed field Return type: bool New in version NX7.5.2.
License requirements: None.
JournalIdentifier¶
-
Field.
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.
Name¶
-
Field.
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.
OwningComponent¶
-
Field.
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¶
-
Field.
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¶
-
Field.
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.
Method Detail¶
CopyAsTableToPart¶
-
Field.
CopyAsTableToPart
¶ Create a new table field from this field (regardless of type).
Note * that the table will be created have the N number of rows, where * N is the product of the number of points for each independent variable, * resulting in a grid (or lattice). The resulting field will be in the * same part.
Signature
CopyAsTableToPart(targetPart)
Parameters: targetPart ( NXOpen.BasePart
) – target partNew in version NX6.0.0.
Deprecated since version NX6.0.1: Use
NXOpen.Fields.Field.CreateTableInPart()
instead.License requirements: None.
CopyToPart¶
-
Field.
CopyToPart
¶ Copy the field to the target part.
Signature
CopyToPart(targetPart)
Parameters: targetPart ( NXOpen.BasePart
) – target partNew in version NX6.0.0.
Deprecated since version NX6.0.1: Use
NXOpen.Fields.Field.CreateCopyInPart()
instead.License requirements: None.
CreateCopyInPart¶
-
Field.
CreateCopyInPart
¶ Copy the field to the target part.
Signature
CreateCopyInPart(targetPart)
Parameters: targetPart ( NXOpen.BasePart
) – target partReturns: newly created field Return type: NXOpen.Fields.Field
New in version NX6.0.1.
License requirements: None.
CreateTableInPart¶
-
Field.
CreateTableInPart
¶ Create a new table field from this field (regardless of type).
Note * that the table will be created have the N number of rows, where * N is the product of the number of points for each independent variable, * resulting in a grid (or lattice). The resulting field will be in the * same part.
Signature
CreateTableInPart(targetPart)
Parameters: targetPart ( NXOpen.BasePart
) – target partReturns: newly created table Return type: NXOpen.Fields.FieldTable
New in version NX6.0.1.
License requirements: None.
Delete¶
-
Field.
Delete
¶ Delete this field; destroys the field and removes all references to it.
Signature
Delete()
New in version NX6.0.0.
License requirements: None.
FindObject¶
-
Field.
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.
GetDependentVariables¶
-
Field.
GetDependentVariables
¶ Returns the dependent variables for this
NXOpen.Fields.Field
Signature
GetDependentVariables()
Returns: dependent variables for this NXOpen.Fields.FieldVariable
Return type: list of NXOpen.Fields.FieldVariable
New in version NX7.5.2.
License requirements: None.
GetDescription¶
-
Field.
GetDescription
¶ Returns the description of the field.
Signature
GetDescription()
Returns: description Return type: list of str New in version NX7.5.2.
License requirements: None.
GetFieldEvaluator¶
-
Field.
GetFieldEvaluator
¶ Returns a field evaluator which can be used to evaluate this field.
Signature
GetFieldEvaluator()
Returns: Field Evaluator Return type: NXOpen.Fields.FieldEvaluator
New in version NX7.5.2.
License requirements: None.
GetIdLabel¶
-
Field.
GetIdLabel
¶ Returns the ID/Label of the field.
Signature
GetIdLabel()
Returns: ID/Label Return type: int New in version NX9.0.0.
License requirements: None.
GetIndependentVariables¶
-
Field.
GetIndependentVariables
¶ Returns the independent variables for this
NXOpen.Fields.Field
Signature
GetIndependentVariables()
Returns: independent variables for this NXOpen.Fields.FieldVariable
Return type: list of NXOpen.Fields.FieldVariable
New in version NX7.5.2.
License requirements: None.
GetSpatialMap¶
-
Field.
GetSpatialMap
¶ Returns the spatial map for the formula field if one exists.
Signature
GetSpatialMap()
Returns: spatial map Return type: NXOpen.Fields.SpatialMap
New in version NX7.5.2.
License requirements: None.
Print¶
-
Field.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
Rename¶
-
Field.
Rename
¶ Update the name of the field.
Signature
Rename(newName)
Parameters: newName (str) – new field name New in version NX6.0.0.
License requirements: None.
SetDescription¶
-
Field.
SetDescription
¶ Update the description of the field.
Signature
SetDescription(lines)
Parameters: lines (list of str) – new description New in version NX6.0.1.
License requirements: None.
SetIdLabel¶
-
Field.
SetIdLabel
¶ Update the ID/Label of the field.
Signature
SetIdLabel(idLabel)
Parameters: idLabel (int) – ID/Label New in version NX9.0.0.
License requirements: None.
SetName¶
-
Field.
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.
SetSpatialMap¶
-
Field.
SetSpatialMap
¶ Set the spatial map for the formula field.
Signature
SetSpatialMap(overrideMap)
Parameters: overrideMap ( NXOpen.Fields.SpatialMap
) – spatial map to setNew in version NX6.0.0.
License requirements: None.
XYGraph¶
-
Field.
XYGraph
¶ Overloaded method XYGraph
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray)
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, viewIndex, overlay)
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, windowDevice, viewIndex, overlay)
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, windowDevice, viewIndex, overlay)
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, windowDevice, viewIndex, overlay, scaleFactor)
-------------------------------------
Creates displayed graphs of the Field’s specified independent variable versus all the Field’s dependent variables
Signature
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray)
Parameters: - indepVar (
NXOpen.Fields.FieldVariable
) – the specified independent variable for which to create the graph - abscissaMinimum (float) – the minimum bounds along the abscissa
- abscissaMaximum (float) – the maximum bounds along the abscissa
- abscissaPointCount (int) – the number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
- constantIndepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to hold constant If the field has only 1 independent variable, this parameter is NULL - constantIndepVarValueArray (list of float) – independent variables constant values If the field has only 1 independent variable, this parameter is NULL
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Plots or overlays graphs of the Field’s specified independent variable versus all the Field’s dependent variables
Signature
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, viewIndex, overlay)
Parameters: - indepVar (
NXOpen.Fields.FieldVariable
) – the specified independent variable for which to create the graph - abscissaMinimum (float) – the minimum bounds along the abscissa
- abscissaMaximum (float) – the maximum bounds along the abscissa
- abscissaPointCount (int) – the number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
- constantIndepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to hold constant If the field has only 1 independent variable, this parameter is NULL - constantIndepVarValueArray (list of float) – independent variables constant values If the field has only 1 independent variable, this parameter is NULL
- viewIndex (int) – 0 thru 8, viewport number to place the graph in
- overlay (bool) – create a new plot or add to existing
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Plots or overlays graphs of the Field’s specified independent variable versus all the Field’s dependent variables
Signature
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, windowDevice, viewIndex, overlay)
Parameters: - indepVar (
NXOpen.Fields.FieldVariable
) – the specified independent variable for which to create the graph - abscissaMinimum (float) – the minimum bounds along the abscissa
- abscissaMaximum (float) – the maximum bounds along the abscissa
- abscissaPointCount (int) – the number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
- constantIndepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to hold constant If the field has only 1 independent variable, this parameter is NULL - constantIndepVarValueArray (list of float) – independent variables constant values If the field has only 1 independent variable, this parameter is NULL
- windowDevice (int) – great than 0. the index of display device to show the graph. 1 represents main graphic window
- viewIndex (int) – 0 thru 8, viewport number to place the graph in
- overlay (bool) – create a new plot or add to existing
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Plots or overlays graphs of the Field’s specified independent variable versus all the Field’s dependent variables; returns newly created plot object(s).
Signature
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, windowDevice, viewIndex, overlay)
Parameters: - indepVar (
NXOpen.Fields.FieldVariable
) – the specified independent variable for which to create the graph - abscissaMinimum (float) – the minimum bounds along the abscissa
- abscissaMaximum (float) – the maximum bounds along the abscissa
- abscissaPointCount (int) – the number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
- constantIndepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to hold constant If the field has only 1 independent variable, this parameter is NULL - constantIndepVarValueArray (list of float) – independent variables constant values If the field has only 1 independent variable, this parameter is NULL
- windowDevice (int) – great than 0. the index of display device to show the graph. 1 represents main graphic window
- viewIndex (int) – 0 thru 8, viewport number to place the graph in
- overlay (bool) – create a new plot or add to existing
Returns: Created plot(s)
Return type: list of
NXOpen.CAE.Xyplot.Plot
New in version NX9.0.1.
License requirements: None.
-------------------------------------
Plots or overlays graphs of the Field’s specified independent variable versus all the Field’s scaled dependent variables; returns newly created plot object(s).
Signature
XYGraph(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, windowDevice, viewIndex, overlay, scaleFactor)
Parameters: - indepVar (
NXOpen.Fields.FieldVariable
) – the specified independent variable for which to create the graph - abscissaMinimum (float) – the minimum bounds along the abscissa
- abscissaMaximum (float) – the maximum bounds along the abscissa
- abscissaPointCount (int) – the number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
- constantIndepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to hold constant If the field has only 1 independent variable, this parameter is NULL - constantIndepVarValueArray (list of float) – independent variables constant values If the field has only 1 independent variable, this parameter is NULL
- windowDevice (int) – great than 0. the index of display device to show the graph. 1 represents main graphic window
- viewIndex (int) – 0 thru 8, viewport number to place the graph in
- overlay (bool) – create a new plot or add to existing
- scaleFactor (float) – scale dependent variable(s)
Returns: Created plot(s)
Return type: list of
NXOpen.CAE.Xyplot.Plot
New in version NX10.0.0.
License requirements: None.
-------------------------------------
XYGraph3D¶
-
Field.
XYGraph3D
¶ Plots or overlays graphs of the Field’s specified x-axis and z-axis independent variables versus the Field’s specified y-axis dependent variable ; returns newly created plot object.
Signature
XYGraph3D(xAxisIndepVar, xAxisBndsMinimum, xAxisBndsMaximum, xAxisBndsSampleSize, zAxisIndepVar, zAxisBndsMinimum, zAxisBndsMaximum, zAxisBndsSampleSize, yAxisDepVar, constantIndepVarArray, constantIndepVarValueArray, interpolateTableData, windowDevice, viewIndex, overlay, scaleFactor)
Parameters: - xAxisIndepVar (
NXOpen.Fields.FieldVariable
) – the specified x-axis independent variable for which to create the graph - xAxisBndsMinimum (float) – the minimum bounds along the x-axis
- xAxisBndsMaximum (float) – the maximum bounds along the x-axis
- xAxisBndsSampleSize (int) – the sample size to graph along the x-axis. the number of times to evaluate the x-axis independent variable
- zAxisIndepVar (
NXOpen.Fields.FieldVariable
) – the specified z-Axis independent variable for which to create the graph - zAxisBndsMinimum (float) – the minimum bounds along the z-Axis
- zAxisBndsMaximum (float) – the maximum bounds along the z-Axis
- zAxisBndsSampleSize (int) – the sample size to graph along the z-Axis. the number of times to evaluate the z-Axis independent variable
- yAxisDepVar (
NXOpen.Fields.FieldVariable
) – the specified y-Axis dependent variable for which to create the graph - constantIndepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to hold constant If the field has only 2 independent variables, this parameter is NULL - constantIndepVarValueArray (list of float) – independent variables constant values If the field has only 2 independent variables, this parameter is NULL
- interpolateTableData (bool) – a true value means that the table field data will be interpolated if there are more than 2 independent variables. a false value means that the data is plotted directly from the table and the constant values will be ignored. this value is only used for table fields with over 2 independent variables.
- windowDevice (int) – greater than 0. the index of display device to show the graph. 1 represents main graphic window
- viewIndex (int) – 0 thru 8, viewport number to place the graph in
- overlay (bool) – create a new plot or add to existing
- scaleFactor (float) – scale dependent variable
Returns: Created plot(s)
Return type: New in version NX11.0.0.
License requirements: None.
- xAxisIndepVar (
XYGraphArgand¶
-
Field.
XYGraphArgand
¶ Plots the Field’s specified independent variable versus all the Field’s scaled dependent variables as an Argand graph; returns newly created plot object(s).
Signature
XYGraphArgand(indepVar, abscissaMinimum, abscissaMaximum, abscissaPointCount, constantIndepVarArray, constantIndepVarValueArray, windowDevice, viewIndex)
Parameters: - indepVar (
NXOpen.Fields.FieldVariable
) – the specified independent variable for which to create the graph - abscissaMinimum (float) – the minimum bounds along the abscissa
- abscissaMaximum (float) – the maximum bounds along the abscissa
- abscissaPointCount (int) – the number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
- constantIndepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to hold constant If the field has only 1 independent variable, this parameter is NULL - constantIndepVarValueArray (list of float) – independent variables constant values If the field has only 1 independent variable, this parameter is NULL
- windowDevice (int) – great than 0. the index of display device to show the graph. 1 represents main graphic window
- viewIndex (int) – 0 thru 8, viewport number to place the graph in
Returns: Created plot(s)
Return type: list of
NXOpen.CAE.Xyplot.Plot
New in version NX11.0.0.
License requirements: None.
- indepVar (