NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.Fields.FieldManager Class Reference

Represents the manager class of the Fields More...

Inheritance diagram for NXOpen.Fields.FieldManager:
NXOpen.NXObject NXOpen.TaggedObject NXOpen.INXObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe
NXOpen.Fields.FieldLinksTable 
ConvertToLinksTable (NXOpen.Fields.FieldTable table)
 Creates and returns a NXOpen.Fields.FieldLinksTable representation of this table. More...
 
unsafe
NXOpen.Fields.ComplexScalarFieldWrapper 
CreateComplexScalarFieldWrapperWithExpressions (NXOpen.Expression[] expressions)
 Create a complex scalar field wrapper backed by two scalar expressions More...
 
unsafe
NXOpen.Fields.ComplexScalarFieldWrapper 
CreateComplexScalarFieldWrapperWithField (NXOpen.Fields.Field field)
 Create a complex scalar field wrapper backed up by a complex scalar field More...
 
unsafe
NXOpen.Fields.ComplexScalarFieldWrapper 
CreateComplexScalarFieldWrapperWithFieldWithScaleFactor (NXOpen.Fields.Field field, double scaleFactor)
 Create a complex scalar field wrapper backed up by a complex scalar field with scale factor More...
 
unsafe
NXOpen.Fields.ComplexVectorFieldWrapper 
CreateComplexVectorFieldWrapperWithExpressions (NXOpen.Expression[] expressions)
 Create a complex vector field wrapper backed by six scalar expressions More...
 
unsafe
NXOpen.Fields.ComplexVectorFieldWrapper 
CreateComplexVectorFieldWrapperWithField (NXOpen.Fields.Field field, double scaleFactor)
 Create a complex vector field wrapper backed up by a complex vector field More...
 
unsafe NXOpen.Fields.FieldVariable CreateDependentVariable (NXOpen.Fields.Field ownerField, NXOpen.Fields.NameVariable nameVariable, NXOpen.Unit unitType)
 Create a dependent variable to be added to the field More...
 
unsafe NXOpen.Fields.FieldVariable CreateDependentVariable (NXOpen.Fields.Field ownerField, NXOpen.Fields.NameVariable nameVariable, NXOpen.Unit unitType, NXOpen.Fields.FieldVariable.ValueType type)
 Create a dependent variable to be added to the field, specifying the variable value type More...
 
unsafe
NXOpen.Fields.DisplayPropertiesBuilder 
CreateDisplayPropertiesBuilder (NXOpen.Fields.Field[] fieldArray)
 Creates a NXOpen.Fields.DisplayPropertiesBuilder More...
 
unsafe NXOpen.Fields.ExportData CreateExportData ()
 Creates a Fields. More...
 
unsafe
NXOpen.Fields.FieldExpression 
CreateFieldExpression (string fieldExpString, NXOpen.Unit unitType)
 Creates a system NXOpen.Fields.FieldExpression object. More...
 
unsafe NXOpen.Fields.FieldFormula CreateFieldFormula (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldExpression[] depExpArray)
 Creates a NXOpen.Fields.FieldFormula object with dependent NXOpen.Fields.FieldExpression . More...
 
unsafe NXOpen.Fields.FieldLink CreateFieldLink (string fieldName, NXOpen.Fields.Field fieldToLink)
 Creates a NXOpen.Fields.FieldLink . More...
 
unsafe
NXOpen.Fields.FieldLinksTable 
CreateFieldLinksTable (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldVariable[] depVarArray, double[] datapoints, NXOpen.Fields.Field[] linkFieldsArray)
 Creates a NXOpen.Fields.FieldLinksTable object with dependent and independent variables NXOpen.Fields.FieldVariable . More...
 
unsafe
NXOpen.Fields.FieldLinksTable 
CreateFieldLinksTable (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldVariable[] depVarArray, double[] datapoints, NXOpen.Fields.Field[] linkFieldsArray, bool[] managedFieldsArray)
 Creates a NXOpen.Fields.FieldLinksTable object with dependent and independent variables NXOpen.Fields.FieldVariable . More...
 
unsafe NXOpen.Fields.FieldTable CreateFieldTable (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldVariable[] depVarArray, double[] datapoints)
 Creates a NXOpen.Fields.FieldTable object with dependent and independent variables NXOpen.Fields.FieldVariable . More...
 
unsafe NXOpen.Fields.FieldTable CreateFieldTable (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldVariable[] depVarArray, double[] datapoints, NXOpen.Fields.FieldTable.DuplicateValueOption duplicateValueProcessingOption)
 Creates a NXOpen.Fields.FieldTable object with duplicate value processing option,dependent and independent variables NXOpen.Fields.FieldVariable . More...
 
unsafe NXOpen.Fields.FieldTable CreateFieldTable (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldVariable[] depVarArray, double[] datapoints, NXOpen.Fields.FieldTable.DuplicateValueOption duplicateValueProcessingOption, NXOpen.Fields.FieldTable.StructDataTableType structDataType, int numStructDataRows, int numStructDataColumns, int numStructDataPlanes)
 Creates a NXOpen.Fields.FieldTable object with Table Struct Data ,Duplicate value processing option,dependent and independent variables NXOpen.Fields.FieldVariable . More...
 
unsafe NXOpen.Fields.FieldTable CreateFieldTableFromData (string fieldNamePrefix, NXOpen.Unit ivarUnit, NXOpen.Unit dvarUnit, NXOpen.Fields.FieldVariable.ValueType dvarType, double[] datapoints)
 Creates a NXOpen.Fields.FieldTable object with dependent and independent variables NXOpen.Fields.FieldVariable . More...
 
unsafe NXOpen.Fields.FieldTable CreateFieldTableWithPoints (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldVariable[] depVarArray, double[] datapoints, NXOpen.Fields.FieldTable.DuplicateValueOption duplicateValueProcessingOption, int[] pointObjectRowIds, NXOpen.Point[] pointObjects)
 Creates a NXOpen.Fields.FieldTable object with duplicate value processing option,dependent and independent variables, and smart points NXOpen.Fields.FieldVariable . More...
 
unsafe NXOpen.Fields.FieldWrapper CreateFieldWrapper (NXOpen.Fields.Field field)
 Create a field wrapper backed up by a field More...
 
unsafe NXOpen.Fields.ImportBuilder CreateImportBuilder ()
 Creates a Fields. More...
 
unsafe NXOpen.Fields.ImportData CreateImportData ()
 Creates a Fields. More...
 
unsafe
NXOpen.Fields.ImportTableDataBuilder 
CreateImportTableDataBuilder (string fieldName, NXOpen.Fields.FieldVariable[] indepVarArray, NXOpen.Fields.FieldVariable[] depVarArray)
 Creates a NXOpen.Fields.ImportTableDataBuilder with inputs to create the field on commit More...
 
unsafe
NXOpen.Fields.ImportTableDataBuilder 
CreateImportTableDataBuilderFromTable (NXOpen.Fields.FieldTable fieldTable)
 Creates a NXOpen.Fields.ImportTableDataBuilder with inputs to create the field on commit More...
 
unsafe NXOpen.Fields.FieldVariable CreateIndependentVariable (NXOpen.Fields.Field ownerField, NXOpen.Fields.NameVariable nameVariable, NXOpen.Unit unitType, bool minValueSet, bool minValueInclusive, double minValue, bool maxValueSet, bool maxValueInclusive, double maxValue, bool numPtsSet, int numPts, bool defaultValueSet, double defaultValue)
 Create an independent variable to be added to the field More...
 
unsafe NXOpen.Fields.FieldVariable CreateIndependentVariable (NXOpen.Fields.Field ownerField, NXOpen.Fields.NameVariable nameVariable, NXOpen.Unit unitType, NXOpen.Fields.FieldVariable.ValueType type, bool minValueSet, bool minValueInclusive, double minValue, bool maxValueSet, bool maxValueInclusive, double maxValue, bool numPtsSet, int numPts, bool defaultValueSet, double defaultValue)
 Create an independent variable to be added to the field, specifying the variable value type More...
 
unsafe NXOpen.Fields.Field CreateMeshSizeFieldData (int elementSizeType, NXOpen.TaggedObject[] meshArray)
 Create Mesh Size Field NXOpen.Fields.Field object More...
 
unsafe NXOpen.Fields.PathObjects CreatePathObjects ()
 Creates a NXOpen.Fields.PathObjects More...
 
unsafe
NXOpen.Fields.ScalarFieldWrapper 
CreateScalarFieldWrapperWithExpression (NXOpen.Expression expression)
 Create a field wrapper backed by a scalar expression More...
 
unsafe
NXOpen.Fields.ScalarFieldWrapper 
CreateScalarFieldWrapperWithField (NXOpen.Fields.Field field, double scaleFactor)
 Create a scalar field wrapper backed up by a scaled scalar field More...
 
unsafe
NXOpen.Fields.SpatialMapBuilder 
CreateSpatialMapBuilder (NXOpen.Fields.SpatialMap spatialmap)
 Creates a NXOpen.Fields.SpatialMapBuilder More...
 
unsafe
NXOpen.Fields.FieldExpression 
CreateSubFieldExpression (NXOpen.Fields.FieldVariable depVar)
 Creates a system NXOpen.Fields.FieldExpression object with independent variables. More...
 
unsafe
NXOpen.Fields.VectorFieldWrapper 
CreateVectorFieldWrapperWithExpressions (NXOpen.Expression[] expressions)
 Create a vector field wrapper backed by three scalar expressions More...
 
unsafe
NXOpen.Fields.VectorFieldWrapper 
CreateVectorFieldWrapperWithField (NXOpen.Fields.Field field, double[] scaleFactors)
 Create a vector field wrapper backed up by a scaled vector field More...
 
unsafe NXOpen.Fields.Field DeleteField (NXOpen.Fields.Field field)
 Deletes the specified NXOpen.Fields.Field object; if the object cannot be deleted it is returned. More...
 
unsafe void EditDependentVariable (NXOpen.Fields.FieldVariable depVar, string varName, NXOpen.Unit unitType)
 Edit dependent variable More...
 
unsafe void EditDependentVariable (NXOpen.Fields.FieldVariable depVar, NXOpen.Unit unitType)
 Edit dependent variable More...
 
unsafe void EditIndependentVariable (NXOpen.Fields.FieldVariable indepVar, string varName, NXOpen.Unit unitType, bool minValueSet, bool minValueInclusive, double minValue, bool maxValueSet, bool maxValueInclusive, double maxValue, bool numPtsSet, int numPts, bool defaultValueSet, double defaultValue)
 Edit an independent variable More...
 
unsafe void EditIndependentVariable (NXOpen.Fields.FieldVariable indepVar, NXOpen.Unit unitType)
 Edit an independent variable More...
 
unsafe void ExportFields (NXOpen.Fields.ExportData exportData)
 Exports fields to a text file as defined by export_data parameter More...
 
unsafe NXOpen.Fields.NameVariable GetNameVariable (string variableName, string measureName)
 Locate an existing, or create a new NXOpen.Fields.NameVariable object More...
 
unsafe int GetValidFieldId ()
 Get the next available ID for NXOpen.Fields.Field object More...
 
unsafe void ImportFields (NXOpen.Fields.ImportData importData)
 Imports fields from a text file as defined by import_data parameter More...
 
unsafe void SetUndefinedVariableValue (double undefinedValue)
 Set the value to be used for un-set variables and plugin functions when evaluating an expression More...
 
- Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator CreateAttributeIterator ()
 Create an attribute iterator More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
 Deletes all attributes of a specific type. More...
 
unsafe void DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes all attributes of a specific type with the option to update or not. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
 Deletes an attribute by type and title. More...
 
unsafe void DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
unsafe void DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
unsafe void DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
 Deletes the attributes on the object, if any, that satisfy the given iterator More...
 
unsafe void DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
 Deletes the attributes encountered with the given Type with option to update or not. More...
 
unsafe NXOpen.INXObject FindObject (string journalIdentifier)
 Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
unsafe bool GetBooleanUserAttribute (string title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.ComputationalTime 
GetComputationalTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe int GetIntegerAttribute (string title)
 Gets an integer attribute by title. More...
 
unsafe int GetIntegerUserAttribute (string title, int index)
 Gets an integer attribute by Title and array Index. More...
 
unsafe bool GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
 Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...
 
unsafe string GetPdmReferenceAttributeValue (string attributeTitle)
 Gets the value of PDM Reference attribute for given object. More...
 
unsafe double GetRealAttribute (string title)
 Gets a real attribute by title. More...
 
unsafe double GetRealUserAttribute (string title, int index)
 Gets a real attribute by Title and array Index. More...
 
unsafe string GetReferenceAttribute (string title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
unsafe string GetStringAttribute (string title)
 Gets a string attribute value by title. More...
 
unsafe string GetStringUserAttribute (string title, int index)
 Gets a string attribute by Title and array Index. More...
 
unsafe string GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
 Gets a time attribute by title. More...
 
unsafe string GetTimeUserAttribute (string title, int index)
 Gets a time attribute by Title and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation 
GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
 Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
 
unsafe string GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
 Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
 Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
unsafe int GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
 Gets the count of attributes on the object, if any, of the given type. More...
 
unsafe bool GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
 Determine the lock of the given attribute. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (NXOpen.AttributeIterator iterator)
 Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
unsafe
NXOpen.NXObject.AttributeInformation[] 
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
unsafe string[] GetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
unsafe int GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
 Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
 
unsafe NXOpen.NXObject[] GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
unsafe bool HasUserAttribute (NXOpen.AttributeIterator iterator)
 Determines if an attribute exists on the object, that satisfies the given iterator More...
 
unsafe bool HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
 Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
 
unsafe void Print ()
 Prints a representation of this object to the system log file. More...
 
unsafe void SetAttribute (string title, int value)
 Creates or modifies an integer attribute. More...
 
unsafe void SetAttribute (string title, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, double value)
 Creates or modifies a real attribute. More...
 
unsafe void SetAttribute (string title, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title, string value)
 Creates or modifies a string attribute. More...
 
unsafe void SetAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetAttribute (string title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
unsafe void SetAttribute (string title, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
unsafe void SetName (string name)
 Sets the custom name of the object. More...
 
unsafe void SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
 Sets the value of PDM Reference attribute on the object. More...
 
unsafe void SetReferenceAttribute (string title, string value)
 Creates or modifies a string attribute which uses a reference string. More...
 
unsafe void SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
unsafe void SetTimeAttribute (string title, string value)
 Creates or modifies a time attribute. More...
 
unsafe void SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
unsafe void SetUserAttribute (string title, int index, NXOpen.Update.Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
unsafe void SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

NXOpen.Fields.FieldDomainCollection Domains [get]
 Returns a collection of Domains More...
 
NXOpen.Fields.FieldCollection Fields [get]
 Returns a collection of Fields More...
 
- Properties inherited from NXOpen.NXObject
unsafe bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
unsafe string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
unsafe string Name [get]
 Returns the custom name of the object. More...
 
unsafe NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
unsafe NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
unsafe NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 
- Properties inherited from NXOpen.INXObject
bool IsOccurrence [get]
 Returns whether this object is an occurrence or not. More...
 
string JournalIdentifier [get]
 Returns the identifier that would be recorded in a journal for this object. More...
 
string Name [get]
 Returns the custom name of the object. More...
 
NXOpen.Assemblies.Component OwningComponent [get]
 Returns the owning component, if this object is an occurrence. More...
 
NXOpen.BasePart OwningPart [get]
 Returns the owning part of this object More...
 
NXOpen.INXObject Prototype [get]
 Returns the prototype of this object if it is an occurrence. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.NXObject
enum  AttributeType {
  Invalid, Null, Boolean, Integer,
  Real, String, Time, Reference,
  Any = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { Numeric, Textual }
 Specifies the format of the date and time attribute. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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.

Created in NX4.0.0

Member Function Documentation

unsafe NXOpen.Fields.FieldLinksTable NXOpen.Fields.FieldManager.ConvertToLinksTable ( NXOpen.Fields.FieldTable  table)
inline

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.

Created in NX12.0.0

License requirements: None.

Parameters
tableTable to be converted
Returns
table of fields
unsafe NXOpen.Fields.ComplexScalarFieldWrapper NXOpen.Fields.FieldManager.CreateComplexScalarFieldWrapperWithExpressions ( NXOpen.Expression[]  expressions)
inline

Create a complex scalar field wrapper backed by two scalar expressions

Created in NX11.0.0

License requirements: None.

Parameters
expressionsexisting expressions that will be this wrapper's value
Returns
scalar field wrapper created and associated to the expression
unsafe NXOpen.Fields.ComplexScalarFieldWrapper NXOpen.Fields.FieldManager.CreateComplexScalarFieldWrapperWithField ( NXOpen.Fields.Field  field)
inline

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

Created in NX11.0.0

License requirements: None.

Parameters
fieldan existing field that will be this wrapper's value
Returns
vector field wrapper created and associated to the field
unsafe NXOpen.Fields.ComplexScalarFieldWrapper NXOpen.Fields.FieldManager.CreateComplexScalarFieldWrapperWithFieldWithScaleFactor ( NXOpen.Fields.Field  field,
double  scaleFactor 
)
inline

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

Created in NX12.0.0

License requirements: None.

Parameters
fieldan existing field that will be this wrapper's value
scaleFactorthe field will be multiplied by this scale factor when being evaluated
Returns
scalar field wrapper created and associated to the field
unsafe NXOpen.Fields.ComplexVectorFieldWrapper NXOpen.Fields.FieldManager.CreateComplexVectorFieldWrapperWithExpressions ( NXOpen.Expression[]  expressions)
inline

Create a complex vector field wrapper backed by six scalar expressions

Created in NX12.0.0

License requirements: None.

Parameters
expressionsexisting expressions that will be this wrapper's value
Returns
scalar field wrapper created and associated to the expression
unsafe NXOpen.Fields.ComplexVectorFieldWrapper NXOpen.Fields.FieldManager.CreateComplexVectorFieldWrapperWithField ( NXOpen.Fields.Field  field,
double  scaleFactor 
)
inline

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

Created in NX12.0.0

License requirements: None.

Parameters
fieldan existing field that will be this wrapper's value
scaleFactorthe field will be multiplied by this scale factor when being evaluated
Returns
vector field wrapper created and associated to the field
unsafe NXOpen.Fields.FieldVariable NXOpen.Fields.FieldManager.CreateDependentVariable ( NXOpen.Fields.Field  ownerField,
NXOpen.Fields.NameVariable  nameVariable,
NXOpen.Unit  unitType 
)
inline

Create a dependent variable to be added to the field

Created in NX6.0.2

License requirements: None.

Parameters
ownerFieldowner field
nameVariableexisting name variable
unitTypeunit of the dependent variable
Returns
dependent variable created and associated to the field
unsafe NXOpen.Fields.FieldVariable NXOpen.Fields.FieldManager.CreateDependentVariable ( NXOpen.Fields.Field  ownerField,
NXOpen.Fields.NameVariable  nameVariable,
NXOpen.Unit  unitType,
NXOpen.Fields.FieldVariable.ValueType  type 
)
inline

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

Created in NX11.0.0

License requirements: None.

Parameters
ownerFieldowner field
nameVariableexisting name variable
unitTypeunit of the dependent variable
typevariable value type
Returns
dependent variable created and associated to the field
unsafe NXOpen.Fields.DisplayPropertiesBuilder NXOpen.Fields.FieldManager.CreateDisplayPropertiesBuilder ( NXOpen.Fields.Field[]  fieldArray)
inline

Creates a NXOpen.Fields.DisplayPropertiesBuilder

Created in NX6.0.1

License requirements: None.

Parameters
fieldArrayfields to edit display properties
Returns
unsafe NXOpen.Fields.ExportData NXOpen.Fields.FieldManager.CreateExportData ( )
inline

Creates a Fields.

ExportData

Created in NX6.0.0

License requirements: None.

Returns
the export data created
unsafe NXOpen.Fields.FieldExpression NXOpen.Fields.FieldManager.CreateFieldExpression ( string  fieldExpString,
NXOpen.Unit  unitType 
)
inline

Creates a system NXOpen.Fields.FieldExpression object.

Specifies the new expression string.

Created in NX4.0.0

License requirements: None.

Parameters
fieldExpStringexpression string to be associated with the field
unitTypeunit of the field
Returns
field
unsafe NXOpen.Fields.FieldFormula NXOpen.Fields.FieldManager.CreateFieldFormula ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldExpression[]  depExpArray 
)
inline

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

Created in NX6.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the field
depExpArraydependent expression fields to be associated with the formula field
Returns
field
unsafe NXOpen.Fields.FieldLink NXOpen.Fields.FieldManager.CreateFieldLink ( string  fieldName,
NXOpen.Fields.Field  fieldToLink 
)
inline

Creates a NXOpen.Fields.FieldLink .

Created in NX6.0.0

License requirements: None.

Parameters
fieldNamefield name
fieldToLinkfield to link
Returns
field
unsafe NXOpen.Fields.FieldLinksTable NXOpen.Fields.FieldManager.CreateFieldLinksTable ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldVariable[]  depVarArray,
double[]  datapoints,
NXOpen.Fields.Field[]  linkFieldsArray 
)
inline

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

Created in NX9.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the field
depVarArraydependent variables of this and all linked fields
datapointsrow based array of double values representing the first independent variable; the number of points should equal the number of rows.
linkFieldsArrayrow based array of link field values representing the table; the number of fields should equal the number of rows.
Returns
links table field
unsafe NXOpen.Fields.FieldLinksTable NXOpen.Fields.FieldManager.CreateFieldLinksTable ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldVariable[]  depVarArray,
double[]  datapoints,
NXOpen.Fields.Field[]  linkFieldsArray,
bool[]  managedFieldsArray 
)
inline

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

Created in NX12.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the field
depVarArraydependent variables of this and all linked fields
datapointsrow based array of double values representing the first independent variable; the number of points should equal the number of rows.
linkFieldsArrayrow based array of link field values representing the table; the number of fields should equal the number of rows.
managedFieldsArrayrow based array of logical values indicating the links table field should manage the specified fields .
Returns
links table field
unsafe NXOpen.Fields.FieldTable NXOpen.Fields.FieldManager.CreateFieldTable ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldVariable[]  depVarArray,
double[]  datapoints 
)
inline

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

Created in NX6.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the table field
depVarArraydependent variables to be associated with the table field
datapointsrow 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
unsafe NXOpen.Fields.FieldTable NXOpen.Fields.FieldManager.CreateFieldTable ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldVariable[]  depVarArray,
double[]  datapoints,
NXOpen.Fields.FieldTable.DuplicateValueOption  duplicateValueProcessingOption 
)
inline

Creates a NXOpen.Fields.FieldTable object with duplicate value processing option,dependent and independent variables NXOpen.Fields.FieldVariable .

Created in NX1847.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the table field
depVarArraydependent variables to be associated with the table field
datapointsrow 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.
duplicateValueProcessingOption
Returns
field
unsafe NXOpen.Fields.FieldTable NXOpen.Fields.FieldManager.CreateFieldTable ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldVariable[]  depVarArray,
double[]  datapoints,
NXOpen.Fields.FieldTable.DuplicateValueOption  duplicateValueProcessingOption,
NXOpen.Fields.FieldTable.StructDataTableType  structDataType,
int  numStructDataRows,
int  numStructDataColumns,
int  numStructDataPlanes 
)
inline

Creates a NXOpen.Fields.FieldTable object with Table Struct Data ,Duplicate value processing option,dependent and independent variables NXOpen.Fields.FieldVariable .

Created in NX1847.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the table field
depVarArraydependent variables to be associated with the table field
datapointsrow 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.
duplicateValueProcessingOption
structDataType
numStructDataRows
numStructDataColumns
numStructDataPlanes
Returns
field
unsafe NXOpen.Fields.FieldTable NXOpen.Fields.FieldManager.CreateFieldTableFromData ( string  fieldNamePrefix,
NXOpen.Unit  ivarUnit,
NXOpen.Unit  dvarUnit,
NXOpen.Fields.FieldVariable.ValueType  dvarType,
double[]  datapoints 
)
inline

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.

Created in NX7.5.2

License requirements: None.

Parameters
fieldNamePrefixfield name prefix; e.g. "AFU Record"; field will have a unique generated name begining with this string
ivarUnitunit of the independent variable
dvarUnitunit of the dependent variable
dvarTypedependent variable type (real/imaginary/complex...)
datapointsrow 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
unsafe NXOpen.Fields.FieldTable NXOpen.Fields.FieldManager.CreateFieldTableWithPoints ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldVariable[]  depVarArray,
double[]  datapoints,
NXOpen.Fields.FieldTable.DuplicateValueOption  duplicateValueProcessingOption,
int[]  pointObjectRowIds,
NXOpen.Point[]  pointObjects 
)
inline

Creates a NXOpen.Fields.FieldTable object with duplicate value processing option,dependent and independent variables, and smart points NXOpen.Fields.FieldVariable .

Created in NX1899.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the table field
depVarArraydependent variables to be associated with the table field
datapointsrow 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.
duplicateValueProcessingOption
pointObjectRowIds0 based row ID of rows that have associated point objects
pointObjectsarray of num_point_objects point objects to be associated to rows
Returns
field
unsafe NXOpen.Fields.FieldWrapper NXOpen.Fields.FieldManager.CreateFieldWrapper ( NXOpen.Fields.Field  field)
inline

Create a field wrapper backed up by a field

Created in NX6.0.0

License requirements: None.

Parameters
fieldan existing field that will be this wrapper's value
Returns
scalar field wrapper created and associated to the field
unsafe NXOpen.Fields.ImportBuilder NXOpen.Fields.FieldManager.CreateImportBuilder ( )
inline

Creates a Fields.

ImportData

Created in NX1847.0.0

License requirements: None.

Returns
the import data created
unsafe NXOpen.Fields.ImportData NXOpen.Fields.FieldManager.CreateImportData ( )
inline

Creates a Fields.

ImportData

Created in NX6.0.0

License requirements: None.

Returns
the import data created
unsafe NXOpen.Fields.ImportTableDataBuilder NXOpen.Fields.FieldManager.CreateImportTableDataBuilder ( string  fieldName,
NXOpen.Fields.FieldVariable[]  indepVarArray,
NXOpen.Fields.FieldVariable[]  depVarArray 
)
inline

Creates a NXOpen.Fields.ImportTableDataBuilder with inputs to create the field on commit

Created in NX1847.0.0

License requirements: None.

Parameters
fieldNamefield name
indepVarArrayindependent variables to be associated with the table field
depVarArraydependent variables to be associated with the table field
Returns
unsafe NXOpen.Fields.ImportTableDataBuilder NXOpen.Fields.FieldManager.CreateImportTableDataBuilderFromTable ( NXOpen.Fields.FieldTable  fieldTable)
inline

Creates a NXOpen.Fields.ImportTableDataBuilder with inputs to create the field on commit

Created in NX1847.0.0

License requirements: None.

Parameters
fieldTableexisting table field to import data to
Returns
unsafe NXOpen.Fields.FieldVariable NXOpen.Fields.FieldManager.CreateIndependentVariable ( NXOpen.Fields.Field  ownerField,
NXOpen.Fields.NameVariable  nameVariable,
NXOpen.Unit  unitType,
bool  minValueSet,
bool  minValueInclusive,
double  minValue,
bool  maxValueSet,
bool  maxValueInclusive,
double  maxValue,
bool  numPtsSet,
int  numPts,
bool  defaultValueSet,
double  defaultValue 
)
inline

Create an independent variable to be added to the field

Created in NX6.0.2

License requirements: None.

Parameters
ownerFieldowner field
nameVariableexisting name variable
unitTypeunit of the independent variable
minValueSetlogical value whether minimum value set
minValueInclusiveminimum value is itself included in range
minValueminimum value of the variable range
maxValueSetlogical value whether maximum value set
maxValueInclusivemaximum value is itself included in range
maxValuemaximum value of the variable range
numPtsSetlogical value whether num_pts set
numPtsnum_pts of the variable range
defaultValueSetlogical value whether default value set
defaultValuedefault value of the variable range
Returns
independent variable created and associated to the field
unsafe NXOpen.Fields.FieldVariable NXOpen.Fields.FieldManager.CreateIndependentVariable ( NXOpen.Fields.Field  ownerField,
NXOpen.Fields.NameVariable  nameVariable,
NXOpen.Unit  unitType,
NXOpen.Fields.FieldVariable.ValueType  type,
bool  minValueSet,
bool  minValueInclusive,
double  minValue,
bool  maxValueSet,
bool  maxValueInclusive,
double  maxValue,
bool  numPtsSet,
int  numPts,
bool  defaultValueSet,
double  defaultValue 
)
inline

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

Created in NX11.0.0

License requirements: None.

Parameters
ownerFieldowner field
nameVariableexisting name variable
unitTypeunit of the independent variable
typevariable value type
minValueSetlogical value whether minimum value set
minValueInclusiveminimum value is itself included in range
minValueminimum value of the variable range
maxValueSetlogical value whether maximum value set
maxValueInclusivemaximum value is itself included in range
maxValuemaximum value of the variable range
numPtsSetlogical value whether num_pts set
numPtsnum_pts of the variable range
defaultValueSetlogical value whether default value set
defaultValuedefault value of the variable range
Returns
independent variable created and associated to the field
unsafe NXOpen.Fields.Field NXOpen.Fields.FieldManager.CreateMeshSizeFieldData ( int  elementSizeType,
NXOpen.TaggedObject[]  meshArray 
)
inline

Create Mesh Size Field NXOpen.Fields.Field object

Created in NX11.0.0

License requirements: None.

Parameters
elementSizeTypeAt Centroid of Element Free Face and Elements=0, At Centroid of Element Free Faces=1, At Centroid of Elements=2
meshArray
Returns
Created Field
unsafe NXOpen.Fields.PathObjects NXOpen.Fields.FieldManager.CreatePathObjects ( )
inline

Creates a NXOpen.Fields.PathObjects

Created in NX6.0.1

License requirements: None.

Returns
unsafe NXOpen.Fields.ScalarFieldWrapper NXOpen.Fields.FieldManager.CreateScalarFieldWrapperWithExpression ( NXOpen.Expression  expression)
inline

Create a field wrapper backed by a scalar expression

Created in NX6.0.0

License requirements: None.

Parameters
expressionan existing expression that will be this wrapper's value
Returns
scalar field wrapper created and associated to the expression
unsafe NXOpen.Fields.ScalarFieldWrapper NXOpen.Fields.FieldManager.CreateScalarFieldWrapperWithField ( NXOpen.Fields.Field  field,
double  scaleFactor 
)
inline

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

Created in NX6.0.0

License requirements: None.

Parameters
fieldan existing field that will be this wrapper's value
scaleFactorthe field will be multiplied by this scale factor when being evaluated
Returns
scalar field wrapper created and associated to the field
unsafe NXOpen.Fields.SpatialMapBuilder NXOpen.Fields.FieldManager.CreateSpatialMapBuilder ( NXOpen.Fields.SpatialMap  spatialmap)
inline

Creates a NXOpen.Fields.SpatialMapBuilder

Created in NX6.0.0

License requirements: None.

Parameters
spatialmapExisting SpatialMap to edit; NULL to create
Returns
unsafe NXOpen.Fields.FieldExpression NXOpen.Fields.FieldManager.CreateSubFieldExpression ( NXOpen.Fields.FieldVariable  depVar)
inline

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 .

Created in NX6.0.0

License requirements: None.

Parameters
depVardependent variables to be associated with the field
Returns
field
unsafe NXOpen.Fields.VectorFieldWrapper NXOpen.Fields.FieldManager.CreateVectorFieldWrapperWithExpressions ( NXOpen.Expression[]  expressions)
inline

Create a vector field wrapper backed by three scalar expressions

Created in NX6.0.0

License requirements: None.

Parameters
expressionsexisting expressions that will be this wrapper's value
Returns
scalar field wrapper created and associated to the expression
unsafe NXOpen.Fields.VectorFieldWrapper NXOpen.Fields.FieldManager.CreateVectorFieldWrapperWithField ( NXOpen.Fields.Field  field,
double[]  scaleFactors 
)
inline

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

Created in NX6.0.0

License requirements: None.

Parameters
fieldan existing field that will be this wrapper's value
scaleFactorsthe field will be multiplied by this scale factor when being evaluated
Returns
vector field wrapper created and associated to the field
unsafe NXOpen.Fields.Field NXOpen.Fields.FieldManager.DeleteField ( NXOpen.Fields.Field  field)
inline

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

Created in NX6.0.0

License requirements: None.

Parameters
fieldfield to delete
Returns
If the field cannot be deleted, it is returned; if the field is deleted, this will be NULL
unsafe void NXOpen.Fields.FieldManager.EditDependentVariable ( NXOpen.Fields.FieldVariable  depVar,
string  varName,
NXOpen.Unit  unitType 
)
inline

Edit dependent variable

Created in NX6.0.0

License requirements: None.

Parameters
depVardep variable to edit
varNamenew name for variable, or NULL to skip updating name
unitTypenew unit of the dependent variable
unsafe void NXOpen.Fields.FieldManager.EditDependentVariable ( NXOpen.Fields.FieldVariable  depVar,
NXOpen.Unit  unitType 
)
inline

Edit dependent variable

Created in NX11.0.0

License requirements: None.

Parameters
depVardep variable to edit
unitTypenew unit of the dependent variable
unsafe void NXOpen.Fields.FieldManager.EditIndependentVariable ( NXOpen.Fields.FieldVariable  indepVar,
string  varName,
NXOpen.Unit  unitType,
bool  minValueSet,
bool  minValueInclusive,
double  minValue,
bool  maxValueSet,
bool  maxValueInclusive,
double  maxValue,
bool  numPtsSet,
int  numPts,
bool  defaultValueSet,
double  defaultValue 
)
inline

Edit an independent variable

Created in NX6.0.0

License requirements: None.

Parameters
indepVarindep var to edit
varNamename of the independent variable to be created
unitTypeunit of the independent variable
minValueSetlogical value whether minimum value set
minValueInclusiveminimum value is itself included in range
minValueminimum value of the variable range
maxValueSetlogical value whether maximum value set
maxValueInclusivemaximum value is itself included in range
maxValuemaximum value of the variable range
numPtsSetlogical value whether num_pts set
numPtsnum_pts of the variable range
defaultValueSetlogical value whether default value set
defaultValuedefault value of the variable range
unsafe void NXOpen.Fields.FieldManager.EditIndependentVariable ( NXOpen.Fields.FieldVariable  indepVar,
NXOpen.Unit  unitType 
)
inline

Edit an independent variable

Created in NX11.0.0

License requirements: None.

Parameters
indepVarindep var to edit
unitTypeunit of the independent variable
unsafe void NXOpen.Fields.FieldManager.ExportFields ( NXOpen.Fields.ExportData  exportData)
inline

Exports fields to a text file as defined by export_data parameter

Created in NX6.0.0

License requirements: None.

Parameters
exportDataExport data
unsafe NXOpen.Fields.NameVariable NXOpen.Fields.FieldManager.GetNameVariable ( string  variableName,
string  measureName 
)
inline

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

Created in NX6.0.2

License requirements: None.

Parameters
variableNamealphanumeric string; if it matches an existing name variable, the measures must also match
measureNamemust match an existing measure name, or "Unitless"
Returns
name variable with the specified measure and name
unsafe int NXOpen.Fields.FieldManager.GetValidFieldId ( )
inline

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

Created in NX9.0.0

License requirements: None.

Returns
valid id
unsafe void NXOpen.Fields.FieldManager.ImportFields ( NXOpen.Fields.ImportData  importData)
inline

Imports fields from a text file as defined by import_data parameter

Created in NX6.0.0

License requirements: None.

Parameters
importDataImport data
unsafe void NXOpen.Fields.FieldManager.SetUndefinedVariableValue ( double  undefinedValue)
inline

Set the value to be used for un-set variables and plugin functions when evaluating an expression

Created in NX1847.0.0

License requirements: None.

Parameters
undefinedValuevalue to be used for un-set variables and plugin functions when evaluating an expression

Property Documentation

NXOpen.Fields.FieldDomainCollection NXOpen.Fields.FieldManager.Domains
get

Returns a collection of Domains

Created in NX3.0.0

NXOpen.Fields.FieldCollection NXOpen.Fields.FieldManager.Fields
get

Returns a collection of Fields

Created in NX11.0.0


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.