NX Open C++ Reference Guide
|
Contains attribute information. More...
Public Member Functions | |
AttributeInformation (NXOpen::NXObject::AttributeType typeInitial, const NXString &categoryInitial, const NXString &titleInitial, const NXString &titleAliasInitial, bool booleanValueInitial, int integerValueInitial, double realValueInitial, const NXString &stringValueInitial, const NXString &timeValueInitial, const NXString &referenceValueInitial, bool inheritedInitial, bool lockedInitial, bool ownedBySystemInitial, bool requiredInitial, bool unsetInitial, bool arrayInitial, int arrayElementIndexInitial, NXOpen::Unit *unitInitial) | |
Constructor for the AttributeInformation struct. | |
Public Attributes | |
bool | Array |
The attribute is an array attribute. | |
int | ArrayElementIndex |
If this struct represents an array attribute element, this is the index (numerical, starting with 0). | |
bool | BooleanValue |
Boolean (logical) attribute value (default value when reading templates of non-set attributes) | |
NXString | Category |
Attribute category (may be NULL) | |
bool | Inherited |
The attribute is inherited from another object and not overridden. | |
int | IntegerValue |
Integer attribute value (default value when reading templates of non-set attributes) | |
bool | Locked |
The attribute is locked. | |
bool | OwnedBySystem |
This attribute is a reserved system attribute. | |
double | RealValue |
Real attribute value (default value when reading templates of non-set attributes) | |
NXString | ReferenceValue |
Reference string of a string type attribute (it is NULL if it is a 'normal' string attribute). | |
bool | Required |
The attribute is required on the given object. | |
NXString | StringValue |
String attribute value (default value when reading templates of non-set attributes). | |
NXString | TimeValue |
Time/Date attribute value(default value when reading templates of non-set attributes). | |
NXString | Title |
Attribute title (for arrays, this is the array title without an appended index) | |
NXString | TitleAlias |
Attribute title alias (may be NULL) (for arrays, this is the array title alias, without an appended index) | |
NXOpen::NXObject::AttributeType | Type |
Attribute type. | |
NXOpen::Unit * | Unit |
The unit, if any, if the attribute is a real-type attribute. | |
bool | Unset |
The attribute has not been set (i.e. |
Contains attribute information.
All the data members of this struct are updated with values from the attribute (some possibly to NULL) when an attribute is read.
The following data members of this struct are not used (they are ignored) when setting an attribute: Alias Inherited Required Unset Locked
The following data 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 and modified if and only if the attribute is not associated with a template: Category
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
NXOpen::NXObject::AttributeInformation::AttributeInformation | ( | NXOpen::NXObject::AttributeType | typeInitial, |
const NXString & | categoryInitial, | ||
const NXString & | titleInitial, | ||
const NXString & | titleAliasInitial, | ||
bool | booleanValueInitial, | ||
int | integerValueInitial, | ||
double | realValueInitial, | ||
const NXString & | stringValueInitial, | ||
const NXString & | timeValueInitial, | ||
const NXString & | referenceValueInitial, | ||
bool | inheritedInitial, | ||
bool | lockedInitial, | ||
bool | ownedBySystemInitial, | ||
bool | requiredInitial, | ||
bool | unsetInitial, | ||
bool | arrayInitial, | ||
int | arrayElementIndexInitial, | ||
NXOpen::Unit * | unitInitial | ||
) |
Constructor for the AttributeInformation struct.
typeInitial | Attribute type |
categoryInitial | Attribute category (may be NULL) |
titleInitial | Attribute title (for arrays, this is the array title without an appended index) |
titleAliasInitial | Attribute title alias (may be NULL) (for arrays, this is the array title alias, without an appended index) |
booleanValueInitial | Boolean (logical) attribute value (default value when reading templates of non-set attributes) |
integerValueInitial | Integer attribute value (default value when reading templates of non-set attributes) |
realValueInitial | Real attribute value (default value when reading templates of non-set attributes) |
stringValueInitial | String attribute value (default value when reading templates of non-set attributes). |
timeValueInitial | Time/Date attribute value(default value when reading templates of non-set attributes). See NXObject::DateAndTimeFormat for valid formats. |
referenceValueInitial | Reference string of a string type attribute (it is NULL if it is a 'normal' string attribute). |
inheritedInitial | The attribute is inherited from another object and not overridden |
lockedInitial | The attribute is locked. When an existing attribute is read, this flag indicates that the attribute cannot currently be modified. The flag is set if the attribute is created from a template that has the 'Locked' flag, or if it is reserved by the system or by some other mechanism. When an unset attribute template is read, this flag indicates whether attributes created from the template will be locked when the part is saved and reloaded. |
ownedBySystemInitial | This attribute is a reserved system attribute. When this flag is set, the attribute can be set and removed only by the system. It is also created locked. It cannot be unlocked. |
requiredInitial | The attribute is required on the given object |
unsetInitial | The attribute has not been set (i.e. has no value) on the object (used when getting attribute information) |
arrayInitial | The attribute is an array attribute |
arrayElementIndexInitial | If this struct represents an array attribute element, this is the index (numerical, starting with 0). After reading an attribute, it is valid only if 'Unset' is 'false' and 'Array' is 'true'. The array size can be resized only one element at a time (adding or removing the last element). |
unitInitial | The unit, if any, if the attribute is a real-type attribute |
The attribute is an array attribute.
If this struct represents an array attribute element, this is the index (numerical, starting with 0).
After reading an attribute, it is valid only if 'Unset' is 'false' and 'Array' is 'true'. The array size can be resized only one element at a time (adding or removing the last element).
Boolean (logical) attribute value (default value when reading templates of non-set attributes)
Attribute category (may be NULL)
The attribute is inherited from another object and not overridden.
Integer attribute value (default value when reading templates of non-set attributes)
The attribute is locked.
When an existing attribute is read, this flag indicates that the attribute cannot currently be modified. The flag is set if the attribute is created from a template that has the 'Locked' flag, or if it is reserved by the system or by some other mechanism. When an unset attribute template is read, this flag indicates whether attributes created from the template will be locked when the part is saved and reloaded.
This attribute is a reserved system attribute.
When this flag is set, the attribute can be set and removed only by the system. It is also created locked. It cannot be unlocked.
Real attribute value (default value when reading templates of non-set attributes)
Reference string of a string type attribute (it is NULL if it is a 'normal' string attribute).
The attribute is required on the given object.
String attribute value (default value when reading templates of non-set attributes).
Time/Date attribute value(default value when reading templates of non-set attributes).
See NXObject::DateAndTimeFormat for valid formats.
Attribute title (for arrays, this is the array title without an appended index)
Attribute title alias (may be NULL) (for arrays, this is the array title alias, without an appended index)
The unit, if any, if the attribute is a real-type attribute.
The attribute has not been set (i.e.
has no value) on the object (used when getting attribute information)