NX Open C++ Reference Guide
|
A base class providing low-level services for most NXOpen classes. More...
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. More... | |
void | DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes all attributes of a specific type with the option to update or not. More... | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title) |
Deletes an attribute by type and title. More... | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title) |
Deletes an attribute by type and title. More... | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option) |
Deletes an attribute by type and title with the option to update or not. More... | |
void | DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option) |
Deletes an attribute by type and title with the option to update or not. More... | |
void | DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option) |
Deletes the first attribute encountered with the given Type, Title. More... | |
void | DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option) |
Deletes the first attribute encountered with the given Type, Title. More... | |
void | DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option) |
Deletes the attributes encountered with the given Type with option to update or not. More... | |
virtual NXOpen::INXObject * | FindObject (const NXString &journalIdentifier) |
Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
virtual NXOpen::INXObject * | FindObject (const char *journalIdentifier) |
Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More... | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type) |
Gets all the attribute titles of a specific type. More... | |
bool | GetBooleanUserAttribute (const NXString &title, int index) |
Gets a boolean attribute by Title and array Index. More... | |
bool | GetBooleanUserAttribute (const char *title, int index) |
Gets a boolean attribute by Title and array Index. More... | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. More... | |
NXOpen::NXObject::ComputationalTime | GetComputationalTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. More... | |
int | GetIntegerAttribute (const NXString &title) |
Gets an integer attribute by title. More... | |
int | GetIntegerAttribute (const char *title) |
Gets an integer attribute by title. More... | |
int | GetIntegerUserAttribute (const NXString &title, int index) |
Gets an integer attribute by Title and array Index. More... | |
int | GetIntegerUserAttribute (const char *title, int index) |
Gets an integer attribute by Title and array Index. More... | |
double | GetRealAttribute (const NXString &title) |
Gets a real attribute by title. More... | |
double | GetRealAttribute (const char *title) |
Gets a real attribute by title. More... | |
double | GetRealUserAttribute (const NXString &title, int index) |
Gets a real attribute by Title and array Index. More... | |
double | GetRealUserAttribute (const char *title, int index) |
Gets a real attribute by Title and array Index. More... | |
NXString | GetReferenceAttribute (const NXString &title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
NXString | GetReferenceAttribute (const char *title) |
Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More... | |
NXString | GetStringAttribute (const NXString &title) |
Gets a string attribute value by title. More... | |
NXString | GetStringAttribute (const char *title) |
Gets a string attribute value by title. More... | |
NXString | GetStringUserAttribute (const NXString &title, int index) |
Gets a string attribute by Title and array Index. More... | |
NXString | GetStringUserAttribute (const char *title, int index) |
Gets a string attribute by Title and array Index. More... | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title) |
Gets a time attribute by title. More... | |
NXString | GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title) |
Gets a time attribute by title. More... | |
NXString | GetTimeUserAttribute (const NXString &title, int index) |
Gets a time attribute by Title and array Index. More... | |
NXString | GetTimeUserAttribute (const char *title, int index) |
Gets a time attribute by Title and array Index. More... | |
NXOpen::NXObject::AttributeInformation | GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
NXOpen::NXObject::AttributeInformation | GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More... | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttribute (const NXString &title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type) |
Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttribute (const char *title, bool includeUnset, bool addStringValues, NXOpen::NXObject::AttributeType type) |
Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More... | |
NXString | GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
NXString | GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index) |
Gets the first attribute encountered on the object, if any, with a given title, type and array index. More... | |
int | GetUserAttributeCount (NXOpen::NXObject::AttributeType type) |
Gets the count of set attributes on the object, if any, of the given type. More... | |
int | GetUserAttributeCount (NXOpen::NXObject::AttributeType type, bool includeUnset, bool countArrayAsOneAttribute) |
Gets the count of attributes on the object, if any, of the given type. More... | |
bool | GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. More... | |
bool | GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type) |
Determine the lock of the given attribute. More... | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes () |
Gets all the attributes that have been set on the given object. More... | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset) |
Gets all the attributes of the given object. More... | |
std::vector < NXOpen::NXObject::AttributeInformation > | GetUserAttributes (bool includeUnset, bool addStringValues) |
Gets all the attributes of the given object. More... | |
std::vector< NXString > | GetUserAttributesAsStrings () |
Gets all the attributes that have been set on the given object. More... | |
int | GetUserAttributeSize (const NXString &title, NXOpen::NXObject::AttributeType type) |
Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
int | GetUserAttributeSize (const char *title, NXOpen::NXObject::AttributeType type) |
Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More... | |
std::vector< NXOpen::NXObject * > | GetUserAttributeSourceObjects () |
Returns an array of objects from which this object presents attributes. More... | |
bool | HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index) |
Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
bool | HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index) |
Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More... | |
virtual bool | IsOccurrence () |
Returns whether this object is an occurrence or not. More... | |
virtual NXString | JournalIdentifier () |
Returns the identifier that would be recorded in a journal for this object. More... | |
virtual NXString | Name () |
Returns the custom name of the object. More... | |
virtual NXOpen::Assemblies::Component * | OwningComponent () |
Returns the owning component, if this object is an occurrence. More... | |
virtual NXOpen::BasePart * | OwningPart () |
Returns the owning part of this object Created in NX3.0.0. More... | |
virtual void | Print () |
Prints a representation of this object to the system log file. More... | |
virtual NXOpen::INXObject * | Prototype () |
Returns the prototype of this object if it is an occurrence. More... | |
void | SetAttribute (const NXString &title, int value) |
Creates or modifies an integer attribute. More... | |
void | SetAttribute (const char *title, int value) |
Creates or modifies an integer attribute. More... | |
void | SetAttribute (const NXString &title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
void | SetAttribute (const char *title, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
void | SetAttribute (const NXString &title, double value) |
Creates or modifies a real attribute. More... | |
void | SetAttribute (const char *title, double value) |
Creates or modifies a real attribute. More... | |
void | SetAttribute (const NXString &title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
void | SetAttribute (const char *title, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
void | SetAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute. More... | |
void | SetAttribute (const char *title, const char *value) |
Creates or modifies a string attribute. More... | |
void | SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
void | SetAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
void | SetAttribute (const NXString &title) |
Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
void | SetAttribute (const char *title) |
Creates or modifies a null attribute which is an attribute with a title and no value. More... | |
void | SetAttribute (const NXString &title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
void | SetAttribute (const char *title, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
void | SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option) |
Creates or modifies a boolean attribute with the option to update or not. More... | |
void | SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option) |
Creates or modifies a boolean attribute with the option to update or not. More... | |
virtual void | SetName (const NXString &name) |
Sets the custom name of the object. More... | |
virtual void | SetName (const char *name) |
Sets the custom name of the object. More... | |
void | SetReferenceAttribute (const NXString &title, const NXString &value) |
Creates or modifies a string attribute which uses a reference string. More... | |
void | SetReferenceAttribute (const char *title, const char *value) |
Creates or modifies a string attribute which uses a reference string. More... | |
void | SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
void | SetReferenceAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
Creates or modifies a string attribute which uses a reference string, with the option to update or not. More... | |
void | SetTimeAttribute (const NXString &title, const NXString &value) |
Creates or modifies a time attribute. More... | |
void | SetTimeAttribute (const char *title, const char *value) |
Creates or modifies a time attribute. More... | |
void | SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
void | SetTimeAttribute (const char *title, const char *value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
void | SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
void | SetTimeUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
void | SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
void | SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option) |
Creates or modifies a time attribute with the option to update or not. More... | |
void | SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option) |
Creates or modifies an attribute with the option to update or not. More... | |
void | SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
void | SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option) |
Creates or modifies an integer attribute with the option to update or not. More... | |
void | SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
void | SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option) |
Creates or modifies a real attribute with the option to update or not. More... | |
void | SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
void | SetUserAttribute (const char *title, int index, const char *value, NXOpen::Update::Option option) |
Creates or modifies a string attribute with the option to update or not. More... | |
void | SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
void | SetUserAttribute (const char *title, int index, NXOpen::Update::Option option) |
Creates or modifies a null attribute with the option to update or not. More... | |
void | SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. More... | |
void | SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock) |
Lock or unlock the given attribute. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
A base class providing low-level services for most NXOpen classes.
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.
Specifies attribute type.
NOTE: Attributes of type reference are also string attributes. The reference type as such is deprecated.
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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.
If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored, If a candidate attribute is an array attribute and DeleteEntireArray input is 'false', then the last element of the array is deleted. If a candidate attribute is an array attribute and DeleteEntireArray input is 'true', then the entire array is deleted. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference .
Created in NX8.0.0.
License requirements : None
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.
If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored, If a candidate attribute is an array attribute and DeleteEntireArray input is 'false', then the last element of the array is deleted. If a candidate attribute is an array attribute and DeleteEntireArray input is 'true', then the entire array is deleted. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference .
Created in NX8.0.0.
License requirements : None
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 NXOpen::NXObject::AttributeTypeReference .
Created in NX8.0.0.
License requirements : None
type | type |
option | option |
|
virtual |
Finds the NXOpen::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.
journalIdentifier | Journal identifier of the object |
Implements NXOpen::INXObject.
|
virtual |
Finds the NXOpen::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.
journalIdentifier | Journal identifier of the object |
Implements NXOpen::INXObject.
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.
Created in NX3.0.0.
License requirements : None
type | type |
bool NXOpen::NXObject::GetBooleanUserAttribute | ( | const NXString & | title, |
int | index | ||
) |
Gets a boolean attribute by Title and array Index.
This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
title | title |
index | index |
bool NXOpen::NXObject::GetBooleanUserAttribute | ( | const char * | title, |
int | index | ||
) |
Gets a boolean attribute by Title and array Index.
This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
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 to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
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 to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
title | title |
index | index |
int NXOpen::NXObject::GetIntegerAttribute | ( | const NXString & | title | ) |
Gets an integer attribute by title.
This method does not support array attributes.
Created in NX3.0.0.
License requirements : None
title | title |
int NXOpen::NXObject::GetIntegerAttribute | ( | const char * | title | ) |
Gets an integer attribute by title.
This method does not support array attributes.
Created in NX3.0.0.
License requirements : None
title | title |
int NXOpen::NXObject::GetIntegerUserAttribute | ( | const NXString & | title, |
int | index | ||
) |
Gets an integer attribute by Title and array Index.
This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
title | title |
index | index |
int NXOpen::NXObject::GetIntegerUserAttribute | ( | const char * | title, |
int | index | ||
) |
Gets an integer attribute by Title and array Index.
This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
title | title |
index | index |
double NXOpen::NXObject::GetRealAttribute | ( | const NXString & | title | ) |
Gets a real attribute by title.
This method does not support array attributes.
Created in NX3.0.0.
License requirements : None
title | title |
double NXOpen::NXObject::GetRealAttribute | ( | const char * | title | ) |
Gets a real attribute by title.
This method does not support array attributes.
Created in NX3.0.0.
License requirements : None
title | title |
double NXOpen::NXObject::GetRealUserAttribute | ( | const NXString & | title, |
int | index | ||
) |
Gets a real attribute by Title and array Index.
This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
title | title |
index | index |
double NXOpen::NXObject::GetRealUserAttribute | ( | const char * | title, |
int | index | ||
) |
Gets a real attribute by Title and array Index.
This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
title | title |
index | index |
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 NXOpen::NXObject::GetUserAttribute This method does not support array attributes.
Created in NX3.0.0.
License requirements : None
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 NXOpen::NXObject::GetUserAttribute This method does not support array attributes.
Created in NX3.0.0.
License requirements : None
title | 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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX3.0.0.
License requirements : None
title | title |
Gets a string attribute by Title and array Index.
For reference type string attributes, the calculated StringValue is returned. This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
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. This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes .
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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX3.0.0.
License requirements : None
format | format |
title | title |
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. This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . NOTE: The returned string must be deleted by the caller
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. This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . NOTE: The returned string must be deleted by the caller
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.
This function will return data for unset attributes. For non-string attribute types, the string-converted value is returned as well for convenience. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. If an unset attribute is read, then the index returned has no meaning. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.
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.
This function will return data for unset attributes. For non-string attribute types, the string-converted value is returned as well for convenience. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. If an unset attribute is read, then the index returned has no meaning. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen::NXObject::GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.
title | title |
type | type |
index | index |
std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetUserAttribute | ( | const NXString & | title, |
bool | includeUnset, | ||
bool | addStringValues, | ||
NXOpen::NXObject::AttributeType | type | ||
) |
Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type.
This function will optionally return data for unset attributes. For non-string attribute types, the string-converted value is returned as well for convenience. If the attribute cannot be found, but a template is found, then a single struct is returned with information from the template. If neither an attribute nor a template can be found, then no struct is returned (NULL)). If a non-array attribute is found, a single struct is returned with information from that attribute. If an array attribute is found, then an array of structs is returned with information from each of the array elements of the attribute. Array elements are returned in order of increasing indices. The first element of an array has Index 0 (zero). The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.
title | title |
includeUnset | includeunset |
addStringValues | addstringvalues |
type | type |
std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetUserAttribute | ( | const char * | title, |
bool | includeUnset, | ||
bool | addStringValues, | ||
NXOpen::NXObject::AttributeType | type | ||
) |
Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type.
This function will optionally return data for unset attributes. For non-string attribute types, the string-converted value is returned as well for convenience. If the attribute cannot be found, but a template is found, then a single struct is returned with information from the template. If neither an attribute nor a template can be found, then no struct is returned (NULL)). If a non-array attribute is found, a single struct is returned with information from that attribute. If an array attribute is found, then an array of structs is returned with information from each of the array elements of the attribute. Array elements are returned in order of increasing indices. The first element of an array has Index 0 (zero). The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.
title | title |
includeUnset | includeunset |
addStringValues | addstringvalues |
type | type |
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 NXOpen::NXObject::GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, the calculated StringValue is returned.
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 NXOpen::NXObject::GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString . For reference type string attributes, the calculated StringValue is returned.
title | title |
type | type |
index | index |
int NXOpen::NXObject::GetUserAttributeCount | ( | NXOpen::NXObject::AttributeType | type | ) |
Gets the count of set attributes on the object, if any, of the given type.
Will not include unset attributes. Array elements are counted individually.
type | type |
int NXOpen::NXObject::GetUserAttributeCount | ( | NXOpen::NXObject::AttributeType | type, |
bool | includeUnset, | ||
bool | countArrayAsOneAttribute | ||
) |
Gets the count of attributes on the object, if any, of the given type.
Includes option to include unset attributes (i.e. to count attribute templates with no associated attributes). Includes option to count arrays as one attribute or to count array elements individually. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString .
type | type |
includeUnset | includeunset |
countArrayAsOneAttribute | countarrayasoneattribute |
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
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
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 results will not include information from associated attribute templates of unset 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 NXOpen::NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.
std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetUserAttributes | ( | bool | includeUnset | ) |
Gets all the attributes of the given object.
Includes option to return information also from associated attribute templates of unset attributes. 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 NXOpen::NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.
includeUnset | includeunset |
std::vector<NXOpen::NXObject::AttributeInformation> NXOpen::NXObject::GetUserAttributes | ( | bool | includeUnset, |
bool | addStringValues | ||
) |
Gets all the attributes of the given object.
Includes option to return information also from associated attribute templates of unset attributes. 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 NXOpen::NXObject::AttributeTypeString , and both the ReferenceValue and the calculated StringValue are returned.
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.
Created in NX8.0.0.
License requirements : None
int NXOpen::NXObject::GetUserAttributeSize | ( | const NXString & | title, |
NXOpen::NXObject::AttributeType | type | ||
) |
Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
For unset attributes (with or without templates), the returned size will be 0. For non-array set attributes, the returned size will be 1. For array attributes, the returned size will be the count of array elements that have been set. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString .
title | title |
type | type |
int NXOpen::NXObject::GetUserAttributeSize | ( | const char * | title, |
NXOpen::NXObject::AttributeType | type | ||
) |
Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
For unset attributes (with or without templates), the returned size will be 0. For non-array set attributes, the returned size will be 1. For array attributes, the returned size will be the count of array elements that have been set. NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString .
title | title |
type | type |
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.
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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object.
If the attribute to be found is not an array, set the index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString .
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 Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object.
If the attribute to be found is not an array, set the index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). NOTE: This method does not support the use of NXOpen::NXObject::AttributeTypeReference . Instead, use NXOpen::NXObject::AttributeTypeString .
title | title |
type | type |
index | index |
|
virtual |
Returns whether this object is an occurrence or not.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
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 |
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::PreTestSolution, NXOpen::CAE::LaminatePlyGroup, NXOpen::CAM::FeatureGeometryGroup, NXOpen::CAE::LaminatePostReport, NXOpen::CAM::CAMAttribute, NXOpen::CAE::PreTestSensorConfig, NXOpen::CAE::LaminateLayupOffset, NXOpen::CAE::PreTestExciterConfig, NXOpen::CAE::LaminateMatOrientation, NXOpen::Unit, and NXOpen::Fields::NameVariable.
|
virtual |
Returns the owning component, if this object is an occurrence.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
virtual |
Returns the owning part of this object
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
virtual |
Prints a representation of this object to the system log file.
Created in NX3.0.0.
License requirements : None
Implements NXOpen::INXObject.
|
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
title | title |
value | value |
option | option |
Creates or modifies a string attribute.
This method performs an immediate update except when the object is a NXOpen::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.
Created in NX3.0.0.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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
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
title | title |
index | index |
value | value |
option | option |
|
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
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::PreTestSolution, NXOpen::CAE::LaminatePlyGroup, NXOpen::CAM::FeatureGeometryGroup, NXOpen::CAE::LaminatePostReport, NXOpen::CAE::PreTestExciterConfig, NXOpen::CAE::PreTestSensorConfig, NXOpen::CAE::LaminateLayupOffset, NXOpen::CAE::CaeGroup, and NXOpen::CAE::LaminateMatOrientation.
|
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
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::PreTestSolution, NXOpen::CAE::LaminatePlyGroup, NXOpen::CAM::FeatureGeometryGroup, NXOpen::CAE::LaminatePostReport, NXOpen::CAE::PreTestExciterConfig, NXOpen::CAE::PreTestSensorConfig, NXOpen::CAE::LaminateLayupOffset, NXOpen::CAE::CaeGroup, and NXOpen::CAE::LaminateMatOrientation.
Creates or modifies a string attribute which uses a reference string.
This method performs an immediate update except when the object is a NXOpen::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.
Created in NX3.0.0.
License requirements : None
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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
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.
Created in NX5.0.1.
License requirements : None
title | title |
value | value |
option | option |
Creates or modifies a time attribute.
This method performs an immediate update except when the object is a NXOpen::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.
Created in NX3.0.0.
License requirements : None
title | title |
value | The current date and time is used if the value is NULL. See NXOpen::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 NXOpen::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.
Created in NX3.0.0.
License requirements : None
title | title |
value | The current date and time is used if the value is NULL. See NXOpen::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.
Created in NX5.0.1.
License requirements : None
title | title |
value | The current date and time is used if the value is NULL. See NXOpen::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.
Created in NX5.0.1.
License requirements : None
title | title |
value | The current date and time is used if the value is NULL. See NXOpen::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
title | title |
index | index |
value | The current date and time is used if the value is NULL. See NXOpen::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
title | title |
index | index |
value | The current date and time is used if the value is NULL. See NXOpen::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
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
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 NXOpen::NXObject::AttributeTypeReference . Instead, set the type to NXOpen::NXObject::AttributeTypeString and specify a ReferenceValue. NOTE: To set an NXOpen::NXObject::AttributeTypeTime 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 Transient
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
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
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
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
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
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
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
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
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
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
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
title | title |
type | type |
lock | lock |