NX Open C++ Reference Guide
Public Types | List of all members
NXOpen::AttributePropertiesBuilder Class Reference

Represents an NXOpen::AttributePropertiesBuilder . More...

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

Public Types

enum  OperationType {
  OperationTypeNone = -1, OperationTypeCreate, OperationTypeRevise, OperationTypeSaveAs,
  OperationTypeSave, OperationTypeDelete
}
 It is used to determine the behaviors of attributes that has been mapped from TC, such as Hidden, Required, CopyFromOriginal, etc. More...
 
- Public Types inherited from NXOpen::AttributePropertiesBaseBuilder
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...
 

Additional Inherited Members

- Public Member Functions inherited from NXOpen::AttributePropertiesBaseBuilder
bool ApplyUnits ()
 Apply the units currently set on the builder to any objects that have a value set for the current attribute. More...
 
int ArrayIndex ()
 Returns the array index. More...
 
NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions BooleanValue ()
 Returns the boolean value. More...
 
NXString Category ()
 Returns the category. More...
 
bool CreateAttribute ()
 Create the attribute from the data set in the builder. More...
 
NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions DataType ()
 Returns the data type, which determines the type of attribute to be created. More...
 
NXOpen::DateBuilderDateValue ()
 Returns the date value. More...
 
void Delete (NXOpen::NXObject *object)
 Delete the attribute from the given object. More...
 
void DeleteArray (NXOpen::NXObject *object)
 Delete the attribute array from the given object. More...
 
NXOpen::ExpressionExpression ()
 Returns the expression referenced from this attribute. More...
 
int IntegerValue ()
 Returns the integer value. More...
 
bool IsArray ()
 Returns the 'is array' flag is set for attributes that have more than one value. More...
 
bool IsReferenceType ()
 Returns the 'is reference type' flag is set for attributes that are linked to system expressions. More...
 
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. More...
 
double NumberValue ()
 Returns the number value. More...
 
NXOpen::AttributePropertiesBaseBuilder::ObjectOptions ObjectPicker ()
 Returns the object picker. More...
 
NXOpen::SelectNXObjectListSelectedObjects ()
 Returns the selected object(s) list. More...
 
void SetArray (bool isArray)
 Sets the 'is array' flag is set for attributes that have more than one value. More...
 
void SetArrayIndex (int arrayIndex)
 Sets the array index. More...
 
void SetAttributeObjects (const std::vector< NXOpen::NXObject * > &objects)
 Sets the array of objects that have this attribute
Created in NX8.5.0. More...
 
void SetBooleanValue (NXOpen::AttributePropertiesBaseBuilder::BooleanValueOptions boolValue)
 Sets the boolean value. More...
 
void SetCategory (const NXString &category)
 Sets the category. More...
 
void SetCategory (const char *category)
 Sets the category. More...
 
void SetDataType (NXOpen::AttributePropertiesBaseBuilder::DataTypeOptions dataType)
 Sets the data type, which determines the type of attribute to be created. More...
 
void SetExpression (NXOpen::Expression *expression)
 Sets the expression referenced from this attribute. More...
 
void SetIntegerValue (int integerValue)
 Sets the integer value. More...
 
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. More...
 
void SetNumberValue (double numberValue)
 Sets the number value. More...
 
void SetObjectPicker (NXOpen::AttributePropertiesBaseBuilder::ObjectOptions objectPicker)
 Sets the object picker. More...
 
void SetReferenceType (bool isReferenceType)
 Sets the 'is reference type' flag is set for attributes that are linked to system expressions. More...
 
void SetStringValue (const NXString &stringValue)
 Sets the string value. More...
 
void SetStringValue (const char *stringValue)
 Sets the string value. More...
 
void SetTitle (const NXString &title)
 Sets the attribute title. More...
 
void SetTitle (const char *title)
 Sets the attribute title. More...
 
void SetUnits (const NXString &units)
 Sets the units associated with an attribute of type Number. More...
 
void SetUnits (const char *units)
 Sets the units associated with an attribute of type Number. More...
 
void SetValueAlias (const NXString &valueAlias)
 Sets the value alias. More...
 
void SetValueAlias (const char *valueAlias)
 Sets the value alias. More...
 
NXString StringValue ()
 Returns the string value. More...
 
NXString Title ()
 Returns the attribute title. More...
 
NXString Units ()
 Returns the units associated with an attribute of type Number. More...
 
NXString ValueAlias ()
 Returns the value alias. More...
 

Detailed Description

Represents an NXOpen::AttributePropertiesBuilder .

Input to this class can be PSM facet objects.
To create a new instance of this class, use NXOpen::AttributeManager::CreateAttributePropertiesBuilder
Default values.

Property Value

BooleanValue

False

DataType

String

IntegerValue

0

NumberValue

0

ObjectPicker (deprecated)

Object


Created in NX8.0.0.

Member Enumeration Documentation

It is used to determine the behaviors of attributes that has been mapped from TC, such as Hidden, Required, CopyFromOriginal, etc.

Mapped attributes can be from Hardwired Attributes, Create Descriptor, Revise Descriptor or attribute mapping file. Proper operation type should be set when applicable, otherwise the system may not behave correctly. For example, if you ask if an attribute is required or not with OpType "None", it will always say No. But the same attribute may be required for "Create", or "Save As" or "Revise", etc. So Attribute templates from Teamcenter are able to force different behaviors on attributes based on whether they are being shown in item creation, edit or saveAs.

Enumerator
OperationTypeNone 

None.

This should be chosen if attribute is not required for the operation.

OperationTypeCreate 

Create.

This should be chosen if attribute is required for create operation.

OperationTypeRevise 

Revise.

This should be chosen if attribute is required for revise operation.

OperationTypeSaveAs 

SaveAs.

This should be chosen if attribute is required for Save As operation.

OperationTypeSave 

Save.

This should be chosen if attribute is required for save operation.

OperationTypeDelete 

Delete.

This should be chosen if attribute is required for delete operation.


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