NX Open C++ Reference Guide
Public Member Functions | 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

Public Member Functions

NXOpen::Fields::FieldVariableCreateDependentVariable (NXOpen::Fields::Field *ownerField, NXOpen::Fields::NameVariable *nameVariable, NXOpen::Unit *unitType)
 Create a dependent variable to be added to the field. More...
 
NXOpen::Fields::DisplayPropertiesBuilderCreateDisplayPropertiesBuilder (const std::vector< NXOpen::Fields::Field * > &fieldArray)
 Creates a NXOpen::Fields::DisplayPropertiesBuilder. More...
 
NXOpen::Fields::ExportDataCreateExportData ()
 Creates a Fields.ExportData. More...
 
NXOpen::Fields::FieldExpressionCreateFieldExpression (const NXString &fieldExpString, NXOpen::Unit *unitType)
 Creates a system NXOpen::Fields::FieldExpression object. More...
 
NXOpen::Fields::FieldExpressionCreateFieldExpression (const char *fieldExpString, NXOpen::Unit *unitType)
 Creates a system NXOpen::Fields::FieldExpression object. More...
 
NXOpen::Fields::FieldExpressionCreateFieldExpression (const NXString &fieldExpString, NXOpen::Unit *unitType, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray)
 Creates a system NXOpen::Fields::FieldExpression object with independent variables. More...
 
NXOpen::Fields::FieldExpressionCreateFieldExpression (const char *fieldExpString, NXOpen::Unit *unitType, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray)
 Creates a system NXOpen::Fields::FieldExpression object with independent variables. More...
 
NXOpen::Fields::FieldFormulaCreateFieldFormula (const NXString &fieldName, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldExpression * > &depExpArray)
 Creates a NXOpen::Fields::FieldFormula object with dependent NXOpen::Fields::FieldExpression . More...
 
NXOpen::Fields::FieldFormulaCreateFieldFormula (const char *fieldName, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldExpression * > &depExpArray)
 Creates a NXOpen::Fields::FieldFormula object with dependent NXOpen::Fields::FieldExpression . More...
 
NXOpen::Fields::FieldLinkCreateFieldLink (const NXString &fieldName, NXOpen::Fields::Field *fieldToLink)
 Creates a NXOpen::Fields::FieldLink . More...
 
NXOpen::Fields::FieldLinkCreateFieldLink (const char *fieldName, NXOpen::Fields::Field *fieldToLink)
 Creates a NXOpen::Fields::FieldLink . More...
 
NXOpen::Fields::FieldLinksTableCreateFieldLinksTable (const NXString &fieldName, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldVariable * > &depVarArray, const std::vector< double > &datapoints, const std::vector< NXOpen::Fields::Field * > &linkFieldsArray)
 Creates a NXOpen::Fields::FieldLinksTable object with dependent and independent variables NXOpen::Fields::FieldVariable . More...
 
NXOpen::Fields::FieldLinksTableCreateFieldLinksTable (const char *fieldName, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldVariable * > &depVarArray, const std::vector< double > &datapoints, const std::vector< NXOpen::Fields::Field * > &linkFieldsArray)
 Creates a NXOpen::Fields::FieldLinksTable object with dependent and independent variables NXOpen::Fields::FieldVariable . More...
 
NXOpen::Fields::FieldTableCreateFieldTable (const NXString &fieldName, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldVariable * > &depVarArray, const std::vector< double > &datapoints)
 Creates a NXOpen::Fields::FieldTable object with dependent and independent variables NXOpen::Fields::FieldVariable . More...
 
NXOpen::Fields::FieldTableCreateFieldTable (const char *fieldName, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldVariable * > &depVarArray, const std::vector< double > &datapoints)
 Creates a NXOpen::Fields::FieldTable object with dependent and independent variables NXOpen::Fields::FieldVariable . More...
 
NXOpen::Fields::FieldTableCreateFieldTableFromData (const NXString &fieldNamePrefix, NXOpen::Unit *ivarUnit, NXOpen::Unit *dvarUnit, NXOpen::Fields::FieldVariable::ValueType dvarType, const std::vector< double > &datapoints)
 Creates a NXOpen::Fields::FieldTable object with dependent and independent variables NXOpen::Fields::FieldVariable . More...
 
NXOpen::Fields::FieldTableCreateFieldTableFromData (const char *fieldNamePrefix, NXOpen::Unit *ivarUnit, NXOpen::Unit *dvarUnit, NXOpen::Fields::FieldVariable::ValueType dvarType, const std::vector< double > &datapoints)
 Creates a NXOpen::Fields::FieldTable object with dependent and independent variables NXOpen::Fields::FieldVariable . More...
 
NXOpen::Fields::FieldWrapperCreateFieldWrapper (NXOpen::Fields::Field *field)
 Create a field wrapper backed up by a field. More...
 
NXOpen::Fields::ImportDataCreateImportData ()
 Creates a Fields.ImportData. More...
 
NXOpen::Fields::FieldVariableCreateIndependentVariable (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...
 
NXOpen::Fields::PathObjectsCreatePathObjects ()
 Creates a NXOpen::Fields::PathObjects. More...
 
NXOpen::Fields::ScalarFieldWrapperCreateScalarFieldWrapperWithExpression (NXOpen::Expression *expression)
 Create a field wrapper backed by a scalar expression. More...
 
NXOpen::Fields::ScalarFieldWrapperCreateScalarFieldWrapperWithField (NXOpen::Fields::Field *field, double scaleFactor)
 Create a scalar field wrapper backed up by a scaled scalar field. More...
 
NXOpen::Fields::SpatialMapBuilderCreateSpatialMapBuilder (NXOpen::Fields::SpatialMap *spatialmap)
 Creates a NXOpen::Fields::SpatialMapBuilder. More...
 
NXOpen::Fields::FieldExpressionCreateSubFieldExpression (NXOpen::Fields::FieldVariable *depVar)
 Creates a system NXOpen::Fields::FieldExpression object with independent variables. More...
 
NXOpen::Fields::VectorFieldWrapperCreateVectorFieldWrapperWithExpressions (const std::vector< NXOpen::Expression * > &expressions)
 Create a vector field wrapper backed by three scalar expressions. More...
 
NXOpen::Fields::VectorFieldWrapperCreateVectorFieldWrapperWithField (NXOpen::Fields::Field *field, const std::vector< double > &scaleFactors)
 Create a vector field wrapper backed up by a scaled vector field. More...
 
NXOpen::Fields::FieldDeleteField (NXOpen::Fields::Field *field)
 Deletes the specified NXOpen::Fields::Field object; if the object cannot be deleted it is returned. More...
 
NXOpen::Fields::FieldDomainCollectionDomains ()
 Returns a collection of Units
Created in NX3.0.0. More...
 
void EditDependentVariable (NXOpen::Fields::FieldVariable *depVar, const NXString &varName, NXOpen::Unit *unitType)
 Edit dependent variable. More...
 
void EditDependentVariable (NXOpen::Fields::FieldVariable *depVar, const char *varName, NXOpen::Unit *unitType)
 Edit dependent variable. More...
 
void EditIndependentVariable (NXOpen::Fields::FieldVariable *indepVar, const NXString &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...
 
void EditIndependentVariable (NXOpen::Fields::FieldVariable *indepVar, const char *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...
 
void ExportFields (NXOpen::Fields::ExportData *exportData)
 Exports fields to a text file as defined by export_data parameter
Created in NX6.0.0. More...
 
NXOpen::Fields::NameVariableGetNameVariable (const NXString &variableName, const NXString &measureName)
 Locate an existing, or create a new NXOpen::Fields::NameVariable object. More...
 
NXOpen::Fields::NameVariableGetNameVariable (const char *variableName, const char *measureName)
 Locate an existing, or create a new NXOpen::Fields::NameVariable object. More...
 
int GetValidFieldId ()
 Get the next available ID for NXOpen::Fields::Field object. More...
 
void ImportFields (NXOpen::Fields::ImportData *importData)
 Imports fields from a text file as defined by import_data parameter
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::NXObject
void DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
 Deletes all attributes of a specific type. More...
 
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...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
 Deletes an attribute by type and title. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
 Deletes an attribute by type and title with the option to update or not. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
void DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
 Deletes the first attribute encountered with the given Type, Title. More...
 
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...
 
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
 Gets all the attribute titles of a specific type. More...
 
bool GetBooleanUserAttribute (const NXString &title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
bool GetBooleanUserAttribute (const char *title, int index)
 Gets a boolean attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::ComputationalTime GetComputationalTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
int GetIntegerAttribute (const NXString &title)
 Gets an integer attribute by title. More...
 
int GetIntegerAttribute (const char *title)
 Gets an integer attribute by title. More...
 
int GetIntegerUserAttribute (const NXString &title, int index)
 Gets an integer attribute by Title and array Index. More...
 
int GetIntegerUserAttribute (const char *title, int index)
 Gets an integer attribute by Title and array Index. More...
 
double GetRealAttribute (const NXString &title)
 Gets a real attribute by title. More...
 
double GetRealAttribute (const char *title)
 Gets a real attribute by title. More...
 
double GetRealUserAttribute (const NXString &title, int index)
 Gets a real attribute by Title and array Index. More...
 
double GetRealUserAttribute (const char *title, int index)
 Gets a real attribute by Title and array Index. More...
 
NXString GetReferenceAttribute (const NXString &title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetReferenceAttribute (const char *title)
 Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
 
NXString GetStringAttribute (const NXString &title)
 Gets a string attribute value by title. More...
 
NXString GetStringAttribute (const char *title)
 Gets a string attribute value by title. More...
 
NXString GetStringUserAttribute (const NXString &title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetStringUserAttribute (const char *title, int index)
 Gets a string attribute by Title and array Index. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
 Gets a time attribute by title. More...
 
NXString GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
 Gets a time attribute by title. More...
 
NXString GetTimeUserAttribute (const NXString &title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXString GetTimeUserAttribute (const char *title, int index)
 Gets a time attribute by Title and array Index. More...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const NXString &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...
 
NXOpen::NXObject::AttributeInformation GetUserAttribute (const char *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...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const NXString &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...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttribute (const char *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...
 
NXString GetUserAttributeAsString (const NXString &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...
 
NXString GetUserAttributeAsString (const char *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...
 
int GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
 Gets the count of set attributes on the object, if any, of the given type. More...
 
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...
 
bool GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
bool GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
 Determine the lock of the given attribute. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes ()
 Gets all the attributes that have been set on the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset)
 Gets all the attributes of the given object. More...
 
std::vector
< NXOpen::NXObject::AttributeInformation
GetUserAttributes (bool includeUnset, bool addStringValues)
 Gets all the attributes of the given object. More...
 
std::vector< NXStringGetUserAttributesAsStrings ()
 Gets all the attributes that have been set on the given object. More...
 
int GetUserAttributeSize (const NXString &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...
 
int GetUserAttributeSize (const char *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...
 
std::vector< NXOpen::NXObject * > GetUserAttributeSourceObjects ()
 Returns an array of objects from which this object presents attributes. More...
 
bool HasUserAttribute (const NXString &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...
 
bool HasUserAttribute (const char *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...
 
virtual bool IsOccurrence ()
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()
 Returns the prototype of this object if it is an occurrence. More...
 
void SetAttribute (const NXString &title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const char *title, int value)
 Creates or modifies an integer attribute. More...
 
void SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const char *title, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const char *title, double value)
 Creates or modifies a real attribute. More...
 
void SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const char *title, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const char *title, const char *value)
 Creates or modifies a string attribute. More...
 
void SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetAttribute (const NXString &title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const char *title)
 Creates or modifies a null attribute which is an attribute with a title and no value. More...
 
void SetAttribute (const NXString &title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetAttribute (const char *title, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
void SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
 Creates or modifies a boolean attribute with the option to update or not. More...
 
virtual void SetName (const NXString &name)
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)
 Sets the custom name of the object. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const char *title, const char *value)
 Creates or modifies a string attribute which uses a reference string. More...
 
void SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const char *title, const char *value)
 Creates or modifies a time attribute. More...
 
void SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
 Creates or modifies a time attribute with the option to update or not. More...
 
void SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
 Creates or modifies an attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
 Creates or modifies an integer attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
 Creates or modifies a real attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
 Creates or modifies a string attribute with the option to update or not. More...
 
void SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
 Creates or modifies a null attribute with the option to update or not. More...
 
void SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
void SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
 Lock or unlock the given attribute. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. 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

NXOpen::Fields::FieldVariable* NXOpen::Fields::FieldManager::CreateDependentVariable ( NXOpen::Fields::Field ownerField,
NXOpen::Fields::NameVariable nameVariable,
NXOpen::Unit unitType 
)

Create a dependent variable to be added to the field.

Returns
dependent variable created and associated to the field
Created in NX6.0.2.

License requirements : None
Parameters
ownerFieldowner field
nameVariableexisting name variable
unitTypeunit of the dependent variable
NXOpen::Fields::DisplayPropertiesBuilder* NXOpen::Fields::FieldManager::CreateDisplayPropertiesBuilder ( const std::vector< NXOpen::Fields::Field * > &  fieldArray)

Creates a NXOpen::Fields::DisplayPropertiesBuilder.

Returns

Created in NX6.0.1.

License requirements : None
Parameters
fieldArrayfields to edit display properties
NXOpen::Fields::ExportData* NXOpen::Fields::FieldManager::CreateExportData ( )

Creates a Fields.ExportData.

Returns
the export data created
Created in NX6.0.0.

License requirements : None
NXOpen::Fields::FieldExpression* NXOpen::Fields::FieldManager::CreateFieldExpression ( const NXString fieldExpString,
NXOpen::Unit unitType 
)

Creates a system NXOpen::Fields::FieldExpression object.

Specifies the new expression string.

Returns
field
Created in NX4.0.0.

License requirements : None
Parameters
fieldExpStringexpression string to be associated with the field
NOTE: The full Unicode character set is not supported for this parameter.
unitTypeunit of the field
NXOpen::Fields::FieldExpression* NXOpen::Fields::FieldManager::CreateFieldExpression ( const char *  fieldExpString,
NXOpen::Unit unitType 
)

Creates a system NXOpen::Fields::FieldExpression object.

Specifies the new expression string.

Returns
field
Created in NX4.0.0.

License requirements : None
Parameters
fieldExpStringexpression string to be associated with the field
NOTE: The full Unicode character set is not supported for this parameter.
unitTypeunit of the field
NXOpen::Fields::FieldExpression* NXOpen::Fields::FieldManager::CreateFieldExpression ( const NXString fieldExpString,
NXOpen::Unit unitType,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray 
)

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.

Returns
field
Deprecated:
Deprecated in 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.


Created in NX4.0.0.

License requirements : None

Parameters
fieldExpStringexpression string to be associated with the field
NOTE: The full Unicode character set is not supported for this parameter.
unitTypeunit of the field
indepVarArrayindependent variables to be associated with the field
NXOpen::Fields::FieldExpression* NXOpen::Fields::FieldManager::CreateFieldExpression ( const char *  fieldExpString,
NXOpen::Unit unitType,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray 
)

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.

Returns
field
Deprecated:
Deprecated in 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.


Created in NX4.0.0.

License requirements : None

Parameters
fieldExpStringexpression string to be associated with the field
NOTE: The full Unicode character set is not supported for this parameter.
unitTypeunit of the field
indepVarArrayindependent variables to be associated with the field
NXOpen::Fields::FieldFormula* NXOpen::Fields::FieldManager::CreateFieldFormula ( const NXString fieldName,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray,
const std::vector< NXOpen::Fields::FieldExpression * > &  depExpArray 
)

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

Returns
field
Created in NX6.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
indepVarArrayindependent variables to be associated with the field
depExpArraydependent expression fields to be associated with the formula field
NXOpen::Fields::FieldFormula* NXOpen::Fields::FieldManager::CreateFieldFormula ( const char *  fieldName,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray,
const std::vector< NXOpen::Fields::FieldExpression * > &  depExpArray 
)

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

Returns
field
Created in NX6.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
indepVarArrayindependent variables to be associated with the field
depExpArraydependent expression fields to be associated with the formula field
NXOpen::Fields::FieldLink* NXOpen::Fields::FieldManager::CreateFieldLink ( const NXString fieldName,
NXOpen::Fields::Field fieldToLink 
)

Creates a NXOpen::Fields::FieldLink .

Returns
field
Created in NX6.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
fieldToLinkfield to link
NXOpen::Fields::FieldLink* NXOpen::Fields::FieldManager::CreateFieldLink ( const char *  fieldName,
NXOpen::Fields::Field fieldToLink 
)

Creates a NXOpen::Fields::FieldLink .

Returns
field
Created in NX6.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
fieldToLinkfield to link
NXOpen::Fields::FieldLinksTable* NXOpen::Fields::FieldManager::CreateFieldLinksTable ( const NXString fieldName,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray,
const std::vector< NXOpen::Fields::FieldVariable * > &  depVarArray,
const std::vector< double > &  datapoints,
const std::vector< NXOpen::Fields::Field * > &  linkFieldsArray 
)

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

Returns
links table field
Created in NX9.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
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.
NXOpen::Fields::FieldLinksTable* NXOpen::Fields::FieldManager::CreateFieldLinksTable ( const char *  fieldName,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray,
const std::vector< NXOpen::Fields::FieldVariable * > &  depVarArray,
const std::vector< double > &  datapoints,
const std::vector< NXOpen::Fields::Field * > &  linkFieldsArray 
)

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

Returns
links table field
Created in NX9.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
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.
NXOpen::Fields::FieldTable* NXOpen::Fields::FieldManager::CreateFieldTable ( const NXString fieldName,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray,
const std::vector< NXOpen::Fields::FieldVariable * > &  depVarArray,
const std::vector< double > &  datapoints 
)

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

Returns
field
Created in NX6.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
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.
NXOpen::Fields::FieldTable* NXOpen::Fields::FieldManager::CreateFieldTable ( const char *  fieldName,
const std::vector< NXOpen::Fields::FieldVariable * > &  indepVarArray,
const std::vector< NXOpen::Fields::FieldVariable * > &  depVarArray,
const std::vector< double > &  datapoints 
)

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

Returns
field
Created in NX6.0.0.

License requirements : None
Parameters
fieldNamefield name
NOTE: The full Unicode character set is not supported for this parameter.
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.
NXOpen::Fields::FieldTable* NXOpen::Fields::FieldManager::CreateFieldTableFromData ( const NXString fieldNamePrefix,
NXOpen::Unit ivarUnit,
NXOpen::Unit dvarUnit,
NXOpen::Fields::FieldVariable::ValueType  dvarType,
const std::vector< double > &  datapoints 
)

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.

Returns
field
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
NOTE: The full Unicode character set is not supported for this parameter.
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.
NXOpen::Fields::FieldTable* NXOpen::Fields::FieldManager::CreateFieldTableFromData ( const char *  fieldNamePrefix,
NXOpen::Unit ivarUnit,
NXOpen::Unit dvarUnit,
NXOpen::Fields::FieldVariable::ValueType  dvarType,
const std::vector< double > &  datapoints 
)

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.

Returns
field
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
NOTE: The full Unicode character set is not supported for this parameter.
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.
NXOpen::Fields::FieldWrapper* NXOpen::Fields::FieldManager::CreateFieldWrapper ( NXOpen::Fields::Field field)

Create a field wrapper backed up by a field.

Returns
scalar field wrapper created and associated to the field
Created in NX6.0.0.

License requirements : None
Parameters
fieldan existing field that will be this wrapper's value
NXOpen::Fields::ImportData* NXOpen::Fields::FieldManager::CreateImportData ( )

Creates a Fields.ImportData.

Returns
the import data created
Created in NX6.0.0.

License requirements : None
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 
)

Create an independent variable to be added to the field.

Returns
independent variable created and associated 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
NXOpen::Fields::PathObjects* NXOpen::Fields::FieldManager::CreatePathObjects ( )

Creates a NXOpen::Fields::PathObjects.

Returns

Created in NX6.0.1.

License requirements : None
NXOpen::Fields::ScalarFieldWrapper* NXOpen::Fields::FieldManager::CreateScalarFieldWrapperWithExpression ( NXOpen::Expression expression)

Create a field wrapper backed by a scalar expression.

Returns
scalar field wrapper created and associated to the expression
Created in NX6.0.0.

License requirements : None
Parameters
expressionan existing expression that will be this wrapper's value
NXOpen::Fields::ScalarFieldWrapper* NXOpen::Fields::FieldManager::CreateScalarFieldWrapperWithField ( NXOpen::Fields::Field field,
double  scaleFactor 
)

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

Returns
scalar field wrapper created and associated to the 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
NXOpen::Fields::SpatialMapBuilder* NXOpen::Fields::FieldManager::CreateSpatialMapBuilder ( NXOpen::Fields::SpatialMap spatialmap)

Creates a NXOpen::Fields::SpatialMapBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
spatialmapExisting SpatialMap to edit; NULL to create
NXOpen::Fields::FieldExpression* NXOpen::Fields::FieldManager::CreateSubFieldExpression ( NXOpen::Fields::FieldVariable depVar)

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 .

Returns
field
Created in NX6.0.0.

License requirements : None
Parameters
depVardependent variables to be associated with the field
NXOpen::Fields::VectorFieldWrapper* NXOpen::Fields::FieldManager::CreateVectorFieldWrapperWithExpressions ( const std::vector< NXOpen::Expression * > &  expressions)

Create a vector field wrapper backed by three scalar expressions.

Returns
scalar field wrapper created and associated to the expression
Created in NX6.0.0.

License requirements : None
Parameters
expressionsexisting expressions that will be this wrapper's value
NXOpen::Fields::VectorFieldWrapper* NXOpen::Fields::FieldManager::CreateVectorFieldWrapperWithField ( NXOpen::Fields::Field field,
const std::vector< double > &  scaleFactors 
)

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

Returns
vector field wrapper created and associated to the 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
NXOpen::Fields::Field* NXOpen::Fields::FieldManager::DeleteField ( NXOpen::Fields::Field field)

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

Returns
If the field cannot be deleted, it is returned; if the field is deleted, this will be NULL
Created in NX6.0.0.

License requirements : None
Parameters
fieldfield to delete
NXOpen::Fields::FieldDomainCollection* NXOpen::Fields::FieldManager::Domains ( )

Returns a collection of Units
Created in NX3.0.0.


void NXOpen::Fields::FieldManager::EditDependentVariable ( NXOpen::Fields::FieldVariable depVar,
const NXString varName,
NXOpen::Unit unitType 
)

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
NOTE: The full Unicode character set is not supported for this parameter.
unitTypenew unit of the dependent variable
void NXOpen::Fields::FieldManager::EditDependentVariable ( NXOpen::Fields::FieldVariable depVar,
const char *  varName,
NXOpen::Unit unitType 
)

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
NOTE: The full Unicode character set is not supported for this parameter.
unitTypenew unit of the dependent variable
void NXOpen::Fields::FieldManager::EditIndependentVariable ( NXOpen::Fields::FieldVariable indepVar,
const NXString 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.


Created in NX6.0.0.

License requirements : None

Parameters
indepVarindep var to edit
varNamename of the independent variable to be created
NOTE: The full Unicode character set is not supported for this parameter.
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
void NXOpen::Fields::FieldManager::EditIndependentVariable ( NXOpen::Fields::FieldVariable indepVar,
const char *  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.


Created in NX6.0.0.

License requirements : None

Parameters
indepVarindep var to edit
varNamename of the independent variable to be created
NOTE: The full Unicode character set is not supported for this parameter.
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
void NXOpen::Fields::FieldManager::ExportFields ( NXOpen::Fields::ExportData exportData)

Exports fields to a text file as defined by export_data parameter
Created in NX6.0.0.



License requirements : None

Parameters
exportDataExport data
NXOpen::Fields::NameVariable* NXOpen::Fields::FieldManager::GetNameVariable ( const NXString variableName,
const NXString measureName 
)

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

Returns
name variable with the specified measure and name
Created in NX6.0.2.

License requirements : None
Parameters
variableNamealphanumeric string; if it matches an existing name variable, the measures must also match
NOTE: The full Unicode character set is not supported for this parameter.
measureNamemust match an existing measure name, or "Unitless"
NOTE: The full Unicode character set is not supported for this parameter.
NXOpen::Fields::NameVariable* NXOpen::Fields::FieldManager::GetNameVariable ( const char *  variableName,
const char *  measureName 
)

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

Returns
name variable with the specified measure and name
Created in NX6.0.2.

License requirements : None
Parameters
variableNamealphanumeric string; if it matches an existing name variable, the measures must also match
NOTE: The full Unicode character set is not supported for this parameter.
measureNamemust match an existing measure name, or "Unitless"
NOTE: The full Unicode character set is not supported for this parameter.
int NXOpen::Fields::FieldManager::GetValidFieldId ( )

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

Returns
valid id
Created in NX9.0.0.

License requirements : None
void NXOpen::Fields::FieldManager::ImportFields ( NXOpen::Fields::ImportData importData)

Imports fields from a text file as defined by import_data parameter
Created in NX6.0.0.



License requirements : None

Parameters
importDataImport data

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