NXOpen::Fields::FieldLinksTable Class Reference

Represents the Field LinksTable class. More...

Inheritance diagram for NXOpen::Fields::FieldLinksTable:

Public Member Functions
bool	Discontinuities ()
	Returns a flag specifying if the table has discontinuites Created in NX9.0.0.
void	EditFieldLinksTable (const std::vector< NXOpen::Fields::FieldVariable * > &indepVarArray, const std::vector< NXOpen::Fields::FieldVariable * > &depVarArray, const std::vector< double > &datapoints, const std::vector< NXOpen::Fields::Field * > &linkFieldsArray)
	Edit the LinksTable field.
void	SetValuesOutsideTableInterpolation (NXOpen::Fields::FieldEvaluator::ValuesOutsideTableInterpolationEnum interpolationMethod)
	Sets the outside table values interpolation method for linear interpolation Created in NX9.0.0.
NXOpen::Fields::FieldEvaluator::ValuesOutsideTableInterpolationEnum	ValuesOutsideTableInterpolation ()
	Returns the outside table values interpolation method for linear interpolation Created in NX9.0.0.
Public Member Functions inherited from NXOpen::Fields::Field
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.
int	GetIdLabel ()
	Returns the ID/Label of the 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	Rename (const char *newName)
	Update the name of the field.
void	SetDescription (std::vector< NXString > &lines)
	Update the description of the field.
void	SetIdLabel (int idLabel)
	Update the ID/Label 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.
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.
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.
Public Member Functions inherited from NXOpen::DisplayableObject
void	Blank ()
	Blanks the object.
int	Color ()
	Returns the color of the object.
void	Highlight ()
	Highlights the object.
bool	IsBlanked ()
	Returns the blank status of this object.
int	Layer ()
	Returns the layer that the object is in.
NXOpen::DisplayableObject::ObjectFont	LineFont ()
	Returns the line font of the object.
NXOpen::DisplayableObject::ObjectWidth	LineWidth ()
	Returns the line width of the object.
NXOpen::Point3d	NameLocation ()
	Returns the location of the object's name.
void	RedisplayObject ()
	Redisplays the object in all views.
void	SetColor (int color)
	Sets the color of the object.
void	SetLayer (int layer)
	Sets the layer that the object is in.
void	SetLineFont (NXOpen::DisplayableObject::ObjectFont font)
	Sets the line font of the object.
void	SetLineWidth (NXOpen::DisplayableObject::ObjectWidth width)
	Sets the line width of the object.
void	SetNameLocation (const NXOpen::Point3d &location)
	Sets the location of the object's name.
void	Unblank ()
	Unblanks the object.
void	Unhighlight ()
	Unhighlights the object.
Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.
void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.
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.
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.
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 and Index.
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 and Index.
void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.
virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.
std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.
bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.
bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.
NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.
int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.
int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.
int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.
int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.
double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.
double	GetRealAttribute (const char *title)
	Gets a real attribute by title.
double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.
double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.
NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.
NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.
NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.
NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.
NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.
NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.
NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.
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.
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.
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.
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.
bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.
bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.
std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.
std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.
std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).
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 If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).
virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.
virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.
virtual NXString	Name ()
	Returns the custom name of the object.
virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.
virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.
virtual void	Print ()
	Prints a representation of this object to the system log file.
virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.
void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.
void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.
void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.
void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.
void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.
void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.
void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.
void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.
void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.
void	SetAttribute (const char *title, const char *value)
	Creates or modifies a string attribute.
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.
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.
void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.
void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.
void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.
void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.
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.
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.
virtual void	SetName (const NXString &name)
	Sets the custom name of the object.
void	SetName (const char *name)
	Sets the custom name of the object.
void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.
void	SetReferenceAttribute (const char *title, const char *value)
	Creates or modifies a string attribute which uses a reference string.
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.
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.
void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.
void	SetTimeAttribute (const char *title, const char *value)
	Creates or modifies a time attribute.
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.
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.
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.
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.
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.
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.
void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.
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.
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.
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.
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.
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.
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.
void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.
void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.
void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.
void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.
Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.
void	SetName (const char *name)
	Sets the custom name of the object.

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 the Field LinksTable class.

<br> A field (see @link Fields::Field Fields::Field@endlink ) defined in terms of tabular data involving 

one look-up independent column, an equal number of look-up fields and one or more dependent variables (see Fields::FieldVariable ). This is similar to a table (see Fields::FieldTable ), except instead of the interpolation dependent values being defined as numerical contants, they are defined by another field.

To obtain a instance of this class use Fields::FieldManager .

Created in NX9.0.0.

Member Function Documentation

bool NXOpen::Fields::FieldLinksTable::Discontinuities

(

)

Returns a flag specifying if the table has discontinuites
Created in NX9.0.0.

License requirements : None

void NXOpen::Fields::FieldLinksTable::EditFieldLinksTable	(	const std::vector< NXOpen::Fields::FieldVariable * > &	indepVarArray,
		const std::vector< NXOpen::Fields::FieldVariable * > &	depVarArray,
		const std::vector< double > &	datapoints,
		const std::vector< NXOpen::Fields::Field * > &	linkFieldsArray
	)

Edit the LinksTable field.

Specifies the new array of Fields::FieldVariable s for independent and dependent variables, as well as the new double values and linked fields. The datapoints and linked fields arrays are row based and number of each must equal the num_rows. The data_points array represents the values for the first independent value. For example, if the LinksTable has a domain of txyz, the values in this array are all values of t. The linked fields array must consist of the fields with independent variables representing the remaining variables in the independent domain of the LinksTable. For example, if the LinksTable has a domain of txyz, the independent domain of the fields in this array are all xyz. NULL values are allowed for linked fields and indicate a discontinuity at the associated value of the first independent variable. The dependent quantities are determined from the linked fields. The linked fields must have the same dependent variables as the Linkstable.

Created in NX9.0.0.

License requirements : None

Parameters

indepVarArray	independent variables to be associated with the field
depVarArray	dependent variables of this and all linked fields
datapoints	row based array of double values representing the first independent variable; the number of points should equal the number of rows.
linkFieldsArray	row based array of link field values representing the table; the number of fields should equal the number of rows.

void NXOpen::Fields::FieldLinksTable::SetValuesOutsideTableInterpolation

(

NXOpen::Fields::FieldEvaluator::ValuesOutsideTableInterpolationEnum

interpolationMethod

)

Sets the outside table values interpolation method for linear interpolation
Created in NX9.0.0.

License requirements : None

Parameters

interpolationMethod

the outside table values interpolation method

NXOpen::Fields::FieldEvaluator::ValuesOutsideTableInterpolationEnum NXOpen::Fields::FieldLinksTable::ValuesOutsideTableInterpolation

(

)

Returns the outside table values interpolation method for linear interpolation
Created in NX9.0.0.

License requirements : None

---

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

• Fields_FieldLinksTable.hxx