ElementModifyLabelBuilder Class

class NXOpen.CAE.ElementModifyLabelBuilder

Bases: NXOpen.Builder

Represents a NXOpen.CAE.ElementModifyLabelBuilder

To create a new instance of this class, use NXOpen.CAE.NodeElementManager.CreateElementModifyLabelBuilder()

New in version NX5.0.0.

Properties

Property	Description
Elements	Returns the elements whose labels are to be modified
Increment	Returns or sets the increment
Label	Returns or sets the label
LabelOption	Returns or sets the label option, label/increment or offset
Offset	Returns or sets the offset
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
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.
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.

Enumerations

ElementModifyLabelBuilderLabelType Enumeration

the label types

Property Detail

Elements

ElementModifyLabelBuilder.Elements

Returns the elements whose labels are to be modified

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

Getter Method

Signature Elements

Returns: Return type:NXOpen.CAE.SelectElementsBuilder

New in version NX5.0.0.

License requirements: None.

Increment

ElementModifyLabelBuilder.Increment

Returns or sets the increment

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

Getter Method

Signature Increment

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Increment

Parameters:increment (int) –

New in version NX5.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Label

ElementModifyLabelBuilder.Label

Returns or sets the label

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

Getter Method

Signature Label

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Label

Parameters:label (int) –

New in version NX5.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

LabelOption

ElementModifyLabelBuilder.LabelOption

Returns or sets the label option, label/increment or offset

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

Getter Method

Signature LabelOption

Returns: Return type:NXOpen.CAE.ElementModifyLabelBuilderLabelType

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature LabelOption

Parameters:labelOption (NXOpen.CAE.ElementModifyLabelBuilderLabelType) –

New in version NX5.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Offset

ElementModifyLabelBuilder.Offset

Returns or sets the offset

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

Getter Method

Signature Offset

Returns: Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Offset

Parameters:offset (int) –

New in version NX5.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Method Detail

Validate

ElementModifyLabelBuilder.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.