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

List of all members.

Public Member Functions

NXOpen::Fields::FieldVariableCreateDependentVariable (NXOpen::Fields::Field *ownerField, const NXString &varName, NXOpen::Unit *unitType)
 Create a dependent variable to be added to the field.
NXOpen::Fields::FieldVariableCreateDependentVariable (NXOpen::Fields::Field *ownerField, NXOpen::Fields::NameVariable *nameVariable, NXOpen::Unit *unitType)
 Create a dependent variable to be added to the field.
NXOpen::Fields::DisplayPropertiesBuilderCreateDisplayPropertiesBuilder (const std::vector< NXOpen::Fields::Field * > &fieldArray)
 Creates a Fields::DisplayPropertiesBuilder.
NXOpen::Fields::ExportDataCreateExportData ()
 Creates a Fields.ExportData.
NXOpen::Fields::FieldExpressionCreateFieldExpression (const NXString &fieldExpString, NXOpen::Unit *unitType)
 Creates a system Fields::FieldExpression object.
NXOpen::Fields::FieldExpressionCreateFieldExpression (const NXString &fieldExpString, NXOpen::Unit *unitType, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray)
 Creates a system Fields::FieldExpression object with independent variables.
NXOpen::Fields::FieldFormulaCreateFieldFormula (const NXString &fieldName, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldExpression * > &depExpArray)
 Creates a Fields::FieldFormula object with dependent Fields::FieldExpression .
NXOpen::Fields::FieldLinkCreateFieldLink (const NXString &fieldName, NXOpen::Fields::Field *fieldToLink)
 Creates a Fields::FieldLink .
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 Fields::FieldTable object with dependent and independent variables Fields::FieldVariable .
NXOpen::Fields::FieldTableCreateFieldTableFromData (const NXString &fieldNamePrefix, NXOpen::Unit *ivarUnit, NXOpen::Unit *dvarUnit, NXOpen::Fields::FieldVariable::ValueType dvarType, const std::vector< double > &datapoints)
 Creates a Fields::FieldTable object with dependent and independent variables Fields::FieldVariable .
NXOpen::Fields::FieldWrapperCreateFieldWrapper (NXOpen::Fields::Field *field)
 Create a field wrapper backed up by a field.
NXOpen::Fields::ImportDataCreateImportData ()
 Creates a Fields.ImportData.
NXOpen::Fields::FieldVariableCreateIndependentVariable (NXOpen::Fields::Field *ownerField, const NXString &varName, NXOpen::Unit *unitType, bool minValueSet, double minValue, bool maxValueSet, double maxValue, bool numPtsSet, int numPts, bool defaultValueSet, double defaultValue)
 Creates a system Fields::FieldVariable to be added to a field.
NXOpen::Fields::FieldVariableCreateIndependentVariable (NXOpen::Fields::Field *ownerField, 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)
 Create an independent variable to be added to the field.
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.
NXOpen::Fields::PathObjectsCreatePathObjects ()
 Creates a Fields::PathObjects.
NXOpen::Fields::ScalarFieldWrapperCreateScalarFieldWrapperWithExpression (NXOpen::Expression *expression)
 Create a field wrapper backed by a scalar expression.
NXOpen::Fields::ScalarFieldWrapperCreateScalarFieldWrapperWithField (NXOpen::Fields::Field *field, double scaleFactor)
 Create a scalar field wrapper backed up by a scaled scalar field.
NXOpen::Fields::SpatialMapBuilderCreateSpatialMapBuilder (NXOpen::Fields::SpatialMap *spatialmap)
 Creates a Fields::SpatialMapBuilder.
NXOpen::Fields::FieldExpressionCreateSubFieldExpression (NXOpen::Fields::FieldVariable *depVar)
 Creates a system Fields::FieldExpression object with independent variables.
NXOpen::Fields::VectorFieldWrapperCreateVectorFieldWrapperWithExpressions (const std::vector< NXOpen::Expression * > &expressions)
 Create a vector field wrapper backed by three scalar expressions.
NXOpen::Fields::VectorFieldWrapperCreateVectorFieldWrapperWithField (NXOpen::Fields::Field *field, const std::vector< double > &scaleFactors)
 Create a vector field wrapper backed up by a scaled vector field.
NXOpen::Fields::FieldDeleteField (NXOpen::Fields::Field *field)
 Deletes the specified Fields::Field object; if the object cannot be deleted it is returned.
NXOpen::Fields::FieldDomainCollectionDomains ()
 Returns a collection of Units
Created in NX3.0.0.
void EditDependentVariable (NXOpen::Fields::FieldVariable *depVar, const NXString &varName, NXOpen::Unit *unitType)
 Edit dependent variable.
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.
void ExportFields (NXOpen::Fields::ExportData *exportData)
 Exports fields to a text file as defined by export_data parameter
Created in NX6.0.0.
NXOpen::Fields::NameVariableGetNameVariable (const NXString &variableName, const NXString &measureName)
 Locate an existing, or create a new Fields::NameVariable object.
void ImportFields (NXOpen::Fields::ImportData *importData)
 Imports fields from a text file as defined by import_data parameter
Created in NX6.0.0.

Detailed Description

Represents the manager class of the Fields.


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

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


Created in NX4.0.0.


Member Function Documentation

Create a dependent variable to be added to the field.

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


Created in NX6.0.0.

License requirements : None

Parameters:
ownerFieldowner field
varNamename of the dependent variable to be created
NOTE: The full Unicode character set is not supported for this parameter.
unitTypeunit of the dependent variable

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

Creates a Fields::DisplayPropertiesBuilder.

Returns:

Created in NX6.0.1.

License requirements : None
Parameters:
fieldArrayfields to edit display properties

Creates a Fields.ExportData.

Returns:
the export data created
Created in NX6.0.0.

License requirements : None

Creates a system Fields::FieldExpression object.

Specifies the new expression string.
This method is deprecated; field expressions are children of Fields::FieldFormula and should not be created independently.

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 Fields::FieldExpression object with independent variables.

Specifies the new expression string.
This method is deprecated; field expressions are children of Fields::FieldFormula and should not be created independently.

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
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 Fields::FieldFormula object with dependent 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

Creates a 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::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 Fields::FieldTable object with dependent and independent variables 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 Fields::FieldTable object with dependent and independent variables 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.

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

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,
const NXString varName,
NXOpen::Unit unitType,
bool  minValueSet,
double  minValue,
bool  maxValueSet,
double  maxValue,
bool  numPtsSet,
int  numPts,
bool  defaultValueSet,
double  defaultValue 
)

Creates a system Fields::FieldVariable to be added to a field.

Returns:
independent variable created and associated to the field
Deprecated:
Deprecated in NX6.0.0.


Created in NX4.0.0.

License requirements : None

Parameters:
ownerFieldowner field
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
minValueminimum value of the variable range
maxValueSetlogical value whether maximum value set
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::FieldVariable* NXOpen::Fields::FieldManager::CreateIndependentVariable ( NXOpen::Fields::Field ownerField,
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 
)

Create an independent variable to be added to the field.

Returns:
independent variable created and associated to the field
Deprecated:
Deprecated in NX6.0.2.


Created in NX6.0.0.

License requirements : None

Parameters:
ownerFieldowner field
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
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

Creates a Fields::PathObjects.

Returns:

Created in NX6.0.1.

License requirements : None

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

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

Creates a Fields::SpatialMapBuilder.

Returns:

Created in NX6.0.0.

License requirements : None
Parameters:
spatialmapExisting SpatialMap to edit; NULL to create

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

Specifies the new expression string.
This method is used to create sub expression fields for a Fields::FieldFormula .

Returns:
field
Created in NX6.0.0.

License requirements : None
Parameters:
depVardependent variables to be associated with the field

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

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

Deletes the specified 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

Returns a collection of Units
Created in NX3.0.0.


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

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



License requirements : None

Parameters:
exportDataExport data

Locate an existing, or create a new 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.

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.