EffectivityAttributePropertiesBuilder Class

class NXOpen.PDM.EffectivityAttributePropertiesBuilder

Bases: NXOpen.Builder

Represents an NXOpen.PDM.EffectivityAttributePropertiesBuilder to be used for creating effectivity attributes.

The attribute will be distributed to all objects supplied in the selected object list.

To create a new instance of this class, use NXOpen.PDM.ConfigurationManager.CreateEffectivityAttributePropertiesBuilder()

New in version NX9.0.0.

Properties

Property	Description
Category	Returns or sets the category.
DisplayValue	Returns or sets the display value.
EffectivityTableBuilder	Returns the effectivity table builder.
SelectedObjects	Returns the selected object(s) list.
StringValue	Returns or sets the string value.
Tag	Returns the Tag for this object.
Title	Returns or sets the attribute title.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CreateAttribute	Create the attribute from the data set in the builder.
Delete	Delete the attribute from the given object.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
SetAttributeObjects	Sets the array of objects that have this attribute
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Category

EffectivityAttributePropertiesBuilder.Category

Returns or sets the category.

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

-------------------------------------

Getter Method

Signature Category

Returns: Return type:str

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature Category

Parameters:category (str) –

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

DisplayValue

EffectivityAttributePropertiesBuilder.DisplayValue

Returns or sets the display value.

Required if creating an attribute of type String.

-------------------------------------

Getter Method

Signature DisplayValue

Returns: Return type:str

New in version NX10.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature DisplayValue

Parameters:displayValue (str) –

New in version NX10.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

EffectivityTableBuilder

EffectivityAttributePropertiesBuilder.EffectivityTableBuilder

Returns the effectivity table builder.

-------------------------------------

Getter Method

Signature EffectivityTableBuilder

Returns: Return type:NXOpen.PDM.EffectivityTableBuilder

New in version NX9.0.0.

License requirements: None.

SelectedObjects

EffectivityAttributePropertiesBuilder.SelectedObjects

Returns the selected object(s) list.

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

-------------------------------------

Getter Method

Signature SelectedObjects

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

StringValue

EffectivityAttributePropertiesBuilder.StringValue

Returns or sets the string value.

Required if creating an attribute of type String.

-------------------------------------

Getter Method

Signature StringValue

Returns: Return type:str

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature StringValue

Parameters:stringValue (str) –

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Title

EffectivityAttributePropertiesBuilder.Title

Returns or 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.

-------------------------------------

Getter Method

Signature Title

Returns: Return type:str

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

-------------------------------------

Setter Method

Signature Title

Parameters:title (str) –

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Method Detail

CreateAttribute

EffectivityAttributePropertiesBuilder.CreateAttribute

Create the attribute from the data set in the builder.

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

Signature CreateAttribute()

Returns:True if the attribute was created/edited successfully Return type:bool

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Delete

EffectivityAttributePropertiesBuilder.Delete

Delete the attribute from the given object.

Signature Delete(object)

Parameters:object (NXOpen.NXObject) – The object containing the attribute

New in version NX9.0.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

SetAttributeObjects

EffectivityAttributePropertiesBuilder.SetAttributeObjects

Sets the array of objects that have this attribute

Signature SetAttributeObjects(objects)

Parameters:objects (list of NXOpen.NXObject) – the array of objects

New in version NX8.5.0.

License requirements: nx_4gd_integration (“4th Generation Design”)

Validate

EffectivityAttributePropertiesBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.