AddSubmechanismBuilder Class

class NXOpen.Motion.AddSubmechanismBuilder

Bases: NXOpen.Builder, NXOpen.IAttributeSourceObjectBuilder

Represents a builder class that performs add submechanism in current context.

To create a new instance of this class, use NXOpen.Motion.MotionSimulation.CreateAddSubmechanismBuilder()

Default values.

Property Value
LayerOption Original
UserLayer 1

New in version NX12.0.0.

Properties

Property Description
LayerOption Returns or sets the layers to which geometry are added
SelectedPart Returns or sets the Motion Simulation part to add as sumbechanism
Tag Returns the Tag for this object.
UserLayer Returns or sets the user defined layer (should be a value in the range 1-256)

Methods

Method Description
AutoAssignAttributes Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.
AutoAssignAttributesWithNamingPattern Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.
Commit Commits any edits that have been applied to the builder.
CreateAttributeTitleToNamingPatternMap Creates a map object of attribute titles to their corresponding naming pattern
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

AddSubmechanismBuilderLayer Enumeration Represents initial location type that can be present during add component

Property Detail

LayerOption

AddSubmechanismBuilder.LayerOption

Returns or sets the layers to which geometry are added

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

Getter Method

Signature LayerOption

Returns:
Return type:NXOpen.Motion.AddSubmechanismBuilderLayer

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature LayerOption

Parameters:layerOption (NXOpen.Motion.AddSubmechanismBuilderLayer) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

SelectedPart

AddSubmechanismBuilder.SelectedPart

Returns or sets the Motion Simulation part to add as sumbechanism

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

Getter Method

Signature SelectedPart

Returns:
Return type:NXOpen.NXObject

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature SelectedPart

Parameters:part (NXOpen.NXObject) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

UserLayer

AddSubmechanismBuilder.UserLayer

Returns or sets the user defined layer (should be a value in the range 1-256)

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

Getter Method

Signature UserLayer

Returns:
Return type:int

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature UserLayer

Parameters:layer (int) –

New in version NX12.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

AutoAssignAttributes

AddSubmechanismBuilder.AutoAssignAttributes

Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

Signature AutoAssignAttributes(objects)

Parameters:objects (list of NXOpen.NXObject) –
Returns:
Return type:NXOpen.ErrorList

New in version NX8.5.0.

License requirements: None.

AutoAssignAttributesWithNamingPattern

AddSubmechanismBuilder.AutoAssignAttributesWithNamingPattern

Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

properties needs to be created using CreateAttributeTitleToNamingPatternMap()

Signature AutoAssignAttributesWithNamingPattern(objects, properties)

Parameters:
Returns:
Return type:

NXOpen.ErrorList

New in version NX12.0.0.

License requirements: None.

CreateAttributeTitleToNamingPatternMap

AddSubmechanismBuilder.CreateAttributeTitleToNamingPatternMap

Creates a map object of attribute titles to their corresponding naming pattern

Signature CreateAttributeTitleToNamingPatternMap(attributeTitles, titlePatterns)

Parameters:
  • attributeTitles (list of str) –
  • titlePatterns (list of str) –
Returns:
Return type:

NXOpen.NXObject

New in version NX12.0.0.

License requirements: None.

Validate

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