NX Open C++ Reference Guide
|
Represents an Field abstract class. More...
Public Member Functions | |
void | CopyAsTableToPart (NXOpen::BasePart *targetPart) |
Create a new table field from this field (regardless of type). | |
void | CopyToPart (NXOpen::BasePart *targetPart) |
Copy the field to the target part. | |
NXOpen::Fields::Field * | CreateCopyInPart (NXOpen::BasePart *targetPart) |
Copy the field to the target part. | |
NXOpen::Fields::FieldTable * | CreateTableInPart (NXOpen::BasePart *targetPart) |
Create a new table field from this field (regardless of type). | |
void | Delete () |
Delete this field; destroys the field and removes all references to it. | |
std::vector < NXOpen::Fields::FieldVariable * > | GetDependentVariables () |
Returns the dependent variables for this Fields::Field. | |
std::vector< NXString > | GetDescription () |
Returns the description of the field. | |
NXOpen::Fields::FieldEvaluator * | GetFieldEvaluator () |
Returns a field evaluator which can be used to evaluate this field. | |
std::vector < NXOpen::Fields::FieldVariable * > | GetIndependentVariables () |
Returns the independent variables for this Fields::Field. | |
NXOpen::Fields::SpatialMap * | GetSpatialMap () |
Returns the spatial map for the formula field if one exists. | |
bool | IsLocked () |
Returns a value that indicates whether this field is locked against edits. | |
bool | IsUserField () |
Returns a value that indicates whether this field is a user created/managed field. | |
void | Rename (const NXString &newName) |
Update the name of the field. | |
void | SetDescription (std::vector< NXString > &lines) |
Update the description of the field. | |
void | SetSpatialMap (NXOpen::Fields::SpatialMap *overrideMap) |
Set the spatial map for the formula field. | |
void | XYGraph (NXOpen::Fields::FieldVariable *indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, const std::vector< NXOpen::Fields::FieldVariable * > &constantIndepVarArray, const std::vector< double > &constantIndepVarValueArray) |
Creates displayed graphs of the Field's specified independent variable versus all the Field's dependent variables. |
Represents an Field abstract class.
Fields represent a way of defining a function for one or more dependent domains/variables (see Fields::FieldVariable ) based on relationships to one or more independent domains/variables (time, temperature, etc.).
Fields are a generic, reusable concept that crosses many areas of functionality. Defined properly, they provide an extendable concept that can service both simple and complicated needs, for example, modeling elements, properties, materials, boundary conditions in CAE/FEM applications.
Created in NX4.0.0.
void NXOpen::Fields::Field::CopyAsTableToPart | ( | NXOpen::BasePart * | targetPart | ) |
Create a new table field from this field (regardless of type).
Note that the table will be created have the N number of rows, where N is the product of the number of points for each independent variable, resulting in a grid (or lattice). The resulting field will be in the same part.
Created in NX6.0.0.
License requirements : None
targetPart | target part |
void NXOpen::Fields::Field::CopyToPart | ( | NXOpen::BasePart * | targetPart | ) |
Copy the field to the target part.
Created in NX6.0.0.
License requirements : None
targetPart | target part |
NXOpen::Fields::Field* NXOpen::Fields::Field::CreateCopyInPart | ( | NXOpen::BasePart * | targetPart | ) |
Copy the field to the target part.
targetPart | target part |
NXOpen::Fields::FieldTable* NXOpen::Fields::Field::CreateTableInPart | ( | NXOpen::BasePart * | targetPart | ) |
Create a new table field from this field (regardless of type).
Note that the table will be created have the N number of rows, where N is the product of the number of points for each independent variable, resulting in a grid (or lattice). The resulting field will be in the same part.
targetPart | target part |
void NXOpen::Fields::Field::Delete | ( | ) |
Delete this field; destroys the field and removes all references to it.
Created in NX6.0.0.
License requirements : None
std::vector<NXOpen::Fields::FieldVariable *> NXOpen::Fields::Field::GetDependentVariables | ( | ) |
Returns the dependent variables for this Fields::Field.
std::vector<NXString> NXOpen::Fields::Field::GetDescription | ( | ) |
Returns the description of the field.
Returns a field evaluator which can be used to evaluate this field.
std::vector<NXOpen::Fields::FieldVariable *> NXOpen::Fields::Field::GetIndependentVariables | ( | ) |
Returns the independent variables for this Fields::Field.
Returns the spatial map for the formula field if one exists.
bool NXOpen::Fields::Field::IsLocked | ( | ) |
Returns a value that indicates whether this field is locked against edits.
Created in NX7.5.2.
License requirements : None
bool NXOpen::Fields::Field::IsUserField | ( | ) |
Returns a value that indicates whether this field is a user created/managed field.
Many fields are created automatically by the system for internal uses. The life of these fields is managed by the objects that own them and so these fields are not consider user fields.
Created in NX7.5.2.
License requirements : None
void NXOpen::Fields::Field::Rename | ( | const NXString & | newName | ) |
Update the name of the field.
Created in NX6.0.0.
License requirements : None
newName | new field name NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Fields::Field::SetDescription | ( | std::vector< NXString > & | lines | ) |
Update the description of the field.
Created in NX6.0.1.
License requirements : None
lines | new description |
void NXOpen::Fields::Field::SetSpatialMap | ( | NXOpen::Fields::SpatialMap * | overrideMap | ) |
Set the spatial map for the formula field.
Created in NX6.0.0.
License requirements : None
overrideMap | spatial map to set |
void NXOpen::Fields::Field::XYGraph | ( | NXOpen::Fields::FieldVariable * | indepVar, |
double | abscissaMinimum, | ||
double | abscissaMaximum, | ||
int | abscissaPointCount, | ||
const std::vector< NXOpen::Fields::FieldVariable * > & | constantIndepVarArray, | ||
const std::vector< double > & | constantIndepVarValueArray | ||
) |
Creates displayed graphs of the Field's specified independent variable versus all the Field's dependent variables.
Created in NX6.0.0.
License requirements : None
indepVar | the specified independent variable for which to create the graph |
abscissaMinimum | the minimum bounds along the abscissa |
abscissaMaximum | the maximum bounds along the abscissa |
abscissaPointCount | the number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable |
constantIndepVarArray | independent variables to hold constant If the field has only 1 independent variable, this parameter is NULL |
constantIndepVarValueArray | independent variables constant values If the field has only 1 independent variable, this parameter is NULL |