|
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 NXOpen::NXObject::ComputationalTime &compTimeValueInitial, const NXString &referenceValueInitial, bool inheritedInitial, bool isOverrideInitial, bool lockedInitial, bool ownedBySystemInitial, bool requiredInitial, bool unsetInitial, bool arrayInitial, bool pdmBasedInitial, bool notSavedInitial, int arrayElementIndexInitial, NXOpen::Unit *unitInitial, NXOpen::Expression *expressionInitial) | |
| Constructor for the AttributeInformation struct. More... | |
Public Attributes | |
| bool | Array |
| The attribute is an array attribute. More... | |
| int | ArrayElementIndex |
| If this struct represents an array attribute element, this is the index (numerical, starting with 0). More... | |
| bool | BooleanValue |
| Boolean (logical) attribute value (the default value is returned when reading templates of non-set attributes) More... | |
| NXString | Category |
| Attribute category (may be NULL) More... | |
| NXOpen::NXObject::ComputationalTime | CompTimeValue |
| Time/Date attribute value (the default value is returned when reading templates of non-set attributes). More... | |
| NXOpen::Expression * | Expression |
| The expresssion referenced by the attribute (only supported if the referenceValue is NULL) More... | |
| bool | Inherited |
| The attribute is inherited from another object and not overridden. More... | |
| int | IntegerValue |
| Integer attribute value (the default value is returned when reading templates of non-set attributes) More... | |
| bool | IsOverride |
| The attribute is overriding an inherited attribute. More... | |
| bool | Locked |
| The attribute is locked. More... | |
| bool | NotSaved |
| The attribute is transient - it will not be saved on part save. More... | |
| bool | OwnedBySystem |
| This attribute is a reserved system attribute. More... | |
| bool | PdmBased |
| The attribute is PDM-based. More... | |
| double | RealValue |
| Real attribute value (the default value is returned when reading templates of non-set attributes) If the attribute has units, it is returned in the display units of the attribute. More... | |
| NXString | ReferenceValue |
| Reference string of a string type attribute (it is NULL if it is a 'normal' string attribute). More... | |
| bool | Required |
| The attribute is required on the given object. More... | |
| NXString | StringValue |
| String attribute value (the default value is returned when reading templates of non-set attributes). More... | |
| NXString | TimeValue |
| Time/Date attribute value (the default value is returned when reading templates of non-set attributes). More... | |
| NXString | Title |
| Attribute title (for arrays, this is the array title without an appended index) More... | |
| NXString | TitleAlias |
| Attribute title alias (may be NULL) (for arrays, this is the array title alias, without an appended index) More... | |
| NXOpen::NXObject::AttributeType | Type |
| Attribute type. More... | |
| NXOpen::Unit * | Unit |
| The display units, if any, if the attribute is a real-type attribute. More... | |
| bool | Unset |
| The attribute has not been set (i.e. More... | |
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 Override Required Unset Locked OwnedBySystem PdmBased
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 NXOpen::NXObject::ComputationalTime & | compTimeValueInitial, | ||
| const NXString & | referenceValueInitial, | ||
| bool | inheritedInitial, | ||
| bool | isOverrideInitial, | ||
| bool | lockedInitial, | ||
| bool | ownedBySystemInitial, | ||
| bool | requiredInitial, | ||
| bool | unsetInitial, | ||
| bool | arrayInitial, | ||
| bool | pdmBasedInitial, | ||
| bool | notSavedInitial, | ||
| int | arrayElementIndexInitial, | ||
| NXOpen::Unit * | unitInitial, | ||
| NXOpen::Expression * | expressionInitial | ||
| ) |
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 (the default value is returned when reading templates of non-set attributes) |
| integerValueInitial | Integer attribute value (the default value is returned when reading templates of non-set attributes) |
| realValueInitial | Real attribute value (the default value is returned when reading templates of non-set attributes) If the attribute has units, it is returned in the display units of the attribute |
| stringValueInitial | String attribute value (the default value is returned when reading templates of non-set attributes). |
| timeValueInitial | Time/Date attribute value (the default value is returned when reading templates of non-set attributes). See NXOpen::NXObject::DateAndTimeFormat for valid formats. The time value held here is in the current time zone of the machine running the program. NOTE: if both TimeValue and CompTimeValue are unset (NULL and (0,0), respectively) when the attribute is set, then the attribute will be set to current time and date. |
| compTimeValueInitial | Time/Date attribute value (the default value is returned when reading templates of non-set attributes). The time value held here is in the current time zone of the machine running the program. |
| referenceValueInitial | Reference string of a string type attribute (it is NULL if it is a 'normal' string attribute). Only supported if the expression reference is NULL. |
| inheritedInitial | The attribute is inherited from another object and not overridden |
| isOverrideInitial | The attribute is overriding an inherited attribute |
| 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 |
| pdmBasedInitial | The attribute is PDM-based |
| notSavedInitial | The attribute is transient - it will not be saved on part save |
| 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 display units, if any, if the attribute is a real-type attribute |
| expressionInitial | The expresssion referenced by the attribute (only supported if the referenceValue is NULL) |
| bool NXOpen::NXObject::AttributeInformation::Array |
The attribute is an array attribute.
| int NXOpen::NXObject::AttributeInformation::ArrayElementIndex |
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).
| bool NXOpen::NXObject::AttributeInformation::BooleanValue |
Boolean (logical) attribute value (the default value is returned when reading templates of non-set attributes)
| NXString NXOpen::NXObject::AttributeInformation::Category |
Attribute category (may be NULL)
| NXOpen::NXObject::ComputationalTime NXOpen::NXObject::AttributeInformation::CompTimeValue |
Time/Date attribute value (the default value is returned when reading templates of non-set attributes).
The time value held here is in the current time zone of the machine running the program.
| NXOpen::Expression* NXOpen::NXObject::AttributeInformation::Expression |
The expresssion referenced by the attribute (only supported if the referenceValue is NULL)
| bool NXOpen::NXObject::AttributeInformation::Inherited |
The attribute is inherited from another object and not overridden.
| int NXOpen::NXObject::AttributeInformation::IntegerValue |
Integer attribute value (the default value is returned when reading templates of non-set attributes)
| bool NXOpen::NXObject::AttributeInformation::IsOverride |
The attribute is overriding an inherited attribute.
| bool NXOpen::NXObject::AttributeInformation::Locked |
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.
| bool NXOpen::NXObject::AttributeInformation::NotSaved |
The attribute is transient - it will not be saved on part save.
| bool NXOpen::NXObject::AttributeInformation::OwnedBySystem |
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.
| bool NXOpen::NXObject::AttributeInformation::PdmBased |
The attribute is PDM-based.
| double NXOpen::NXObject::AttributeInformation::RealValue |
Real attribute value (the default value is returned when reading templates of non-set attributes) If the attribute has units, it is returned in the display units of the attribute.
| NXString NXOpen::NXObject::AttributeInformation::ReferenceValue |
Reference string of a string type attribute (it is NULL if it is a 'normal' string attribute).
Only supported if the expression reference is NULL.
| bool NXOpen::NXObject::AttributeInformation::Required |
The attribute is required on the given object.
| NXString NXOpen::NXObject::AttributeInformation::StringValue |
String attribute value (the default value is returned when reading templates of non-set attributes).
| NXString NXOpen::NXObject::AttributeInformation::TimeValue |
Time/Date attribute value (the default value is returned when reading templates of non-set attributes).
See NXOpen::NXObject::DateAndTimeFormat for valid formats. The time value held here is in the current time zone of the machine running the program. NOTE: if both TimeValue and CompTimeValue are unset (NULL and (0,0), respectively) when the attribute is set, then the attribute will be set to current time and date.
| NXString NXOpen::NXObject::AttributeInformation::Title |
Attribute title (for arrays, this is the array title without an appended index)
| NXString NXOpen::NXObject::AttributeInformation::TitleAlias |
Attribute title alias (may be NULL) (for arrays, this is the array title alias, without an appended index)
| NXOpen::NXObject::AttributeType NXOpen::NXObject::AttributeInformation::Type |
Attribute type.
| NXOpen::Unit* NXOpen::NXObject::AttributeInformation::Unit |
The display units, if any, if the attribute is a real-type attribute.
| bool NXOpen::NXObject::AttributeInformation::Unset |
The attribute has not been set (i.e.
has no value) on the object (used when getting attribute information)