FieldTable Class¶
-
class
NXOpen.Fields.
FieldTable
¶ Bases:
NXOpen.Fields.Field
Represents the Field Table class.
A field (see
NXOpen.Fields.Field
) defined in terms of tabular data involving one or more look-up independent columns and one or more dependent variables (seeNXOpen.Fields.FieldVariable
) which depend on the look-up columns.To obtain a instance of this class use
NXOpen.Fields.FieldManager
.New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AnnTolerance | Returns or sets the approximate nearest neighbor (ANN) interpolation tolerance |
Color | Returns or sets the color of the object. |
Discontinuities | Returns a flag specifying if the table has discontinuites |
IndependentValueDivisor | Returns or sets the linear interpolation divisor for field independent value, the zero value represents no divisor used |
IndependentValueDivisorOption | Returns or sets a value indicating whether to set the linear interpolation divisor for field independent value |
IndependentValueShift | Returns or sets the linear interpolation shift for field independent value |
IndependentValueShiftOption | Returns or sets a value indicating whether to set the linear interpolation shift for field independent value |
InterpolationMethod | Returns or sets the interpolation method used when this table data is evaluated. |
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. |
LatticeDataOption | Returns or sets the lattice data option check used when this table data is in lattice format. |
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. |
LinearLogOption | Returns or sets the linear/log option used when this table data is evaluated using the linear 1d interpolator. |
Name | Returns the custom name of the object. |
NameLocation | Returns the location of the object’s name. |
NumLatticeDataColumn | Returns or sets the number of lattice data column option check used when this table data is in lattice format. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
PersistentInterpolator | Returns or sets a flag specifying if interpolator is persistent between session |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
ValuesOutsideTableInterpolation | Returns or sets the outside table values interpolation method for standard linear interpolation |
Methods¶
Method | Description |
---|---|
AddApplicationData | Adds the specified application data object to the field NOTE: Only one application data object per IApplication can be added and the data must be owned by an IApplication with the same Part::Field::Main as the field. |
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 |
CreateCopyInPart | Copy the field to the target part. |
CreateDrawHelper | Creates a field drawhelper which can be used to get display attributes of this field. |
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 |
EditFieldTable | Edit the table field. |
EditFieldTableComplexDisplay | Edit the table field complex display. |
EditFieldTableComplexUnits | Edit the table field complex units array. |
EditTableVariables | Edit the table field dependent variables. |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetApplicationData | Retrieves the application data associated with the field for the specified application. |
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. |
GetData | Returns the values for the given NXOpen.Fields.FieldVariable in this NXOpen.Fields.FieldTable . |
GetDependentVariables | Returns the dependent variables for this NXOpen.Fields.Field |
GetDescription | Returns the description of the field. |
GetFieldDrawhelper | Returns a field drawhelper which can be used to get display attributes of this field. |
GetFieldEvaluator | Returns a field evaluator which can be used to evaluate this field. |
GetIdLabel | Returns the ID/Label of the field. |
GetIdwOptions | Get the inverse distance weighting (IDW) interpolation options |
GetIndependentVariables | Returns the independent variables for this NXOpen.Fields.Field |
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. |
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 |
Highlight | Highlights the object. |
LoadFromFile | Populate the table from a file replacing or appending data |
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. |
SetIdwOptions | Set the inverse distance weighting (IDW) interpolation options |
SetInterpolation | Specified interpolation method, this method was deprecated in NX7. |
SetName | Sets the custom name of the object. |
SetNameLocation | Sets the location of the object’s name. |
SetPartContext | Set part context. |
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
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). |
Enumerations¶
FieldTableInterpolationEnum Enumeration | Interpolation type This enumeration has been deprecated use NXOpen.Fields.FieldEvaluatorInterpolationEnum instead. |
FieldTableLoadFileOption Enumeration | Load file options |
Property Detail¶
AnnTolerance¶
-
FieldTable.
AnnTolerance
¶ Returns or sets the approximate nearest neighbor (ANN) interpolation tolerance
-------------------------------------
Getter Method
Signature
AnnTolerance
Returns: approximate nearest neighbor (ANN) interpolation tolerance Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnnTolerance
Parameters: annTolerance (float) – approximate nearest neighbor (ANN) interpolation tolerance New in version NX8.5.0.
License requirements: None.
Discontinuities¶
-
FieldTable.
Discontinuities
¶ Returns a flag specifying if the table has discontinuites
-------------------------------------
Getter Method
Signature
Discontinuities
Returns: a flag specifying if the table has discontinuites Return type: bool New in version NX9.0.0.
License requirements: None.
IndependentValueDivisor¶
-
FieldTable.
IndependentValueDivisor
¶ Returns or sets the linear interpolation divisor for field independent value, the zero value represents no divisor used
-------------------------------------
Getter Method
Signature
IndependentValueDivisor
Returns: the interpolation divisor for independent value Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IndependentValueDivisor
Parameters: divisor (float) – the interpolation divisor for independent value New in version NX9.0.0.
License requirements: None.
IndependentValueDivisorOption¶
-
FieldTable.
IndependentValueDivisorOption
¶ Returns or sets a value indicating whether to set the linear interpolation divisor for field independent value
-------------------------------------
Getter Method
Signature
IndependentValueDivisorOption
Returns: the interpolation divisor flag for independent value Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IndependentValueDivisorOption
Parameters: divisorOption (bool) – the interpolation divisor flag for independent value New in version NX9.0.0.
License requirements: None.
IndependentValueShift¶
-
FieldTable.
IndependentValueShift
¶ Returns or sets the linear interpolation shift for field independent value
-------------------------------------
Getter Method
Signature
IndependentValueShift
Returns: the interpolation shift for independent value Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IndependentValueShift
Parameters: shift (float) – the interpolation shift for independent value New in version NX9.0.0.
License requirements: None.
IndependentValueShiftOption¶
-
FieldTable.
IndependentValueShiftOption
¶ Returns or sets a value indicating whether to set the linear interpolation shift for field independent value
-------------------------------------
Getter Method
Signature
IndependentValueShiftOption
Returns: the interpolation shift flag for independent value Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IndependentValueShiftOption
Parameters: shiftOption (bool) – the interpolation shift flag for independent value New in version NX9.0.0.
License requirements: None.
InterpolationMethod¶
-
FieldTable.
InterpolationMethod
¶ Returns or sets the interpolation method used when this table data is evaluated.
-------------------------------------
Getter Method
Signature
InterpolationMethod
Returns: the interpolation method Return type: NXOpen.Fields.FieldEvaluatorInterpolationEnum
New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
InterpolationMethod
Parameters: interpolationMethod ( NXOpen.Fields.FieldEvaluatorInterpolationEnum
) – the interpolation methodNew in version NX7.5.2.
License requirements: None.
IsOccurrence¶
-
FieldTable.
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¶
-
FieldTable.
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.
LatticeDataOption¶
-
FieldTable.
LatticeDataOption
¶ Returns or sets the lattice data option check used when this table data is in lattice format.
-------------------------------------
Getter Method
Signature
LatticeDataOption
Returns: the lattice data check option Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LatticeDataOption
Parameters: latticeDataOption (bool) – the lattice data check option New in version NX12.0.0.
License requirements: None.
LinearLogOption¶
-
FieldTable.
LinearLogOption
¶ Returns or sets the linear/log option used when this table data is evaluated using the linear 1d interpolator.
-------------------------------------
Getter Method
Signature
LinearLogOption
Returns: the log option Return type: NXOpen.Fields.FieldEvaluatorLinearLogOptionEnum
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LinearLogOption
Parameters: linearOption ( NXOpen.Fields.FieldEvaluatorLinearLogOptionEnum
) – the log optionNew in version NX9.0.0.
License requirements: None.
Name¶
-
FieldTable.
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.
NumLatticeDataColumn¶
-
FieldTable.
NumLatticeDataColumn
¶ Returns or sets the number of lattice data column option check used when this table data is in lattice format.
-------------------------------------
Getter Method
Signature
NumLatticeDataColumn
Returns: the lattice data column number Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumLatticeDataColumn
Parameters: numLatticeDataColumn (int) – the lattice data column number New in version NX12.0.0.
License requirements: None.
OwningComponent¶
-
FieldTable.
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¶
-
FieldTable.
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.
PersistentInterpolator¶
-
FieldTable.
PersistentInterpolator
¶ Returns or sets a flag specifying if interpolator is persistent between session
-------------------------------------
Getter Method
Signature
PersistentInterpolator
Returns: persistent interpolator indicator Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PersistentInterpolator
Parameters: persistentInterpolator (bool) – persistent interpolator indicator New in version NX8.5.0.
License requirements: None.
Prototype¶
-
FieldTable.
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.
ValuesOutsideTableInterpolation¶
-
FieldTable.
ValuesOutsideTableInterpolation
¶ Returns or sets the outside table values interpolation method for standard linear interpolation
-------------------------------------
Getter Method
Signature
ValuesOutsideTableInterpolation
Returns: the outside table values interpolation method Return type: NXOpen.Fields.FieldEvaluatorValuesOutsideTableInterpolationEnum
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ValuesOutsideTableInterpolation
Parameters: interpolationMethod ( NXOpen.Fields.FieldEvaluatorValuesOutsideTableInterpolationEnum
) – the outside table values interpolation methodNew in version NX9.0.0.
License requirements: None.
Method Detail¶
EditFieldTable¶
-
FieldTable.
EditFieldTable
¶ Edit the table field.
Specifies the new array of :py:class:`NXOpen.Fields.FieldVariable`s for independent and dependent variables, as well as the new double values.
Signature
EditFieldTable(indepVarArray, depVarArray, datapoints)
Parameters: - indepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to be associated with the field - depVarArray (list of
NXOpen.Fields.FieldVariable
) – dependent expression fields to be associated with the formula field - datapoints (list of float) – row based array of double values representing the table; then number of points should equal the number of independent variables * the number of dependent variables * the number of rows.
New in version NX6.0.0.
License requirements: None.
- indepVarArray (list of
EditFieldTableComplexDisplay¶
-
FieldTable.
EditFieldTableComplexDisplay
¶ Edit the table field complex display.
Specifies the new array of complex display flags for independent and dependent variables.
Signature
EditFieldTableComplexDisplay(indepVarArrayComplexDisplay, depVarArrayComplexDisplay)
Parameters: - indepVarArrayComplexDisplay (list of bool) – independent variable complex display flags to be associated with the field
- depVarArrayComplexDisplay (list of bool) – dependent variable complex display flags to be associated with the field
New in version NX10.0.0.
License requirements: None.
EditFieldTableComplexUnits¶
-
FieldTable.
EditFieldTableComplexUnits
¶ Edit the table field complex units array.
Specifies the new array of complex phase unit tags for dependent variables. A NULL unit in a given index indicates that the corresponding variable is not complex, or if it is complex, that the value is Real/Imaginary, in which both components have the same unit as the variable itself. In the case where the unit is specified, the complex dep variables in magnitude/phase representation. In that case the measure of the specified unit must be angle.
Signature
EditFieldTableComplexUnits(depVarArrayComplexUnits)
Parameters: depVarArrayComplexUnits (list of NXOpen.Unit
) –New in version NX11.0.0.
License requirements: None.
EditTableVariables¶
-
FieldTable.
EditTableVariables
¶ Edit the table field dependent variables.
Specifies the new dependent
NXOpen.Fields.FieldVariable
array. If retain number of rows is specified, the total number of rows will remain the same. Columns with zeros will be added as necessary, or data will be truncated. This process will be handled for each set of variables, independent and dependent. Thus, if the number of independent columns increases and the dependent columns decrease, a column of zeros will be added for the new independent variable, and data will be dropped from the dependent values.Signature
EditTableVariables(indepVarArray, depExpArray)
Parameters: - indepVarArray (list of
NXOpen.Fields.FieldVariable
) – independent variables to be associated with the field - depExpArray (list of
NXOpen.Fields.FieldVariable
) – dependent field variables to be associated with the field
New in version NX12.0.0.
License requirements: None.
- indepVarArray (list of
FindObject¶
-
FieldTable.
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.
GetData¶
-
FieldTable.
GetData
¶ Returns the values for the given
NXOpen.Fields.FieldVariable
in thisNXOpen.Fields.FieldTable
.The input
NXOpen.Fields.FieldVariable
should be retrieved from the field usingNXOpen.Fields.Field.GetIndependentVariables()
orNXOpen.Fields.Field.GetDependentVariables()
. The values are in the sameNXOpen.Unit
as specified on theNXOpen.Fields.FieldVariable
.Signature
GetData(variable)
Parameters: variable ( NXOpen.Fields.FieldVariable
) – variable whose table values are to be returnedReturns: the row values for this variable Return type: list of float New in version NX7.5.4.
License requirements: None.
GetIdwOptions¶
-
FieldTable.
GetIdwOptions
¶ Get the inverse distance weighting (IDW) interpolation options
Signature
GetIdwOptions()
Returns: a tuple Return type: A tuple consisting of (nearestOption, nearestFraction). nearestOption is a NXOpen.Fields.FieldEvaluatorInverseDistanceWeightingEnum
. nearest option nearestFraction is a float. fractionNew in version NX8.5.0.
License requirements: None.
LoadFromFile¶
-
FieldTable.
LoadFromFile
¶ Populate the table from a file replacing or appending data
Signature
LoadFromFile(filename, loadFileOption)
Parameters: - filename (str) – file to read rows from
- loadFileOption (
NXOpen.Fields.FieldTableLoadFileOption
) – append or replace
New in version NX6.0.1.
License requirements: None.
Print¶
-
FieldTable.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetIdwOptions¶
-
FieldTable.
SetIdwOptions
¶ Set the inverse distance weighting (IDW) interpolation options
Signature
SetIdwOptions(nearestOption, nearestFraction)
Parameters: - nearestOption (
NXOpen.Fields.FieldEvaluatorInverseDistanceWeightingEnum
) – nearest option - nearestFraction (float) – fraction
New in version NX8.5.0.
License requirements: None.
- nearestOption (
SetInterpolation¶
-
FieldTable.
SetInterpolation
¶ Specified interpolation method, this method was deprecated in NX7.
5.2.
Signature
SetInterpolation(interpolationMethod)
Parameters: interpolationMethod (int) – specified interpolation method; NXOpen.Fields.FieldTable
interpolation enum values for builtin methods.New in version NX6.0.0.
Deprecated since version NX7.5.2: Use
NXOpen.Fields.FieldTable.InterpolationMethod`()
instead.License requirements: None.
SetName¶
-
FieldTable.
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.