ComponentConstraintGroupBuilder Class

class NXOpen.Positioning.ComponentConstraintGroupBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Positioning.ComponentConstraintGroupBuilder builder

To create a new instance of this class, use NXOpen.Assemblies.ComponentAssembly.CreateConstraintGroupBuilder()

Default values.

Property	Value
ConstraintCollectionType	BetweenSelectedComponents
RememberComponentState	true

New in version NX8.0.1.

Properties

Property	Description
ConstraintCollectionType	Returns or sets the constraint collection types
ConstraintGroupName	Returns or sets the name of constraint group
RememberComponentState	Returns or sets the toggle to remember selected component
SelectedComponentList	Returns the selected components list
SelectedConstraintsList	Returns the selected constraint list
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.
GetContextComponent	Gets the context component which is used to decide the displayed constraints that can be in the selected constraints list.
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.

Property Detail

ConstraintCollectionType

ComponentConstraintGroupBuilder.ConstraintCollectionType

Returns or sets the constraint collection types

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

Getter Method

Signature ConstraintCollectionType

Returns: Return type:NXOpen.Positioning.ComponentConstraintGroupConstraintsCollectionType

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

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

Setter Method

Signature ConstraintCollectionType

Parameters:constraintCollectionType (NXOpen.Positioning.ComponentConstraintGroupConstraintsCollectionType) –

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

ConstraintGroupName

ComponentConstraintGroupBuilder.ConstraintGroupName

Returns or sets the name of constraint group

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

Getter Method

Signature ConstraintGroupName

Returns: Return type:str

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

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

Setter Method

Signature ConstraintGroupName

Parameters:nameOfConstraintGroup (str) –

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

RememberComponentState

ComponentConstraintGroupBuilder.RememberComponentState

Returns or sets the toggle to remember selected component

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

Getter Method

Signature RememberComponentState

Returns: Return type:bool

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

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

Setter Method

Signature RememberComponentState

Parameters:rememberComponentState (bool) –

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SelectedComponentList

ComponentConstraintGroupBuilder.SelectedComponentList

Returns the selected components list

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

Getter Method

Signature SelectedComponentList

Returns: Return type:NXOpen.SelectDisplayableObjectList

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

SelectedConstraintsList

ComponentConstraintGroupBuilder.SelectedConstraintsList

Returns the selected constraint list

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

Getter Method

Signature SelectedConstraintsList

Returns: Return type:NXOpen.SelectDisplayableObjectList

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Method Detail

GetContextComponent

ComponentConstraintGroupBuilder.GetContextComponent

Gets the context component which is used to decide the displayed constraints that can be in the selected constraints list.

The context component is only set by the creator and can be None. If the context component is None the displayed constraints will be in same part as the constraint group.

Signature GetContextComponent()

Returns: Return type:NXOpen.Assemblies.Component

New in version NX8.0.1.

License requirements: assemblies (“ASSEMBLIES MODULE”)

Validate

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