nxopen

Class NXObject.AttributeInformation

java.lang.Object

nxopen.NXObject.AttributeInformation

All Implemented Interfaces:

Serializable

Enclosing interface:

NXObject

public static class NXObject.AttributeInformation
extends Object
implements Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	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).
boolean	booleanValue Boolean (logical) attribute value (the default value is returned when reading templates of non-set attributes)
String	category Attribute category (may be null)
NXObject.ComputationalTime	compTimeValue Time/Date attribute value (the default value is returned when reading templates of non-set attributes).
Expression	expression The expresssion referenced by the attribute (only supported if the referenceValue is null)
boolean	inherited The attribute is inherited from another object and not overridden
int	integerValue Integer attribute value (the default value is returned when reading templates of non-set attributes)
boolean	isOverride The attribute is overriding an inherited attribute
boolean	locked The attribute is locked.
boolean	notSaved The attribute is transient - it will not be saved on part save
boolean	ownedBySystem This attribute is a reserved system attribute.
boolean	pdmBased The attribute is PDM-based
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
String	referenceValue Reference string of a string type attribute (it is null if it is a 'normal' string attribute).
boolean	required The attribute is required on the given object
String	stringValue String attribute value (the default value is returned when reading templates of non-set attributes).
String	timeValue Time/Date attribute value (the default value is returned when reading templates of non-set attributes).
String	title Attribute title (for arrays, this is the array title without an appended index)
String	titleAlias Attribute title alias (may be null) (for arrays, this is the array title alias, without an appended index)
NXObject.AttributeType	type Attribute type
Unit	unit The display units, if any, if the attribute is a real-type attribute
boolean	unset The attribute has not been set (i.e. has no value) on the object (used when getting attribute information)

Constructor Summary

Constructors

Constructor and Description
AttributeInformation()
AttributeInformation(NXObject.AttributeType typeInitial, String categoryInitial, String titleInitial, String titleAliasInitial, boolean booleanValueInitial, int integerValueInitial, double realValueInitial, String stringValueInitial, String timeValueInitial, NXObject.ComputationalTime compTimeValueInitial, String referenceValueInitial, boolean inheritedInitial, boolean isOverrideInitial, boolean lockedInitial, boolean ownedBySystemInitial, boolean requiredInitial, boolean unsetInitial, boolean arrayInitial, boolean pdmBasedInitial, boolean notSavedInitial, int arrayElementIndexInitial, Unit unitInitial, Expression expressionInitial) Constructor for the AttributeInformation object.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

public NXObject.AttributeType type

Attribute type

category

public String category

Attribute category (may be null)

title

public String title

Attribute title (for arrays, this is the array title without an appended index)

titleAlias

public String titleAlias

Attribute title alias (may be null) (for arrays, this is the array title alias, without an appended index)

booleanValue

public boolean booleanValue

Boolean (logical) attribute value (the default value is returned when reading templates of non-set attributes)

integerValue

public int integerValue

Integer attribute value (the default value is returned when reading templates of non-set attributes)

realValue

public 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

stringValue

public String stringValue

String attribute value (the default value is returned when reading templates of non-set attributes).

timeValue

public String timeValue

Time/Date attribute value (the default value is returned when reading templates of non-set attributes). See 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.

compTimeValue

public NXObject.ComputationalTime 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.

referenceValue

public String 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.

inherited

public boolean inherited

The attribute is inherited from another object and not overridden

isOverride

public boolean isOverride

The attribute is overriding an inherited attribute

locked

public boolean 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.

ownedBySystem

public boolean 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.

required

public boolean required

The attribute is required on the given object

unset

public boolean unset

The attribute has not been set (i.e. has no value) on the object (used when getting attribute information)

array

public boolean array

The attribute is an array attribute

pdmBased

public boolean pdmBased

The attribute is PDM-based

notSaved

public boolean notSaved

The attribute is transient - it will not be saved on part save

arrayElementIndex

public int 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).

unit

public Unit unit

The display units, if any, if the attribute is a real-type attribute

expression

public Expression expression

The expresssion referenced by the attribute (only supported if the referenceValue is null)

Constructor Detail

AttributeInformation

public AttributeInformation()

AttributeInformation

public AttributeInformation(NXObject.AttributeType typeInitial,
                            String categoryInitial,
                            String titleInitial,
                            String titleAliasInitial,
                            boolean booleanValueInitial,
                            int integerValueInitial,
                            double realValueInitial,
                            String stringValueInitial,
                            String timeValueInitial,
                            NXObject.ComputationalTime compTimeValueInitial,
                            String referenceValueInitial,
                            boolean inheritedInitial,
                            boolean isOverrideInitial,
                            boolean lockedInitial,
                            boolean ownedBySystemInitial,
                            boolean requiredInitial,
                            boolean unsetInitial,
                            boolean arrayInitial,
                            boolean pdmBasedInitial,
                            boolean notSavedInitial,
                            int arrayElementIndexInitial,
                            Unit unitInitial,
                            Expression expressionInitial)

Constructor for the AttributeInformation object.

Parameters:

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 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)