NXOpen::Fields::Field Class Reference

Represents an Field abstract class. More...

Inheritance diagram for NXOpen::Fields::Field:

Public Member Functions
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::Field *	CreateCopyInPart (NXOpen::BasePart *targetPart)
	Copy the field to the target part. More...
NXOpen::Fields::FieldTable *	CreateTableInPart (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< NXString >	GetDescription ()
	Returns the description of the field. More...
NXOpen::Fields::FieldEvaluator *	GetFieldEvaluator ()
	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::SpatialMap *	GetSpatialMap ()
	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...
Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object. More...
int	Color ()
	Returns the color of the object. More...
void	Highlight ()
	Highlights the object. More...
bool	IsBlanked ()
	Returns the blank status of this object. More...
int	Layer ()
	Returns the layer that the object is in. More...
NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object. More...
NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object. More...
NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name. More...
void	RedisplayObject ()
	Redisplays the object in all views. More...
void	RemoveViewDependency ()
	Remove dependency on all views from an object. More...
void	SetColor (int color)
	Sets the color of the object. More...
void	SetLayer (int layer)
	Sets the layer that the object is in. More...
void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object. More...
void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object. More...
void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name. More...
void	Unblank ()
	Unblanks the object. More...
void	Unhighlight ()
	Unhighlights the object. More...
Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type. More...
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not. More...
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...
void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title. More...
void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...
virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
virtual NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type. More...
bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index. More...
bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index. More...
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...
int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title. More...
int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title. More...
int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index. More...
int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index. More...
double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title. More...
double	GetRealAttribute (const char *title)
	Gets a real attribute by title. More...
double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index. More...
double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index. More...
NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...
NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title. More...
NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title. More...
NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index. More...
NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index. More...
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title. More...
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title. More...
NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index. More...
NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index. More...
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...
NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...
int	GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...
bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...
bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...
std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...
int	GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
int	GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...
std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...
bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...
virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not. More...
virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object. More...
virtual NXString	Name ()
	Returns the custom name of the object. More...
virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence. More...
virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0. More...
virtual void	Print ()
	Prints a representation of this object to the system log file. More...
virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence. More...
void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute. More...
void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute. More...
void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute. More...
void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute. More...
void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute. More...
void	SetAttribute (const char *title, const char *value)
	Creates or modifies a string attribute. More...
void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...
void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...
void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...
void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...
virtual void	SetName (const NXString &name)
	Sets the custom name of the object. More...
virtual void	SetName (const char *name)
	Sets the custom name of the object. More...
void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string. More...
void	SetReferenceAttribute (const char *title, const char *value)
	Creates or modifies a string attribute which uses a reference string. More...
void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
void	SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...
void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute. More...
void	SetTimeAttribute (const char *title, const char *value)
	Creates or modifies a time attribute. More...
void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not. More...
void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not. More...
void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not. More...
void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...
void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

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...

Detailed Description

Represents an Field abstract class.

Fields represent a way of defining a function for one or more dependent domains/variables (see NXOpen::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

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.

Deprecated:

Deprecated in NX6.0.1. Use NXOpen::Fields::Field::CreateTableInPart instead.

Created in NX6.0.0.

License requirements : None

Parameters

targetPart

target part

void NXOpen::Fields::Field::CopyToPart

(

NXOpen::BasePart *

targetPart

)

Copy the field to the target part.

Deprecated:

Deprecated in NX6.0.1. Use NXOpen::Fields::Field::CreateCopyInPart instead.

Created in NX6.0.0.

License requirements : None

Parameters

targetPart

target part

NXOpen::Fields::Field* NXOpen::Fields::Field::CreateCopyInPart

(

NXOpen::BasePart *

targetPart

)

Copy the field to the target part.

Returns

newly created field
Created in NX6.0.1.

License requirements : None

Parameters

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.

Returns

newly created table
Created in NX6.0.1.

License requirements : None

Parameters

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 NXOpen::Fields::Field.

Returns

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

License requirements : None

std::vector<NXString> NXOpen::Fields::Field::GetDescription

(

)

Returns the description of the field.

Returns

description
Created in NX7.5.2.

License requirements : None

NXOpen::Fields::FieldEvaluator* NXOpen::Fields::Field::GetFieldEvaluator

(

)

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

Returns

Field Evaluator
Created in NX7.5.2.

License requirements : None

int NXOpen::Fields::Field::GetIdLabel

(

)

Returns the ID/Label of the field.

Returns

ID/Label
Created in NX9.0.0.

License requirements : None

std::vector<NXOpen::Fields::FieldVariable *> NXOpen::Fields::Field::GetIndependentVariables

(

)

Returns the independent variables for this NXOpen::Fields::Field.

Returns

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

License requirements : None

NXOpen::Fields::SpatialMap* NXOpen::Fields::Field::GetSpatialMap

(

)

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

Returns

spatial map
Created in NX7.5.2.

License requirements : None

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

Parameters

newName

new field name NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Fields::Field::Rename

(

const char *

newName

)

Update the name of the field.

Created in NX6.0.0.

License requirements : None

Parameters

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

Parameters

lines

new description

void NXOpen::Fields::Field::SetIdLabel

(

int

idLabel

)

Update the ID/Label of the field.

Created in NX9.0.0.

License requirements : None

Parameters

idLabel

ID/Label

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

Parameters

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

Parameters

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

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,
		int	viewIndex,
		bool	overlay
	)

Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables.

Created in NX8.5.0.

License requirements : None

Parameters

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
viewIndex	0 thru 8, viewport number to place the graph in
overlay	create a new plot or add to existing

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,
		int	windowDevice,
		int	viewIndex,
		bool	overlay
	)

Plots or overlays graphs of the Field's specified independent variable versus all the Field's dependent variables.

Created in NX9.0.0.

License requirements : None

Parameters

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
windowDevice	great than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex	0 thru 8, viewport number to place the graph in
overlay	create a new plot or add to existing

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,
		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).

Created in NX9.0.1.

License requirements : None

Parameters

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
windowDevice	great than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex	0 thru 8, viewport number to place the graph in
overlay	create a new plot or add to existing
plots	Created plot(s)

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,
		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).

Created in NX10.0.0.

License requirements : None

Parameters

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
windowDevice	great than 0. the index of display device to show the graph. 1 represents main graphic window
viewIndex	0 thru 8, viewport number to place the graph in
overlay	create a new plot or add to existing
scaleFactor	scale dependent variable(s)
plots	Created plot(s)

---

The documentation for this class was generated from the following file:

• Fields_Field.hxx