NX Open C++ Reference Guide
List of all members
NXOpen::Fields::FieldReference Class Reference

Represents an reference field. More...

Inheritance diagram for NXOpen::Fields::FieldReference:
NXOpen::Fields::Field NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

Additional Inherited Members

- Public Types inherited from NXOpen::DisplayableObject
enum  ObjectFont {
  ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline,
  ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed
}
 specifies the object font for objects such as lines
Created in NX3.0.0. More...
 
enum  ObjectWidth {
  ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5,
  ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive,
  ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine
}
 specifies object width for objects such as lines and text
Created in NX3.0.0. More...
 
- Public Member Functions inherited from NXOpen::Fields::Field
void CopyAsTableToPart (NXOpen::BasePart *targetPart)
 Create a new table field from this field (regardless of type). More...
 
void CopyToPart (NXOpen::BasePart *targetPart)
 Copy the field to the target part. More...
 
NXOpen::Fields::FieldCreateCopyInPart (NXOpen::BasePart *targetPart)
 Copy the field to the target part. More...
 
NXOpen::Fields::FieldTableCreateTableInPart (NXOpen::BasePart *targetPart)
 Create a new table field from this field (regardless of type). More...
 
void Delete ()
 Delete this field; destroys the field and removes all references to it. More...
 
std::vector
< NXOpen::Fields::FieldVariable * > 
GetDependentVariables ()
 Returns the dependent variables for this NXOpen::Fields::Field. More...
 
std::vector< NXStringGetDescription ()
 Returns the description of the field. More...
 
NXOpen::Fields::FieldEvaluatorGetFieldEvaluator ()
 Returns a field evaluator which can be used to evaluate this field. More...
 
int GetIdLabel ()
 Returns the ID/Label of the field. More...
 
std::vector
< NXOpen::Fields::FieldVariable * > 
GetIndependentVariables ()
 Returns the independent variables for this NXOpen::Fields::Field. More...
 
NXOpen::Fields::SpatialMapGetSpatialMap ()
 Returns the spatial map for the formula field if one exists. More...
 
bool IsLocked ()
 Returns a value that indicates whether this field is locked against edits. More...
 
bool IsUserField ()
 Returns a value that indicates whether this field is a user created/managed field. More...
 
void Rename (const NXString &newName)
 Update the name of the field. More...
 
void Rename (const char *newName)
 Update the name of the field. More...
 
void SetDescription (std::vector< NXString > &lines)
 Update the description of the field. More...
 
void SetIdLabel (int idLabel)
 Update the ID/Label of the field. More...
 
void SetSpatialMap (NXOpen::Fields::SpatialMap *overrideMap)
 Set the spatial map for the formula field. More...
 
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. More...
 
void XYGraph (NXOpen::Fields::FieldVariable *indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, const std::vector< NXOpen::Fields::FieldVariable * > &constantIndepVarArray, const std::vector< double > &constantIndepVarValueArray, int viewIndex, bool overlay)
 Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables. More...
 
void XYGraph (NXOpen::Fields::FieldVariable *indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, const std::vector< NXOpen::Fields::FieldVariable * > &constantIndepVarArray, const std::vector< double > &constantIndepVarValueArray, int windowDevice, int viewIndex, bool overlay)
 Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables. More...
 
void XYGraph (NXOpen::Fields::FieldVariable *indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, const std::vector< NXOpen::Fields::FieldVariable * > &constantIndepVarArray, const std::vector< double > &constantIndepVarValueArray, int windowDevice, int viewIndex, bool overlay, std::vector< NXOpen::CAE::Xyplot::Plot * > &plots)
 Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables; returns newly created plot object(s). More...
 
void XYGraph (NXOpen::Fields::FieldVariable *indepVar, double abscissaMinimum, double abscissaMaximum, int abscissaPointCount, const std::vector< NXOpen::Fields::FieldVariable * > &constantIndepVarArray, const std::vector< double > &constantIndepVarValueArray, int windowDevice, int viewIndex, bool overlay, double scaleFactor, std::vector< NXOpen::CAE::Xyplot::Plot * > &plots)
 Plots or overlays graphs of the Field's specified independent variable versus all the Field's scaled dependent variables; returns newly created plot object(s). More...
 

Detailed Description

Represents an reference field.


A Reference Field exposes data inside of an abstract data store. An abstract data store is provided by an appropriate application data provider, and allows access to the provider data as a Fields::Field

To obtain a instance of this class use an appropriate application data provider.

Created in NX9.0.0.


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