FieldManager Class¶

class NXOpen.Fields.FieldManager¶

Bases: NXOpen.NXObject

Represents the manager class of the Fields

This manager class gives access to all the fields NXOpen.Fields.Field within a part, as well as the collection of domains NXOpen.Fields.FieldDomain.

It also provides creation methods for the various builders of fields and related classes.

New in version NX4.0.0.

Properties¶

Property	Description
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
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.
Domains	Returns a collection of Domains
Fields	Returns a collection of Fields

Methods¶

Method	Description
ConvertToLinksTable	Creates and returns a `NXOpen.Fields.FieldLinksTable` representation of this table.
CreateAttributeIterator	Create an attribute iterator
CreateComplexScalarFieldWrapperWithExpressions	Create a complex scalar field wrapper backed by two scalar expressions
CreateComplexScalarFieldWrapperWithField	Create a complex scalar field wrapper backed up by a complex scalar field
CreateComplexScalarFieldWrapperWithFieldWithScaleFactor	Create a complex scalar field wrapper backed up by a complex scalar field with scale factor
CreateComplexVectorFieldWrapperWithExpressions	Create a complex vector field wrapper backed by six scalar expressions
CreateComplexVectorFieldWrapperWithField	Create a complex vector field wrapper backed up by a complex vector field
CreateDependentVariable	Create a dependent variable to be added to the field
CreateDisplayPropertiesBuilder	Creates a `NXOpen.Fields.DisplayPropertiesBuilder`
CreateExportData	Creates a Fields.
CreateFieldExpression	Creates a system `NXOpen.Fields.FieldExpression` object.
CreateFieldFormula	Creates a `NXOpen.Fields.FieldFormula` object with dependent `NXOpen.Fields.FieldExpression`.
CreateFieldLink	Creates a `NXOpen.Fields.FieldLink`.
CreateFieldLinksTable	Creates a `NXOpen.Fields.FieldLinksTable` object with dependent and independent variables `NXOpen.Fields.FieldVariable`.
CreateFieldTable	Creates a `NXOpen.Fields.FieldTable` object with dependent and independent variables `NXOpen.Fields.FieldVariable`.
CreateFieldTableFromData	Creates a `NXOpen.Fields.FieldTable` object with dependent and independent variables `NXOpen.Fields.FieldVariable`.
CreateFieldWrapper	Create a field wrapper backed up by a field
CreateImportData	Creates a Fields.
CreateIndependentVariable	Create an independent variable to be added to the field
CreateMeshSizeFieldData	Create Mesh Size Field `NXOpen.Fields.Field` object
CreatePathObjects	Creates a `NXOpen.Fields.PathObjects`
CreateScalarFieldWrapperWithExpression	Create a field wrapper backed by a scalar expression
CreateScalarFieldWrapperWithField	Create a scalar field wrapper backed up by a scaled scalar field
CreateSpatialMapBuilder	Creates a `NXOpen.Fields.SpatialMapBuilder`
CreateSubFieldExpression	Creates a system `NXOpen.Fields.FieldExpression` object with independent variables.
CreateVectorFieldWrapperWithExpressions	Create a vector field wrapper backed by three scalar expressions
CreateVectorFieldWrapperWithField	Create a vector field wrapper backed up by a scaled vector field
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteField	Deletes the specified `NXOpen.Fields.Field` object; if the object cannot be deleted it is returned.
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
EditDependentVariable	Edit dependent variable
EditIndependentVariable	Edit an independent variable
ExportFields	Exports fields to a text file as defined by export_data parameter
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.
GetNameVariable	Locate an existing, or create a new `NXOpen.Fields.NameVariable` object
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.
GetValidFieldId	Get the next available ID for `NXOpen.Fields.Field` object
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
ImportFields	Imports fields from a text file as defined by import_data parameter
Print	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.

Property Detail¶

IsOccurrence¶

FieldManager.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¶

FieldManager.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¶

FieldManager.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¶

FieldManager.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¶

FieldManager.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¶

FieldManager.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.

Domains¶

FieldManager.Domains¶

Returns a collection of Domains

Signature Domains

New in version NX3.0.0.

Returns:
Return type:	`NXOpen.Fields.FieldDomainCollection`

Fields¶

FieldManager.Fields¶

Returns a collection of Fields

Signature Fields

New in version NX11.0.0.

Returns:
Return type:	`NXOpen.Fields.FieldCollection`

Method Detail¶

ConvertToLinksTable¶

FieldManager.ConvertToLinksTable¶

Creates and returns a NXOpen.Fields.FieldLinksTable representation of this table.

Deletes the input table and updates all references to point to the links table.

Signature ConvertToLinksTable(table)

Parameters:	table (`NXOpen.Fields.FieldTable`) – Table to be converted
Returns:	table of fields
Return type:	`NXOpen.Fields.FieldLinksTable`

New in version NX12.0.0.

License requirements: None.

CreateComplexScalarFieldWrapperWithExpressions¶

FieldManager.CreateComplexScalarFieldWrapperWithExpressions¶

Create a complex scalar field wrapper backed by two scalar expressions

Signature CreateComplexScalarFieldWrapperWithExpressions(expressions)

Parameters:	expressions (list of `NXOpen.Expression`) – existing expressions that will be this wrapper’s value
Returns:	scalar field wrapper created and associated to the expression
Return type:	`NXOpen.Fields.ComplexScalarFieldWrapper`

New in version NX11.0.0.

License requirements: None.

CreateComplexScalarFieldWrapperWithField¶

FieldManager.CreateComplexScalarFieldWrapperWithField¶

Create a complex scalar field wrapper backed up by a complex scalar field

Signature CreateComplexScalarFieldWrapperWithField(field)

Parameters:	field (`NXOpen.Fields.Field`) – an existing field that will be this wrapper’s value
Returns:	vector field wrapper created and associated to the field
Return type:	`NXOpen.Fields.ComplexScalarFieldWrapper`

New in version NX11.0.0.

License requirements: None.

CreateComplexScalarFieldWrapperWithFieldWithScaleFactor¶

FieldManager.CreateComplexScalarFieldWrapperWithFieldWithScaleFactor¶

Create a complex scalar field wrapper backed up by a complex scalar field with scale factor

Signature CreateComplexScalarFieldWrapperWithFieldWithScaleFactor(field, scaleFactor)

Parameters:	field (`NXOpen.Fields.Field`) – an existing field that will be this wrapper’s value scaleFactor (float) – the field will be multiplied by this scale factor when being evaluated
Returns:	scalar field wrapper created and associated to the field
Return type:	`NXOpen.Fields.ComplexScalarFieldWrapper`

New in version NX12.0.0.

License requirements: None.

CreateComplexVectorFieldWrapperWithExpressions¶

FieldManager.CreateComplexVectorFieldWrapperWithExpressions¶

Create a complex vector field wrapper backed by six scalar expressions

Signature CreateComplexVectorFieldWrapperWithExpressions(expressions)

Parameters:	expressions (list of `NXOpen.Expression`) – existing expressions that will be this wrapper’s value
Returns:	scalar field wrapper created and associated to the expression
Return type:	`NXOpen.Fields.ComplexVectorFieldWrapper`

New in version NX12.0.0.

License requirements: None.

CreateComplexVectorFieldWrapperWithField¶

FieldManager.CreateComplexVectorFieldWrapperWithField¶

Create a complex vector field wrapper backed up by a complex vector field

Signature CreateComplexVectorFieldWrapperWithField(field, scaleFactor)

Parameters:	field (`NXOpen.Fields.Field`) – an existing field that will be this wrapper’s value scaleFactor (float) – the field will be multiplied by this scale factor when being evaluated
Returns:	vector field wrapper created and associated to the field
Return type:	`NXOpen.Fields.ComplexVectorFieldWrapper`

New in version NX12.0.0.

License requirements: None.

CreateDependentVariable¶

FieldManager.CreateDependentVariable¶

Overloaded method CreateDependentVariable

CreateDependentVariable(ownerField, nameVariable, unitType)
CreateDependentVariable(ownerField, nameVariable, unitType, type)

-------------------------------------

Create a dependent variable to be added to the field

Signature CreateDependentVariable(ownerField, nameVariable, unitType)

Parameters:	ownerField (`NXOpen.Fields.Field`) – owner field nameVariable (`NXOpen.Fields.NameVariable`) – existing name variable unitType (`NXOpen.Unit`) – unit of the dependent variable
Returns:	dependent variable created and associated to the field
Return type:	`NXOpen.Fields.FieldVariable`

New in version NX6.0.2.

License requirements: None.

-------------------------------------

Create a dependent variable to be added to the field, specifying the variable value type

Signature CreateDependentVariable(ownerField, nameVariable, unitType, type)

Parameters:	ownerField (`NXOpen.Fields.Field`) – owner field nameVariable (`NXOpen.Fields.NameVariable`) – existing name variable unitType (`NXOpen.Unit`) – unit of the dependent variable type (`NXOpen.Fields.FieldVariableValueType`) – variable value type
Returns:	dependent variable created and associated to the field
Return type:	`NXOpen.Fields.FieldVariable`

New in version NX11.0.0.

License requirements: None.

-------------------------------------

CreateDisplayPropertiesBuilder¶

FieldManager.CreateDisplayPropertiesBuilder¶

Creates a NXOpen.Fields.DisplayPropertiesBuilder

Signature CreateDisplayPropertiesBuilder(fieldArray)

Parameters:	fieldArray (list of `NXOpen.Fields.Field`) – fields to edit display properties
Returns:
Return type:	`NXOpen.Fields.DisplayPropertiesBuilder`

New in version NX6.0.1.

License requirements: None.

CreateExportData¶

FieldManager.CreateExportData¶

Creates a Fields.

ExportData

Signature CreateExportData()

Returns:	the export data created
Return type:	`NXOpen.Fields.ExportData`

New in version NX6.0.0.

License requirements: None.

CreateFieldExpression¶

FieldManager.CreateFieldExpression¶

Overloaded method CreateFieldExpression

CreateFieldExpression(fieldExpString, unitType)
CreateFieldExpression(fieldExpString, unitType, indepVarArray)

-------------------------------------

Creates a system NXOpen.Fields.FieldExpression object. Specifies the new expression string.

Signature CreateFieldExpression(fieldExpString, unitType)

Parameters:	fieldExpString (str) – expression string to be associated with the field unitType (`NXOpen.Unit`) – unit of the field
Returns:	field
Return type:	`NXOpen.Fields.FieldExpression`

New in version NX4.0.0.

License requirements: None.

-------------------------------------

Creates a system NXOpen.Fields.FieldExpression object with independent variables. Specifies the new expression string.

This method is deprecated; field expressions are children of NXOpen.Fields.FieldFormula and should not be created independently.

Signature CreateFieldExpression(fieldExpString, unitType, indepVarArray)

Parameters:	fieldExpString (str) – expression string to be associated with the field unitType (`NXOpen.Unit`) – unit of the field indepVarArray (list of `NXOpen.Fields.FieldVariable`) – independent variables to be associated with the field
Returns:	field
Return type:	`NXOpen.Fields.FieldExpression`

New in version NX4.0.0.

Deprecated since version NX10.0.0: Field expressions are owned by other objects. They are managed by the creation and editing of the owning object and should not be created independently.

License requirements: None.

-------------------------------------

CreateFieldFormula¶

FieldManager.CreateFieldFormula¶

Creates a NXOpen.Fields.FieldFormula object with dependent NXOpen.Fields.FieldExpression.

Signature CreateFieldFormula(fieldName, indepVarArray, depExpArray)

Parameters:	fieldName (str) – field name indepVarArray (list of `NXOpen.Fields.FieldVariable`) – independent variables to be associated with the field depExpArray (list of `NXOpen.Fields.FieldExpression`) – dependent expression fields to be associated with the formula field
Returns:	field
Return type:	`NXOpen.Fields.FieldFormula`

New in version NX6.0.0.

License requirements: None.

CreateFieldLink¶

FieldManager.CreateFieldLink¶

Creates a NXOpen.Fields.FieldLink.

Signature CreateFieldLink(fieldName, fieldToLink)

Parameters:	fieldName (str) – field name fieldToLink (`NXOpen.Fields.Field`) – field to link
Returns:	field
Return type:	`NXOpen.Fields.FieldLink`

New in version NX6.0.0.

License requirements: None.

CreateFieldLinksTable¶

FieldManager.CreateFieldLinksTable¶

Overloaded method CreateFieldLinksTable

CreateFieldLinksTable(fieldName, indepVarArray, depVarArray, datapoints, linkFieldsArray)
CreateFieldLinksTable(fieldName, indepVarArray, depVarArray, datapoints, linkFieldsArray, managedFieldsArray)

-------------------------------------

Creates a NXOpen.Fields.FieldLinksTable object with dependent and independent variables NXOpen.Fields.FieldVariable.

Signature CreateFieldLinksTable(fieldName, indepVarArray, depVarArray, datapoints, linkFieldsArray)

Parameters:	fieldName (str) – field name indepVarArray (list of `NXOpen.Fields.FieldVariable`) – independent variables to be associated with the field depVarArray (list of `NXOpen.Fields.FieldVariable`) – dependent variables of this and all linked fields datapoints (list of float) – row based array of double values representing the first independent variable; the number of points should equal the number of rows. linkFieldsArray (list of `NXOpen.Fields.Field`) – row based array of link field values representing the table; the number of fields should equal the number of rows.
Returns:	links table field
Return type:	`NXOpen.Fields.FieldLinksTable`

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Creates a NXOpen.Fields.FieldLinksTable object with dependent and independent variables NXOpen.Fields.FieldVariable.

Signature CreateFieldLinksTable(fieldName, indepVarArray, depVarArray, datapoints, linkFieldsArray, managedFieldsArray)

Parameters:	fieldName (str) – field name indepVarArray (list of `NXOpen.Fields.FieldVariable`) – independent variables to be associated with the field depVarArray (list of `NXOpen.Fields.FieldVariable`) – dependent variables of this and all linked fields datapoints (list of float) – row based array of double values representing the first independent variable; the number of points should equal the number of rows. linkFieldsArray (list of `NXOpen.Fields.Field`) – row based array of link field values representing the table; the number of fields should equal the number of rows. managedFieldsArray (list of bool) – row based array of logical values indicating the links table field should manage the specified fields .
Returns:	links table field
Return type:	`NXOpen.Fields.FieldLinksTable`

New in version NX12.0.0.

License requirements: None.

-------------------------------------

CreateFieldTable¶

FieldManager.CreateFieldTable¶

Creates a NXOpen.Fields.FieldTable object with dependent and independent variables NXOpen.Fields.FieldVariable.

Signature CreateFieldTable(fieldName, indepVarArray, depVarArray, datapoints)

Parameters:	fieldName (str) – field name indepVarArray (list of `NXOpen.Fields.FieldVariable`) – independent variables to be associated with the table field depVarArray (list of `NXOpen.Fields.FieldVariable`) – dependent variables to be associated with the table 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.
Returns:	field
Return type:	`NXOpen.Fields.FieldTable`

New in version NX6.0.0.

License requirements: None.

CreateFieldTableFromData¶

FieldManager.CreateFieldTableFromData¶

Creates a NXOpen.Fields.FieldTable object with dependent and independent variables NXOpen.Fields.FieldVariable.

This will create a 2 dimensional table, with the option to specify the value type for the dependent variable.

Signature CreateFieldTableFromData(fieldNamePrefix, ivarUnit, dvarUnit, dvarType, datapoints)

Parameters:	fieldNamePrefix (str) – field name prefix; e.g. “AFU Record”; field will have a unique generated name begining with this string ivarUnit (`NXOpen.Unit`) – unit of the independent variable dvarUnit (`NXOpen.Unit`) – unit of the dependent variable dvarType (`NXOpen.Fields.FieldVariableValueType`) – dependent variable type (real/imaginary/complex…) 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.
Returns:	field
Return type:	`NXOpen.Fields.FieldTable`

New in version NX7.5.2.

License requirements: None.

CreateFieldWrapper¶

FieldManager.CreateFieldWrapper¶

Create a field wrapper backed up by a field

Signature CreateFieldWrapper(field)

Parameters:	field (`NXOpen.Fields.Field`) – an existing field that will be this wrapper’s value
Returns:	scalar field wrapper created and associated to the field
Return type:	`NXOpen.Fields.FieldWrapper`

New in version NX6.0.0.

License requirements: None.

CreateImportData¶

FieldManager.CreateImportData¶

Creates a Fields.

ImportData

Signature CreateImportData()

Returns:	the import data created
Return type:	`NXOpen.Fields.ImportData`

New in version NX6.0.0.

License requirements: None.

CreateIndependentVariable¶

FieldManager.CreateIndependentVariable¶

Overloaded method CreateIndependentVariable

CreateIndependentVariable(ownerField, nameVariable, unitType, minValueSet, minValueInclusive, minValue, maxValueSet, maxValueInclusive, maxValue, numPtsSet, numPts, defaultValueSet, defaultValue)
CreateIndependentVariable(ownerField, nameVariable, unitType, type, minValueSet, minValueInclusive, minValue, maxValueSet, maxValueInclusive, maxValue, numPtsSet, numPts, defaultValueSet, defaultValue)

-------------------------------------

Create an independent variable to be added to the field

Signature CreateIndependentVariable(ownerField, nameVariable, unitType, minValueSet, minValueInclusive, minValue, maxValueSet, maxValueInclusive, maxValue, numPtsSet, numPts, defaultValueSet, defaultValue)

Parameters:	ownerField (`NXOpen.Fields.Field`) – owner field nameVariable (`NXOpen.Fields.NameVariable`) – existing name variable unitType (`NXOpen.Unit`) – unit of the independent variable minValueSet (bool) – logical value whether minimum value set minValueInclusive (bool) – minimum value is itself included in range minValue (float) – minimum value of the variable range maxValueSet (bool) – logical value whether maximum value set maxValueInclusive (bool) – maximum value is itself included in range maxValue (float) – maximum value of the variable range numPtsSet (bool) – logical value whether num_pts set numPts (int) – num_pts of the variable range defaultValueSet (bool) – logical value whether default value set defaultValue (float) – default value of the variable range
Returns:	independent variable created and associated to the field
Return type:	`NXOpen.Fields.FieldVariable`

New in version NX6.0.2.

License requirements: None.

-------------------------------------

Create an independent variable to be added to the field, specifying the variable value type

Signature CreateIndependentVariable(ownerField, nameVariable, unitType, type, minValueSet, minValueInclusive, minValue, maxValueSet, maxValueInclusive, maxValue, numPtsSet, numPts, defaultValueSet, defaultValue)

Parameters:	ownerField (`NXOpen.Fields.Field`) – owner field nameVariable (`NXOpen.Fields.NameVariable`) – existing name variable unitType (`NXOpen.Unit`) – unit of the independent variable type (`NXOpen.Fields.FieldVariableValueType`) – variable value type minValueSet (bool) – logical value whether minimum value set minValueInclusive (bool) – minimum value is itself included in range minValue (float) – minimum value of the variable range maxValueSet (bool) – logical value whether maximum value set maxValueInclusive (bool) – maximum value is itself included in range maxValue (float) – maximum value of the variable range numPtsSet (bool) – logical value whether num_pts set numPts (int) – num_pts of the variable range defaultValueSet (bool) – logical value whether default value set defaultValue (float) – default value of the variable range
Returns:	independent variable created and associated to the field
Return type:	`NXOpen.Fields.FieldVariable`

New in version NX11.0.0.

License requirements: None.

-------------------------------------

CreateMeshSizeFieldData¶

FieldManager.CreateMeshSizeFieldData¶

Create Mesh Size Field NXOpen.Fields.Field object

Signature CreateMeshSizeFieldData(elementSizeType, meshArray)

Parameters:	elementSizeType (int) – At Centroid of Element Free Face and Elements=0, At Centroid of Element Free Faces=1, At Centroid of Elements=2 meshArray (list of `NXOpen.TaggedObject`) –
Returns:	Created Field
Return type:	`NXOpen.Fields.Field`

New in version NX11.0.0.

License requirements: None.

CreatePathObjects¶

FieldManager.CreatePathObjects¶

Creates a NXOpen.Fields.PathObjects

Signature CreatePathObjects()

Returns:
Return type:	`NXOpen.Fields.PathObjects`

New in version NX6.0.1.

License requirements: None.

CreateScalarFieldWrapperWithExpression¶

FieldManager.CreateScalarFieldWrapperWithExpression¶

Create a field wrapper backed by a scalar expression

Signature CreateScalarFieldWrapperWithExpression(expression)

Parameters:	expression (`NXOpen.Expression`) – an existing expression that will be this wrapper’s value
Returns:	scalar field wrapper created and associated to the expression
Return type:	`NXOpen.Fields.ScalarFieldWrapper`

New in version NX6.0.0.

License requirements: None.

CreateScalarFieldWrapperWithField¶

FieldManager.CreateScalarFieldWrapperWithField¶

Create a scalar field wrapper backed up by a scaled scalar field

Signature CreateScalarFieldWrapperWithField(field, scaleFactor)

Parameters:	field (`NXOpen.Fields.Field`) – an existing field that will be this wrapper’s value scaleFactor (float) – the field will be multiplied by this scale factor when being evaluated
Returns:	scalar field wrapper created and associated to the field
Return type:	`NXOpen.Fields.ScalarFieldWrapper`

New in version NX6.0.0.

License requirements: None.

CreateSpatialMapBuilder¶

FieldManager.CreateSpatialMapBuilder¶

Creates a NXOpen.Fields.SpatialMapBuilder

Signature CreateSpatialMapBuilder(spatialmap)

Parameters:	spatialmap (`NXOpen.Fields.SpatialMap`) – Existing SpatialMap to edit; NULL to create
Returns:
Return type:	`NXOpen.Fields.SpatialMapBuilder`

New in version NX6.0.0.

License requirements: None.

CreateSubFieldExpression¶

FieldManager.CreateSubFieldExpression¶

Creates a system NXOpen.Fields.FieldExpression object with independent variables.

Specifies the new expression string.

This method is used to create sub expression fields for a NXOpen.Fields.FieldFormula.

Signature CreateSubFieldExpression(depVar)

Parameters:	depVar (`NXOpen.Fields.FieldVariable`) – dependent variables to be associated with the field
Returns:	field
Return type:	`NXOpen.Fields.FieldExpression`

New in version NX6.0.0.

License requirements: None.

CreateVectorFieldWrapperWithExpressions¶

FieldManager.CreateVectorFieldWrapperWithExpressions¶

Create a vector field wrapper backed by three scalar expressions

Signature CreateVectorFieldWrapperWithExpressions(expressions)

Parameters:	expressions (list of `NXOpen.Expression`) – existing expressions that will be this wrapper’s value
Returns:	scalar field wrapper created and associated to the expression
Return type:	`NXOpen.Fields.VectorFieldWrapper`

New in version NX6.0.0.

License requirements: None.

CreateVectorFieldWrapperWithField¶

FieldManager.CreateVectorFieldWrapperWithField¶

Create a vector field wrapper backed up by a scaled vector field

Signature CreateVectorFieldWrapperWithField(field, scaleFactors)

Parameters:	field (`NXOpen.Fields.Field`) – an existing field that will be this wrapper’s value scaleFactors (list of float) – the field will be multiplied by this scale factor when being evaluated
Returns:	vector field wrapper created and associated to the field
Return type:	`NXOpen.Fields.VectorFieldWrapper`

New in version NX6.0.0.

License requirements: None.

DeleteField¶

FieldManager.DeleteField¶

Deletes the specified NXOpen.Fields.Field object; if the object cannot be deleted it is returned.

Signature DeleteField(field)

Parameters:	field (`NXOpen.Fields.Field`) – field to delete
Returns:	If the field cannot be deleted, it is returned; if the field is deleted, this will be NULL
Return type:	`NXOpen.Fields.Field`

New in version NX6.0.0.

License requirements: None.

EditDependentVariable¶

FieldManager.EditDependentVariable¶

Overloaded method EditDependentVariable

EditDependentVariable(depVar, varName, unitType)
EditDependentVariable(depVar, unitType)

-------------------------------------

Edit dependent variable

Signature EditDependentVariable(depVar, varName, unitType)

Parameters:	depVar (`NXOpen.Fields.FieldVariable`) – dep variable to edit varName (str) – new name for variable, or NULL to skip updating name unitType (`NXOpen.Unit`) – new unit of the dependent variable

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Edit dependent variable

Signature EditDependentVariable(depVar, unitType)

Parameters:	depVar (`NXOpen.Fields.FieldVariable`) – dep variable to edit unitType (`NXOpen.Unit`) – new unit of the dependent variable

New in version NX11.0.0.

License requirements: None.

-------------------------------------

EditIndependentVariable¶

FieldManager.EditIndependentVariable¶

Overloaded method EditIndependentVariable

EditIndependentVariable(indepVar, varName, unitType, minValueSet, minValueInclusive, minValue, maxValueSet, maxValueInclusive, maxValue, numPtsSet, numPts, defaultValueSet, defaultValue)
EditIndependentVariable(indepVar, unitType)

-------------------------------------

Edit an independent variable

Signature EditIndependentVariable(indepVar, varName, unitType, minValueSet, minValueInclusive, minValue, maxValueSet, maxValueInclusive, maxValue, numPtsSet, numPts, defaultValueSet, defaultValue)

Parameters:

indepVar (NXOpen.Fields.FieldVariable) – indep var to edit
varName (str) – name of the independent variable to be created
unitType (NXOpen.Unit) – unit of the independent variable
minValueSet (bool) – logical value whether minimum value set
minValueInclusive (bool) – minimum value is itself included in range
minValue (float) – minimum value of the variable range
maxValueSet (bool) – logical value whether maximum value set
maxValueInclusive (bool) – maximum value is itself included in range
maxValue (float) – maximum value of the variable range
numPtsSet (bool) – logical value whether num_pts set
numPts (int) – num_pts of the variable range
defaultValueSet (bool) – logical value whether default value set
defaultValue (float) – default value of the variable range

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Edit an independent variable

Signature EditIndependentVariable(indepVar, unitType)

Parameters:	indepVar (`NXOpen.Fields.FieldVariable`) – indep var to edit unitType (`NXOpen.Unit`) – unit of the independent variable

New in version NX11.0.0.

License requirements: None.

-------------------------------------

ExportFields¶

FieldManager.ExportFields¶

Exports fields to a text file as defined by export_data parameter

Signature ExportFields(exportData)

Parameters:	exportData (`NXOpen.Fields.ExportData`) – Export data

New in version NX6.0.0.

License requirements: None.

FindObject¶

FieldManager.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.

GetNameVariable¶

FieldManager.GetNameVariable¶

Locate an existing, or create a new NXOpen.Fields.NameVariable object

Signature GetNameVariable(variableName, measureName)

Parameters:	variableName (str) – alphanumeric string; if it matches an existing name variable, the measures must also match measureName (str) – must match an existing measure name, or “Unitless”
Returns:	name variable with the specified measure and name
Return type:	`NXOpen.Fields.NameVariable`

New in version NX6.0.2.

License requirements: None.

GetValidFieldId¶

FieldManager.GetValidFieldId¶

Get the next available ID for NXOpen.Fields.Field object

Signature GetValidFieldId()

Returns:	valid id
Return type:	int

New in version NX9.0.0.

License requirements: None.

ImportFields¶

FieldManager.ImportFields¶

Imports fields from a text file as defined by import_data parameter

Signature ImportFields(importData)

Parameters:	importData (`NXOpen.Fields.ImportData`) – Import data

New in version NX6.0.0.

License requirements: None.

Print¶

FieldManager.Print¶

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName¶

FieldManager.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.