NX Open C++ Reference Guide
|
Represents the manager class of the Fields. More...
Public Member Functions | |
NXOpen::Fields::FieldVariable * | CreateDependentVariable (NXOpen::Fields::Field *ownerField, const NXString &varName, NXOpen::Unit *unitType) |
Create a dependent variable to be added to the field. | |
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. | |
NXOpen::Fields::DisplayPropertiesBuilder * | CreateDisplayPropertiesBuilder (const std::vector< NXOpen::Fields::Field * > &fieldArray) |
Creates a Fields::DisplayPropertiesBuilder. | |
NXOpen::Fields::ExportData * | CreateExportData () |
Creates a Fields.ExportData. | |
NXOpen::Fields::FieldExpression * | CreateFieldExpression (const NXString &fieldExpString, NXOpen::Unit *unitType) |
Creates a system Fields::FieldExpression object. | |
NXOpen::Fields::FieldExpression * | CreateFieldExpression (const NXString &fieldExpString, NXOpen::Unit *unitType, const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray) |
Creates a system Fields::FieldExpression object with independent variables. | |
NXOpen::Fields::FieldFormula * | 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 . | |
NXOpen::Fields::FieldLink * | CreateFieldLink (const NXString &fieldName, NXOpen::Fields::Field *fieldToLink) |
Creates a Fields::FieldLink . | |
NXOpen::Fields::FieldTable * | 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 . | |
NXOpen::Fields::FieldTable * | 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 . | |
NXOpen::Fields::FieldWrapper * | CreateFieldWrapper (NXOpen::Fields::Field *field) |
Create a field wrapper backed up by a field. | |
NXOpen::Fields::ImportData * | CreateImportData () |
Creates a Fields.ImportData. | |
NXOpen::Fields::FieldVariable * | 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. | |
NXOpen::Fields::FieldVariable * | 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. | |
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. | |
NXOpen::Fields::PathObjects * | CreatePathObjects () |
Creates a Fields::PathObjects. | |
NXOpen::Fields::ScalarFieldWrapper * | CreateScalarFieldWrapperWithExpression (NXOpen::Expression *expression) |
Create a field wrapper backed by a scalar expression. | |
NXOpen::Fields::ScalarFieldWrapper * | CreateScalarFieldWrapperWithField (NXOpen::Fields::Field *field, double scaleFactor) |
Create a scalar field wrapper backed up by a scaled scalar field. | |
NXOpen::Fields::SpatialMapBuilder * | CreateSpatialMapBuilder (NXOpen::Fields::SpatialMap *spatialmap) |
Creates a Fields::SpatialMapBuilder. | |
NXOpen::Fields::FieldExpression * | CreateSubFieldExpression (NXOpen::Fields::FieldVariable *depVar) |
Creates a system Fields::FieldExpression object with independent variables. | |
NXOpen::Fields::VectorFieldWrapper * | CreateVectorFieldWrapperWithExpressions (const std::vector< NXOpen::Expression * > &expressions) |
Create a vector field wrapper backed by three scalar expressions. | |
NXOpen::Fields::VectorFieldWrapper * | CreateVectorFieldWrapperWithField (NXOpen::Fields::Field *field, const std::vector< double > &scaleFactors) |
Create a vector field wrapper backed up by a scaled vector field. | |
NXOpen::Fields::Field * | DeleteField (NXOpen::Fields::Field *field) |
Deletes the specified Fields::Field object; if the object cannot be deleted it is returned. | |
NXOpen::Fields::FieldDomainCollection * | Domains () |
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::NameVariable * | GetNameVariable (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. |
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.
NXOpen::Fields::FieldVariable* NXOpen::Fields::FieldManager::CreateDependentVariable | ( | NXOpen::Fields::Field * | ownerField, |
const NXString & | varName, | ||
NXOpen::Unit * | unitType | ||
) |
Create a dependent variable to be added to the field.
Created in NX6.0.0.
License requirements : None
ownerField | owner field |
varName | name of the dependent variable to be created NOTE: The full Unicode character set is not supported for this parameter. |
unitType | unit of the dependent variable |
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.
ownerField | owner field |
nameVariable | existing name variable |
unitType | unit of the dependent variable |
NXOpen::Fields::DisplayPropertiesBuilder* NXOpen::Fields::FieldManager::CreateDisplayPropertiesBuilder | ( | const std::vector< NXOpen::Fields::Field * > & | fieldArray | ) |
Creates a Fields::DisplayPropertiesBuilder.
fieldArray | fields to edit display properties |
Creates a Fields.ExportData.
NXOpen::Fields::FieldExpression* NXOpen::Fields::FieldManager::CreateFieldExpression | ( | const NXString & | fieldExpString, |
NXOpen::Unit * | unitType | ||
) |
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.
fieldExpString | expression string to be associated with the field NOTE: The full Unicode character set is not supported for this parameter. |
unitType | unit 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.
fieldExpString | expression string to be associated with the field NOTE: The full Unicode character set is not supported for this parameter. |
unitType | unit of the field |
indepVarArray | independent 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 .
fieldName | field name NOTE: The full Unicode character set is not supported for this parameter. |
indepVarArray | independent variables to be associated with the field |
depExpArray | dependent 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 Fields::FieldLink .
fieldName | field name NOTE: The full Unicode character set is not supported for this parameter. |
fieldToLink | field 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 .
fieldName | field name NOTE: The full Unicode character set is not supported for this parameter. |
indepVarArray | independent variables to be associated with the table field |
depVarArray | dependent variables to be associated with the table field |
datapoints | row based array of double values representing the table; then number of points should equal the number of independent variables * the number of dependent variables * the number of rows. |
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.
fieldNamePrefix | field 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. |
ivarUnit | unit of the independent variable |
dvarUnit | unit of the dependent variable |
dvarType | dependent variable type (real/imaginary/complex...) |
datapoints | row based array of double values representing the table; then number of points should equal the number of independent variables * the number of dependent variables * the number of rows. |
NXOpen::Fields::FieldWrapper* NXOpen::Fields::FieldManager::CreateFieldWrapper | ( | NXOpen::Fields::Field * | field | ) |
Create a field wrapper backed up by a field.
field | an existing field that will be this wrapper's value |
Creates a Fields.ImportData.
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.
Created in NX4.0.0.
License requirements : None
ownerField | owner field |
varName | name of the independent variable to be created NOTE: The full Unicode character set is not supported for this parameter. |
unitType | unit of the independent variable |
minValueSet | logical value whether minimum value set |
minValue | minimum value of the variable range |
maxValueSet | logical value whether maximum value set |
maxValue | maximum value of the variable range |
numPtsSet | logical value whether num_pts set |
numPts | num_pts of the variable range |
defaultValueSet | logical value whether default value set |
defaultValue | default 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.
Created in NX6.0.0.
License requirements : None
ownerField | owner field |
varName | name of the independent variable to be created NOTE: The full Unicode character set is not supported for this parameter. |
unitType | unit of the independent variable |
minValueSet | logical value whether minimum value set |
minValueInclusive | minimum value is itself included in range |
minValue | minimum value of the variable range |
maxValueSet | logical value whether maximum value set |
maxValueInclusive | maximum value is itself included in range |
maxValue | maximum value of the variable range |
numPtsSet | logical value whether num_pts set |
numPts | num_pts of the variable range |
defaultValueSet | logical value whether default value set |
defaultValue | default 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.
ownerField | owner field |
nameVariable | existing name variable |
unitType | unit of the independent variable |
minValueSet | logical value whether minimum value set |
minValueInclusive | minimum value is itself included in range |
minValue | minimum value of the variable range |
maxValueSet | logical value whether maximum value set |
maxValueInclusive | maximum value is itself included in range |
maxValue | maximum value of the variable range |
numPtsSet | logical value whether num_pts set |
numPts | num_pts of the variable range |
defaultValueSet | logical value whether default value set |
defaultValue | default value of the variable range |
Creates a Fields::PathObjects.
NXOpen::Fields::ScalarFieldWrapper* NXOpen::Fields::FieldManager::CreateScalarFieldWrapperWithExpression | ( | NXOpen::Expression * | expression | ) |
Create a field wrapper backed by a scalar expression.
expression | an 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.
field | an existing field that will be this wrapper's value |
scaleFactor | the field will be multiplied by this scale factor when being evaluated |
NXOpen::Fields::SpatialMapBuilder* NXOpen::Fields::FieldManager::CreateSpatialMapBuilder | ( | NXOpen::Fields::SpatialMap * | spatialmap | ) |
Creates a Fields::SpatialMapBuilder.
spatialmap | Existing SpatialMap to edit; NULL to create |
NXOpen::Fields::FieldExpression* NXOpen::Fields::FieldManager::CreateSubFieldExpression | ( | NXOpen::Fields::FieldVariable * | depVar | ) |
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 .
depVar | dependent 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.
expressions | existing 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.
field | an existing field that will be this wrapper's value |
scaleFactors | the 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.
field | field to delete |
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
depVar | dep variable to edit |
varName | new name for variable, or NULL to skip updating name NOTE: The full Unicode character set is not supported for this parameter. |
unitType | new 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
indepVar | indep var to edit |
varName | name of the independent variable to be created NOTE: The full Unicode character set is not supported for this parameter. |
unitType | unit of the independent variable |
minValueSet | logical value whether minimum value set |
minValueInclusive | minimum value is itself included in range |
minValue | minimum value of the variable range |
maxValueSet | logical value whether maximum value set |
maxValueInclusive | maximum value is itself included in range |
maxValue | maximum value of the variable range |
numPtsSet | logical value whether num_pts set |
numPts | num_pts of the variable range |
defaultValueSet | logical value whether default value set |
defaultValue | default 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
exportData | Export data |
NXOpen::Fields::NameVariable* NXOpen::Fields::FieldManager::GetNameVariable | ( | const NXString & | variableName, |
const NXString & | measureName | ||
) |
Locate an existing, or create a new Fields::NameVariable object.
variableName | alphanumeric 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. |
measureName | must match an existing measure name, or "Unitless" NOTE: The full Unicode character set is not supported for this parameter. |
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
importData | Import data |