NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::AttributePropertiesBaseBuilder Class Reference

Represents an AttributePropertiesBaseBuilder to be used for creating attributes. More...

Inheritance diagram for NXOpen::AttributePropertiesBaseBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::AttributePropertiesBuilder NXOpen::PDM::PartCreationObjectAttributePropertiesBuilder

List of all members.

Public Types

enum  BooleanValueOptions { BooleanValueOptionsFalse, BooleanValueOptionsTrue }
 The value choices for an attribute of type Boolean. More...
enum  DataTypeOptions {
  DataTypeOptionsNull, DataTypeOptionsBoolean, DataTypeOptionsInteger, DataTypeOptionsNumber,
  DataTypeOptionsString, DataTypeOptionsDate
}
 Specifies the data type of the attribute, this cannot be changed once the attribute has been created. More...
enum  ObjectOptions {
  ObjectOptionsObject, ObjectOptionsFeature, ObjectOptionsOccurrence, ObjectOptionsComponentInstance,
  ObjectOptionsReferenceSet, ObjectOptionsObjectInComponentPart, ObjectOptionsComponentAsPartAttribute, ObjectOptionsEmpty
}
 Specifies which object will be used when applying attributes. More...

Public Member Functions

int ArrayIndex ()
 Returns the array index.
NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions BooleanValue ()
 Returns the boolean value.
NXString Category ()
 Returns the category.
bool CreateAttribute ()
 Create the attribute from the data set in the builder.
NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions DataType ()
 Returns the data type, which determines the type of attribute to be created.
NXOpen::DateBuilderDateValue ()
 Returns the date value.
void Delete (NXOpen::NXObject *object)
 Delete the attribute from the given object.
void DeleteArray (NXOpen::NXObject *object)
 Delete the attribute array from the given object.
NXOpen::ExpressionExpression ()
 Returns the expression referenced from this attribute.
int IntegerValue ()
 Returns the integer value.
bool IsArray ()
 Returns the 'is array' flag is set for attributes that have more than one value.
bool IsReferenceType ()
 Returns the 'is reference type' flag is set for attributes that are linked to system expressions.
bool LockOnSave ()
 Returns the 'LockOnSave' flag is set for attributes that will be locked once the part is saved (and reloaded)
Created in NX8.0.0.
double NumberValue ()
 Returns the number value.
NXOpen::AttributePropertiesBaseBuilder::ObjectOptions ObjectPicker ()
 Returns the object picker.
NXOpen::SelectNXObjectListSelectedObjects ()
 Returns the selected object(s) list.
void SetArray (bool isArray)
 Sets the 'is array' flag is set for attributes that have more than one value.
void SetArrayIndex (int arrayIndex)
 Sets the array index.
void SetBooleanValue (NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions boolValue)
 Sets the boolean value.
void SetCategory (const NXString &category)
 Sets the category.
void SetDataType (NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions dataType)
 Sets the data type, which determines the type of attribute to be created.
void SetExpression (NXOpen::Expression *expression)
 Sets the expression referenced from this attribute.
void SetIntegerValue (int integerValue)
 Sets the integer value.
void SetLockOnSave (bool lockOnSave)
 Sets the 'LockOnSave' flag is set for attributes that will be locked once the part is saved (and reloaded)
Created in NX8.0.0.
void SetNumberValue (double numberValue)
 Sets the number value.
void SetObjectPicker (NXOpen::AttributePropertiesBaseBuilder::ObjectOptions objectPicker)
 Sets the object picker.
void SetReferenceType (bool isReferenceType)
 Sets the 'is reference type' flag is set for attributes that are linked to system expressions.
void SetStringValue (const NXString &stringValue)
 Sets the string value.
void SetTitle (const NXString &title)
 Sets the attribute title.
void SetUnits (const NXString &units)
 Sets the units associated with an attribute of type Number.
NXString StringValue ()
 Returns the string value.
NXString Title ()
 Returns the attribute title.
NXString Units ()
 Returns the units associated with an attribute of type Number.

Detailed Description

Represents an AttributePropertiesBaseBuilder to be used for creating attributes.

A basic attribute consists of a title, a type, and a value. There are six types of attributes: Null, Boolean, Integer, Number, String, and Date. The type detemines which value field will be read during creation. An attribute may reference an expression instead of setting a value. In this case, the referenced expression's value will also serve as the attribute's value and will update when the expression changes.

If an attribute template exists with the same title as the attribute, then the attribute will assume all characteristics of the cooresponding template including the type. Attribute templates reside at the part level and provide extra information for referencing attributes. They are created using AttributeTemplatesBuilder .

The attribute will be distributed to all objects supplied in the selected object list.
This is an abstract class, and cannot be instantiated.

Created in NX8.0.0.


Member Enumeration Documentation

The value choices for an attribute of type Boolean.

Enumerator:
BooleanValueOptionsFalse 

False.

BooleanValueOptionsTrue 

True.

Specifies the data type of the attribute, this cannot be changed once the attribute has been created.

Enumerator:
DataTypeOptionsNull 

Null, the attribute will have no value.

DataTypeOptionsBoolean 

Boolean, the value will be true or false.

DataTypeOptionsInteger 

Integer, the value is a whole number.

DataTypeOptionsNumber 

Number, the value is a floating point number and may contain units.

DataTypeOptionsString 

String, the value will be a textual string.

DataTypeOptionsDate 

Date, the value will be date and time.

Specifies which object will be used when applying attributes.

The options available are determined by the objects passed in. These options will not be used if the object passed in is a part.

Enumerator:
ObjectOptionsObject 

Apply attribute to the object in the select object list.

ObjectOptionsFeature 

Apply attribute to the feature in the select object list.

ObjectOptionsOccurrence 

Apply attribute to the occurrence only.

ObjectOptionsComponentInstance 

Apply attribute to the instance of the component.

All occurrences of the instance will inherit this attribute.

ObjectOptionsReferenceSet 

Apply attribute to the reference set.

ObjectOptionsObjectInComponentPart 

Apply attribute to the object in the component part.

ObjectOptionsComponentAsPartAttribute 

Apply attribute to the component as a part attribute.

ObjectOptionsEmpty 

No objects are contained in the select object list.


Member Function Documentation

Returns the array index.

Required if modifying an attribute that has more than one value. The IsArray flag must also be set.
Created in NX8.0.0.

License requirements : None

Returns the boolean value.

Required if creating an attribute of type Boolean.
Created in NX8.0.0.

License requirements : None

Returns the category.

The category is an optional, user-defined string that allows attributes to be grouped together.
Created in NX8.0.0.

License requirements : None

Create the attribute from the data set in the builder.

Unlike calling commit, this method will not perform an update.

Returns:
True if the attribute was created/edited successfully
Created in NX8.0.0.

License requirements : None

Returns the data type, which determines the type of attribute to be created.

Once the attribute is created, the data type cannot be modified.
Created in NX8.0.0.

License requirements : None

Returns the date value.

The Date object will contain the value for an attribute of type Date.
Created in NX8.0.0.

License requirements : None

Delete the attribute from the given object.


Created in NX8.0.0.

License requirements : None

Parameters:
objectThe object containing the attribute

Delete the attribute array from the given object.


Created in NX8.0.0.

License requirements : None

Parameters:
objectThe object containing the attribute

Returns the expression referenced from this attribute.

Only used for attributes of type Number, Integer, Boolean, and String. If an expression is referenced, no value fields need to be set, as the attribute uses the value from the expression.
Created in NX8.0.0.

License requirements : None

Returns the integer value.

Required if creating an attribute of type Integer.
Created in NX8.0.0.

License requirements : None

Returns the 'is array' flag is set for attributes that have more than one value.

When this is set, the index needs to be provided to indicate which element will be modified.
Created in NX8.0.0.

License requirements : None

Returns the 'is reference type' flag is set for attributes that are linked to system expressions.

The type must also be set to String for the Reference attribut to be created/edited. If a Reference attribute is no longer linked to a system expression, it will become a String attribute.
Created in NX8.0.0.

License requirements : None

Returns the 'LockOnSave' flag is set for attributes that will be locked once the part is saved (and reloaded)
Created in NX8.0.0.



License requirements : None

Returns the number value.

Required if creating an attribute of type Number.
Created in NX8.0.0.

License requirements : None

Returns the object picker.

This determines what objects the attribute will be applied to. If modified, the select object list will change based on this value.
Created in NX8.0.0.

License requirements : None

Returns the selected object(s) list.

The created attribute will be applied to all objects in this list.
Created in NX8.0.0.

License requirements : None

Sets the 'is array' flag is set for attributes that have more than one value.

When this is set, the index needs to be provided to indicate which element will be modified.
Created in NX8.0.0.

License requirements : None

Parameters:
isArrayisarray

Sets the array index.

Required if modifying an attribute that has more than one value. The IsArray flag must also be set.
Created in NX8.0.0.

License requirements : None

Parameters:
arrayIndexarrayindex

Sets the boolean value.

Required if creating an attribute of type Boolean.
Created in NX8.0.0.

License requirements : None

Parameters:
boolValueboolvalue

Sets the category.

The category is an optional, user-defined string that allows attributes to be grouped together.
Created in NX8.0.0.

License requirements : None

Parameters:
categorycategory

Sets the data type, which determines the type of attribute to be created.

Once the attribute is created, the data type cannot be modified.
Created in NX8.0.0.

License requirements : None

Parameters:
dataTypedatatype

Sets the expression referenced from this attribute.

Only used for attributes of type Number, Integer, Boolean, and String. If an expression is referenced, no value fields need to be set, as the attribute uses the value from the expression.
Created in NX8.0.0.

License requirements : None

Parameters:
expressionexpression

Sets the integer value.

Required if creating an attribute of type Integer.
Created in NX8.0.0.

License requirements : None

Parameters:
integerValueintegervalue

Sets the 'LockOnSave' flag is set for attributes that will be locked once the part is saved (and reloaded)
Created in NX8.0.0.



License requirements : None

Parameters:
lockOnSavelockonsave

Sets the number value.

Required if creating an attribute of type Number.
Created in NX8.0.0.

License requirements : None

Parameters:
numberValuenumbervalue

Sets the object picker.

This determines what objects the attribute will be applied to. If modified, the select object list will change based on this value.
Created in NX8.0.0.

License requirements : None

Parameters:
objectPickerobjectpicker

Sets the 'is reference type' flag is set for attributes that are linked to system expressions.

The type must also be set to String for the Reference attribut to be created/edited. If a Reference attribute is no longer linked to a system expression, it will become a String attribute.
Created in NX8.0.0.

License requirements : None

Parameters:
isReferenceTypeisreferencetype

Sets the string value.

Required if creating an attribute of type String.
Created in NX8.0.0.

License requirements : None

Parameters:
stringValuestringvalue

Sets the attribute title.

The title is required for creating an attribute and must be unique on the given object. Once the attribute is created, the title cannot be modified.
Created in NX8.0.0.

License requirements : None

Parameters:
titletitle

Sets the units associated with an attribute of type Number.

Once the attribute is created, the unit measure (length, area, etc) cannot be changed. However the units (mm, ft, etc) within the measure can be changed.
Created in NX8.0.0.

License requirements : None

Parameters:
unitsunits

Returns the string value.

Required if creating an attribute of type String.
Created in NX8.0.0.

License requirements : None

Returns the attribute title.

The title is required for creating an attribute and must be unique on the given object. Once the attribute is created, the title cannot be modified.
Created in NX8.0.0.

License requirements : None

Returns the units associated with an attribute of type Number.

Once the attribute is created, the unit measure (length, area, etc) cannot be changed. However the units (mm, ft, etc) within the measure can be changed.
Created in NX8.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.