A base class providing low-level services for most NXOpen classes. More...

Inheritance diagram for NXOpen::NXObject:

Classes
struct	AttributeInformation
	Contains attribute information. More...

struct	ComputationalTime
	Holds the computational time value of a time attribute. More...

Public Types
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
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.

Detailed Description

A base class providing low-level services for most NXOpen classes.

<br> For more information on NX rules for Names and Attributes, see

the Properties section of the Gateway Help.

This is an abstract class, and cannot be instantiated.

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::NXObject::AttributeType

Specifies attribute type.

NOTE: Attributes of type reference are also string attributes. The reference type as such is deprecated.

Enumerator:

AttributeTypeInvalid	Invalid.
AttributeTypeNull	Null.
AttributeTypeBoolean	Boolean.
AttributeTypeInteger	Integer.
AttributeTypeReal	Real.
AttributeTypeString	String.
AttributeTypeTime	Time and Date.
AttributeTypeReference	Deprecated. Do not use in new code. Previously used to denote string attributes holding a ReferenceValue

enum NXOpen::NXObject::DateAndTimeFormat

Specifies the format of the date and time attribute.

Enumerator:

DateAndTimeFormatNumeric	2004/04/28 22:06:15
DateAndTimeFormatTextual	28-Apr-2004 22:06:15

Member Function Documentation

void NXOpen::NXObject::DeleteAllAttributesByType ( NXOpen::NXObject::AttributeType type )

Deletes all attributes of a specific type.

This method performs an immediate update except when the object is a Features::Feature . If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type non-array attributes that have a reference value. The reference type is used only to single out string type non-array attributes that contain a reference value. The use of reference type in this function is deprecated. Please use string type instead.

Deprecated:: Deprecated in NX8.0.0. Use DeleteUserAttributes instead.

Created in NX3.0.0.

License requirements : None

Parameters

type type

void NXOpen::NXObject::DeleteAllAttributesByType	(	NXOpen::NXObject::AttributeType	type,
		NXOpen::Update::Option	option
	)

Deletes all attributes of a specific type with the option to update or not.

   If a candidate attribute is an array attribute, this method will delete all the array elements. 
   NOTE: If the input specifies reference type, then this function will delete
         string type non-array attributes that have a reference value. The reference type is used only
         to single out string type non-array attributes that contain a reference value. 
         The use of reference type in this function is deprecated. Please use string type instead.

Deprecated:: Deprecated in NX8.0.0. Use DeleteUserAttributes instead.

Created in NX5.0.1.

License requirements : None

Parameters

type	type
option	option

void NXOpen::NXObject::DeleteAttributeByTypeAndTitle	(	NXOpen::NXObject::AttributeType	type,
		const NXString &	title
	)

Deletes an attribute by type and title.

This method performs an immediate update except when the object is a Features::Feature . If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is discouraged.

Deprecated:: Deprecated in NX8.0.0. Use DeleteUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

type	type
title	title

void NXOpen::NXObject::DeleteAttributeByTypeAndTitle	(	NXOpen::NXObject::AttributeType	type,
		const char *	title
	)

Deletes an attribute by type and title.

This method performs an immediate update except when the object is a Features::Feature . If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is discouraged.

Deprecated:: Deprecated in NX8.0.0. Use DeleteUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

type	type
title	title

void NXOpen::NXObject::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.

   If a candidate attribute is an array attribute, this method will delete all the array elements. 
   NOTE: If the input specifies reference type, then this function will delete
         string type attributes that have a reference value. The reference type is used only
         to single out string type attributes that contain a reference value. 
         The use of reference type in this function is discouraged.

Deprecated:: Deprecated in NX8.0.0. Use DeleteUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

type	type
title	title
option	option

void NXOpen::NXObject::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.

   If a candidate attribute is an array attribute, this method will delete all the array elements. 
   NOTE: If the input specifies reference type, then this function will delete
         string type attributes that have a reference value. The reference type is used only
         to single out string type attributes that contain a reference value. 
         The use of reference type in this function is discouraged.

Deprecated:: Deprecated in NX8.0.0. Use DeleteUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

type	type
title	title
option	option

void NXOpen::NXObject::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.

   If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored,
   otherwise the last element of the array is deleted.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .

Created in NX8.0.0.

License requirements : None

Parameters

type	type
title	title
deleteEntireArray	delete entire array
option	option

void NXOpen::NXObject::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.

   If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored,
   otherwise the last element of the array is deleted.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .

Created in NX8.0.0.

License requirements : None

Parameters

type	type
title	title
deleteEntireArray	delete entire array
option	option

void NXOpen::NXObject::DeleteUserAttributes	(	NXOpen::NXObject::AttributeType	type,
		NXOpen::Update::Option	option
	)

Deletes the attributes encountered with the given Type with option to update or not.

   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .

Created in NX8.0.0.

License requirements : None

Parameters

type	type
option	option

virtual NXOpen::INXObject* NXOpen::NXObject::FindObject ( const NXString & journalIdentifier )

virtual

Finds the NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Journal identifier of the object

Implements NXOpen::INXObject.

NXOpen::INXObject* NXOpen::NXObject::FindObject ( const char * journalIdentifier )

Finds the NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Journal identifier of the object

std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetAttributeTitlesByType ( NXOpen::NXObject::AttributeType type )

Gets all the attribute titles of a specific type.

   Only Title and Type are set in the returned struct. No values are returned.
   Array attributes are supported. The Title returned is the array title, with no index appended. Only one title is returned per array.
   This function does not return the titles of unset attributes.
   NOTE: If the input specifies reference type, then this function will get
         string type attributes that have a reference value. The reference type is used only
         to single out string type attributes that contain a reference value. 
         The use of reference type in this function is deprecated. Please use string type instead.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttributes instead.

Created in NX3.0.0.

License requirements : None

Parameters

type type

bool NXOpen::NXObject::GetBooleanUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a boolean attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

bool NXOpen::NXObject::GetBooleanUserAttribute	(	const char *	title,
		int	index
	)

Gets a boolean attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXOpen::NXObject::ComputationalTime NXOpen::NXObject::GetComputationalTimeUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a time attribute by Title and array Index.

   The time value returned will be in the current time zone of the machine running the program. 
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return  The time in the local time zone

Created in NX8.5.2.

License requirements : None

Parameters

title	title
index	index

NXOpen::NXObject::ComputationalTime NXOpen::NXObject::GetComputationalTimeUserAttribute	(	const char *	title,
		int	index
	)

Gets a time attribute by Title and array Index.

   The time value returned will be in the current time zone of the machine running the program. 
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return  The time in the local time zone

Created in NX8.5.2.

License requirements : None

Parameters

title	title
index	index

int NXOpen::NXObject::GetIntegerAttribute ( const NXString & title )

Gets an integer attribute by title.

   This method does not support array attributes.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

int NXOpen::NXObject::GetIntegerAttribute ( const char * title )

Gets an integer attribute by title.

   This method does not support array attributes.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

int NXOpen::NXObject::GetIntegerUserAttribute	(	const NXString &	title,
		int	index
	)

Gets an integer attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

int NXOpen::NXObject::GetIntegerUserAttribute	(	const char *	title,
		int	index
	)

Gets an integer attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

double NXOpen::NXObject::GetRealAttribute ( const NXString & title )

Gets a real attribute by title.

   This method does not support array attributes.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

double NXOpen::NXObject::GetRealAttribute ( const char * title )

Gets a real attribute by title.

   This method does not support array attributes.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

double NXOpen::NXObject::GetRealUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a real attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

double NXOpen::NXObject::GetRealUserAttribute	(	const char *	title,
		int	index
	)

Gets a real attribute by Title and array Index.

   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::NXObject::GetReferenceAttribute ( const NXString & title )

Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

Get the attribute by title. For the calculated value, please use NXObject::GetUserAttribute This method does not support array attributes.

Returns

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

NXString NXOpen::NXObject::GetReferenceAttribute ( const char * title )

Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

Get the attribute by title. For the calculated value, please use NXObject::GetUserAttribute This method does not support array attributes.

Returns

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

NXString NXOpen::NXObject::GetStringAttribute ( const NXString & title )

Gets a string attribute value by title.

   For string attributes that use reference strings, this function returns the calculated value, not the reference string. 
   This method does not support array attributes.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

NXString NXOpen::NXObject::GetStringAttribute ( const char * title )

Gets a string attribute value by title.

   For string attributes that use reference strings, this function returns the calculated value, not the reference string. 
   This method does not support array attributes.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

NXString NXOpen::NXObject::GetStringUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a string attribute by Title and array Index.

   For reference type string attributes, the calculated StringValue is returned.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink . @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::NXObject::GetStringUserAttribute	(	const char *	title,
		int	index
	)

Gets a string attribute by Title and array Index.

   For reference type string attributes, the calculated StringValue is returned.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink . @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::NXObject::GetTimeAttribute	(	NXOpen::NXObject::DateAndTimeFormat	format,
		const NXString &	title
	)

Gets a time attribute by title.

   The time returned will be in the current time zone of the machine running the program. 
   This method does not support array attributes.
   This method is deprecated.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

format	format
title	title

NXString NXOpen::NXObject::GetTimeAttribute	(	NXOpen::NXObject::DateAndTimeFormat	format,
		const char *	title
	)

Gets a time attribute by title.

   The time returned will be in the current time zone of the machine running the program. 
   This method does not support array attributes.
   This method is deprecated.  @return

Deprecated:: Deprecated in NX8.0.0. Use GetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

format	format
title	title

NXString NXOpen::NXObject::GetTimeUserAttribute	(	const NXString &	title,
		int	index
	)

Gets a time attribute by Title and array Index.

   The date format set by the Customer Defaults is used.
   The time value returned is in the current time zone of the machine running the program. 
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   NOTE: The returned string must be deleted by the caller  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXString NXOpen::NXObject::GetTimeUserAttribute	(	const char *	title,
		int	index
	)

Gets a time attribute by Title and array Index.

   The date format set by the Customer Defaults is used.
   The time value returned is in the current time zone of the machine running the program. 
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   NOTE: The returned string must be deleted by the caller  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index

NXOpen::NXObject::AttributeInformation NXOpen::NXObject::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.

   For non-string attribute types, the string-converted value is returned as well for convenience.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

NXOpen::NXObject::AttributeInformation NXOpen::NXObject::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.

   For non-string attribute types, the string-converted value is returned as well for convenience.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

NXString NXOpen::NXObject::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.

   The value of the attribute is converted to and returned as a string.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, the calculated StringValue is returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

NXString NXOpen::NXObject::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.

   The value of the attribute is converted to and returned as a string.
   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).
   The first element of an array has Index 0 (zero).
   To get all the array elements of an array, please use @link NXObject::GetUserAttributes NXObject::GetUserAttributes@endlink .
   The date format set by the Customer Defaults is used for attributes of type time.
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .
         For reference type string attributes, the calculated StringValue is returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

bool NXOpen::NXObject::GetUserAttributeLock	(	const NXString &	title,
		NXOpen::NXObject::AttributeType	type
	)

Determine the lock of the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

bool NXOpen::NXObject::GetUserAttributeLock	(	const char *	title,
		NXOpen::NXObject::AttributeType	type
	)

Determine the lock of the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type

std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetUserAttributes ( )

Gets all the attributes that have been set on the given object.

   The elements of array attributes are returned individually in order of increasing indices. 
   The returned Title of an array element is the array title (without index). The Index data member holds the index.
   The date format set by the Customer Defaults is used.
   Reference type attributes are returned as being of type @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink ,
   and both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetUserAttributes ( bool includeUnset )

Gets all the attributes that have been set on the given object.

   Includes option to return information also from attribute templates that have not been set.
   The values returned for unset attributes are the default values from the templates.
   The elements of array attributes are returned individually in order of increasing indices. 
   The returned Title of an array element is the array title (without index). The Index data member holds the index.
   The date format set by the Customer Defaults is used.
   Reference type attributes are returnes as being of type @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink ,
   and both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.0.0.

License requirements : None

Parameters

includeUnset includeunset

std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetUserAttributes	(	bool	includeUnset,
		bool	addStringValues
	)

Gets all the attributes that have been set on the given object.

   Includes an option to return information also from attribute templates that have not been set.
   The values returned for unset attributes are the default values from the templates.
   Includes an option to return the value not only in the natural type, but also converted to a string (effective only for non-string attributes).
   The elements of array attributes are returned individually in order of increasing indices. 
   The returned Title of an array element is the array title (without index). The Index data member holds the index.
   The date format set by the Customer Defaults is used.
   Reference type attributes are returned as being of type @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink ,
   and both the ReferenceValue and the calculated StringValue are returned.  @return

Created in NX8.5.0.

License requirements : None

Parameters

includeUnset	includeunset
addStringValues	addstringvalues

std::vector<NXString> NXOpen::NXObject::GetUserAttributesAsStrings ( )

Gets all the attributes that have been set on the given object.

   The values are returned as strings.
   The elements of array attributes are returned individually in order of increasing indices. 
   The returned Title of an array element is the array title (without index). The Index data member holds the index.
   Reference type attributes return the calculated StringValue.
   The date format set by the Customer Defaults is used.  @return

Deprecated:: Deprecated in NX8.5.0. Use GetUserAttributes instead.

Created in NX8.0.0.

License requirements : None

std::vector<NXOpen::NXObject *> NXOpen::NXObject::GetUserAttributeSourceObjects ( )

Returns an array of objects from which this object presents attributes.

  The order of the array is in inheritance order so earlier objects may be able to override objects at 
  higher indices in the array allowing for the rules set up for the particular attributes involved. 
  If this object itself can own attributes it will also be in the array.
@return

Created in NX8.5.0.

License requirements : None

bool NXOpen::NXObject::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).

   The first element of an array has Index 0 (zero).
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

bool NXOpen::NXObject::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).

   The first element of an array has Index 0 (zero).
   NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
         Instead, use @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink .  @return

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
index	index

virtual bool NXOpen::NXObject::IsOccurrence ( )

virtual

Returns whether this object is an occurrence or not.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXString NXOpen::NXObject::JournalIdentifier ( )

virtual

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.
Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXString NXOpen::NXObject::Name ( )

virtual

Returns the custom name of the object.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

Reimplemented in NXOpen::CoordinateSystem, NXOpen::CAE::Optimization::DAOSolution, NXOpen::Validate::ResultObject, NXOpen::CAE::LaminateGlobalLayup, NXOpen::PartFamily::FamilyAttribute, NXOpen::CAM::CAMFeature, NXOpen::CAE::LaminateLayupOffset, NXOpen::CAE::LaminateMatOrientation, NXOpen::CAE::PreTestSolution, NXOpen::CAE::LaminatePlyGroup, NXOpen::CAM::FeatureGeometryGroup, NXOpen::CAE::LaminatePostReport, NXOpen::CAM::CAMAttribute, NXOpen::CAE::PreTestSensorConfig, NXOpen::CAE::PreTestExciterConfig, NXOpen::Unit, and NXOpen::Fields::NameVariable.

virtual NXOpen::Assemblies::Component* NXOpen::NXObject::OwningComponent ( )

virtual

Returns the owning component, if this object is an occurrence.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXOpen::BasePart* NXOpen::NXObject::OwningPart ( )

virtual

Returns the owning part of this object
Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual void NXOpen::NXObject::Print ( )

virtual

Prints a representation of this object to the system log file.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXOpen::INXObject* NXOpen::NXObject::Prototype ( )

virtual

Returns the prototype of this object if it is an occurrence.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

void NXOpen::NXObject::SetAttribute	(	const NXString &	title,
		int	value
	)

Creates or modifies an integer attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::SetAttribute	(	const char *	title,
		int	value
	)

Creates or modifies an integer attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::SetAttribute	(	const NXString &	title,
		int	value,
		NXOpen::Update::Option	option
	)

Creates or modifies an integer attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::SetAttribute	(	const char *	title,
		int	value,
		NXOpen::Update::Option	option
	)

Creates or modifies an integer attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::SetAttribute	(	const NXString &	title,
		double	value
	)

Creates or modifies a real attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::SetAttribute	(	const char *	title,
		double	value
	)

Creates or modifies a real attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::SetAttribute	(	const NXString &	title,
		double	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a real attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::SetAttribute	(	const char *	title,
		double	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a real attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::SetAttribute	(	const NXString &	title,
		const NXString &	value
	)

Creates or modifies a string attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::SetAttribute	(	const char *	title,
		const char *	value
	)

Creates or modifies a string attribute.

This method performs an immediate update except when the object is a Features::Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::SetAttribute	(	const NXString &	title,
		const NXString &	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a string attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::SetAttribute	(	const char *	title,
		const char *	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a string attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::SetAttribute ( const NXString & title )

Creates or modifies a null attribute which is an attribute with a title and no value.

   This method performs an immediate update except when the object is a 
   @link Features::Feature Features::Feature@endlink . 
   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

void NXOpen::NXObject::SetAttribute ( const char * title )

Creates or modifies a null attribute which is an attribute with a title and no value.

   This method performs an immediate update except when the object is a 
   @link Features::Feature Features::Feature@endlink . 
   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title title

void NXOpen::NXObject::SetAttribute	(	const NXString &	title,
		NXOpen::Update::Option	option
	)

Creates or modifies a null attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
option	option

void NXOpen::NXObject::SetAttribute	(	const char *	title,
		NXOpen::Update::Option	option
	)

Creates or modifies a null attribute with the option to update or not.

   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

virtual void NXOpen::NXObject::SetName ( const NXString & name )

virtual

Sets the custom name of the object.

   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0.

License requirements : None

Parameters

name name

Implements NXOpen::INXObject.

Reimplemented in NXOpen::SIM::KinematicConfigurator, NXOpen::CoordinateSystem, NXOpen::CAE::Optimization::DAOSolution, NXOpen::Validate::ResultObject, NXOpen::CAE::LaminateGlobalLayup, NXOpen::CAM::CAMFeature, NXOpen::CAE::LaminateLayupOffset, NXOpen::CAE::LaminateMatOrientation, NXOpen::CAE::PreTestSolution, NXOpen::CAE::LaminatePlyGroup, NXOpen::CAM::FeatureGeometryGroup, NXOpen::CAE::LaminatePostReport, NXOpen::CAE::PreTestExciterConfig, NXOpen::CAE::PreTestSensorConfig, and NXOpen::CAE::CaeGroup.

void NXOpen::NXObject::SetName ( const char * name )

Sets the custom name of the object.

   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0.

License requirements : None

Parameters

name name

void NXOpen::NXObject::SetReferenceAttribute	(	const NXString &	title,
		const NXString &	value
	)

Creates or modifies a string attribute which uses a reference string.

This method performs an immediate update except when the object is a Features::Feature . NOTE: The input value must be a valid reference string. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::SetReferenceAttribute	(	const char *	title,
		const char *	value
	)

Creates or modifies a string attribute which uses a reference string.

This method performs an immediate update except when the object is a Features::Feature . NOTE: The input value must be a valid reference string. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	value

void NXOpen::NXObject::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.

   NOTE: The input value must be a valid reference string. 
   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::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.

   NOTE: The input value must be a valid reference string. 
   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	value
option	option

void NXOpen::NXObject::SetTimeAttribute	(	const NXString &	title,
		const NXString &	value
	)

Creates or modifies a time attribute.

This method performs an immediate update except when the object is a Features::Feature . The time value is assumed to be in the current time zone of the machine running the program. NX will store the value in UTC. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::NXObject::SetTimeAttribute	(	const char *	title,
		const char *	value
	)

Creates or modifies a time attribute.

This method performs an immediate update except when the object is a Features::Feature . The time value is assumed to be in the current time zone of the machine running the program. NX will store the value in UTC. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX3.0.0.

License requirements : None

Parameters

title	title
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::NXObject::SetTimeAttribute	(	const NXString &	title,
		const NXString &	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a time attribute with the option to update or not.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC. 
   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.
option	option

void NXOpen::NXObject::SetTimeAttribute	(	const char *	title,
		const char *	value,
		NXOpen::Update::Option	option
	)

Creates or modifies a time attribute with the option to update or not.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC. 
   This method does not support array attributes.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX8.0.0. Use SetUserAttribute instead.

Created in NX5.0.1.

License requirements : None

Parameters

title	title
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.
option	option

void NXOpen::NXObject::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.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC. 
   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.        
   NOTE: The valid range for attributes of type date is from 01-Jan-1970 to 31-Dec-2105

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.
option	option

void NXOpen::NXObject::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.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC. 
   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.        
   NOTE: The valid range for attributes of type date is from 01-Jan-1970 to 31-Dec-2105

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	The current date and time is used if the value is NULL. See NXObject::DateAndTimeFormat for valid formats. NOTE: The full Unicode character set is not supported for this parameter.
option	option

void NXOpen::NXObject::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.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC. 
   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	The current date and time is used if the value is (0,0).
option	option

void NXOpen::NXObject::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.

   The time value is assumed to be in the current time zone of the machine running the program. 
   NX will store the value in UTC. 
   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	The current date and time is used if the value is (0,0).
option	option

void NXOpen::NXObject::SetUserAttribute	(	const NXOpen::NXObject::AttributeInformation &	info,
		NXOpen::Update::Option	option
	)

Creates or modifies an attribute with the option to update or not.

NOTE: This method does not support the use of @link NXObject::AttributeTypeReference NXObject::AttributeTypeReference@endlink .
Instead, set the type to @link NXObject::AttributeTypeString NXObject::AttributeTypeString@endlink and specify a ReferenceValue.
NOTE: To set an @link NXObject::AttributeTypeTime NXObject::AttributeTypeTime@endlink attribute, either a formatted string or a computational value may be used.
If both are set (the string is not NULL and the computational value is not (0,0)), then the computational value will take precedence.
The time value in either case is in the current time zone of the machine running the program.

The following data members of the Info structure are ignored by this method:
Alias
Inherited
Required
Unset
Locked
OwnedBySystem
PdmBased

The following data members of an attribute cannot be edited once the attribute is set:
Type
Title
TitleAlias
Array
ArrayElementIndex
The dimensionality of the Unit specification (cannot change from mm to microA, but from mm to cm is fine)

The following data of an attribute can be set if and only if the attribute is not associated with a template. It cannot be modified once set.
Array.
Category

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
If it is, the changes will be overridden when the part is updated.
NOTE: The valid range for attributes of type date is from 01-Jan-1970 to 31-Dec-2105

Created in NX8.0.0.

License requirements : None

Parameters

info	info
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::NXObject::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.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
value	value
option	option

void NXOpen::NXObject::SetUserAttribute	(	const NXString &	title,
		int	index,
		NXOpen::Update::Option	option
	)

Creates or modifies a null attribute with the option to update or not.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
option	option

void NXOpen::NXObject::SetUserAttribute	(	const char *	title,
		int	index,
		NXOpen::Update::Option	option
	)

Creates or modifies a null attribute with the option to update or not.

   To set a non-array attribute, set the index = -1.
   Arrays can be extended only one element at a time.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
index	index
option	option

void NXOpen::NXObject::SetUserAttributeLock	(	const NXString &	title,
		NXOpen::NXObject::AttributeType	type,
		bool	lock
	)

Lock or unlock the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked.
   NOTE: Attributes that are reserved (OwnedBySystem), cannot be unlocked.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
lock	lock

void NXOpen::NXObject::SetUserAttributeLock	(	const char *	title,
		NXOpen::NXObject::AttributeType	type,
		bool	lock
	)

Lock or unlock the given attribute.

   For array attributes, the Title should be set to the array title, without the appended index.
   Individual array elements cannot be separately locked.
   NOTE: Attributes that are reserved (OwnedBySystem), cannot be unlocked.
   NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
         If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : None

Parameters

title	title
type	type
lock	lock

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

NXObject.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation