NX Open C++ Reference Guide
Public Member Functions
NXOpen::Fields::Field Class Reference

Represents an Field abstract class. More...

Inheritance diagram for NXOpen::Fields::Field:
NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Fields::FieldExpression NXOpen::Fields::FieldFormula NXOpen::Fields::FieldLink NXOpen::Fields::FieldTable

List of all members.

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::FieldCreateCopyInPart (NXOpen::BasePart *targetPart)
 Copy the field to the target part.
NXOpen::Fields::FieldTableCreateTableInPart (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< NXStringGetDescription ()
 Returns the description of the field.
NXOpen::Fields::FieldEvaluatorGetFieldEvaluator ()
 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::SpatialMapGetSpatialMap ()
 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.

Detailed Description

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.


Member Function Documentation

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.


Deprecated:
Deprecated in NX6.0.1.


Created in NX6.0.0.

License requirements : None

Parameters:
targetParttarget part

Copy the field to the target part.


Deprecated:
Deprecated in NX6.0.1.


Created in NX6.0.0.

License requirements : None

Parameters:
targetParttarget part

Copy the field to the target part.

Returns:
newly created field
Created in NX6.0.1.

License requirements : None
Parameters:
targetParttarget part

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.

Returns:
newly created table
Created in NX6.0.1.

License requirements : None
Parameters:
targetParttarget part

Delete this field; destroys the field and removes all references to it.


Created in NX6.0.0.

License requirements : None

Returns the dependent variables for this Fields::Field.

Returns:
dependent variables for this Fields::FieldVariable
Created in NX7.5.2.

License requirements : None

Returns the description of the field.

Returns:
description
Created in NX7.5.2.

License requirements : None

Returns a field evaluator which can be used to evaluate this field.

Returns:
Field Evaluator
Created in NX7.5.2.

License requirements : None

Returns the independent variables for this Fields::Field.

Returns:
independent variables for this Fields::FieldVariable
Created in NX7.5.2.

License requirements : None

Returns the spatial map for the formula field if one exists.

Returns:
spatial map
Created in NX7.5.2.

License requirements : None

Returns a value that indicates whether this field is locked against edits.


Created in NX7.5.2.

License requirements : None

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

Parameters:
newNamenew 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

Parameters:
linesnew description

Set the spatial map for the formula field.


Created in NX6.0.0.

License requirements : None

Parameters:
overrideMapspatial 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

Parameters:
indepVarthe specified independent variable for which to create the graph
abscissaMinimumthe minimum bounds along the abscissa
abscissaMaximumthe maximum bounds along the abscissa
abscissaPointCountthe number of points to graph along the abscissa. the number of times to evaluate the graphed independent variable
constantIndepVarArrayindependent variables to hold constant If the field has only 1 independent variable, this parameter is NULL
constantIndepVarValueArrayindependent variables constant values If the field has only 1 independent variable, this parameter is NULL

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