LimitSwitchBuilder Class

class NXOpen.Mechatronics.LimitSwitchBuilder

Bases: NXOpen.Mechatronics.PhysicsConstraintBuilder

Represents a NXOpen.Mechatronics.LimitSwitch builder.

To create a new instance of this class, use NXOpen.Mechatronics.LimitSwitchCollection.CreateLimitSwitchBuilder()

New in version NX11.0.0.

Properties

Property Description
EnableLowerLimit
Returns or sets the lower limit option. If the enable is true, then the physics object will be applied a lower limit.
EnableUpperLimit
Returns or sets the upper limit option. If the enable is true, then the physics object will be applied an upper limit.
LowerLimit
Returns the lower limit used to judge whether need to switch the state.
Name Returns or sets the name.
PersistentTag
Returns or sets the Persistent Tag used in the physics object
SelectedPhysicsObject
Returns the physics select. This can be a physics object.
Tag Returns the Tag for this object.
UpperLimit
Returns the upper limit used to judge whether need to switch the state.

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.

Property Detail

EnableLowerLimit

LimitSwitchBuilder.EnableLowerLimit

Returns or sets the lower limit option. If the enable is true, then the physics object will be applied a lower limit.

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

Getter Method

Signature EnableLowerLimit()

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature EnableLowerLimit(enable)

Parameters:enable (bool) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

EnableUpperLimit

LimitSwitchBuilder.EnableUpperLimit

Returns or sets the upper limit option. If the enable is true, then the physics object will be applied an upper limit.

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

Getter Method

Signature EnableUpperLimit()

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature EnableUpperLimit(enable)

Parameters:enable (bool) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

LowerLimit

LimitSwitchBuilder.LowerLimit

Returns the lower limit used to judge whether need to switch the state.

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

Getter Method

Signature LowerLimit()

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

PersistentTag

LimitSwitchBuilder.PersistentTag

Returns or sets the Persistent Tag used in the physics object

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

Getter Method

Signature PersistentTag()

Returns:
Return type:int

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature PersistentTag(persistentTag)

Parameters:persistentTag (int) –

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SelectedPhysicsObject

LimitSwitchBuilder.SelectedPhysicsObject

Returns the physics select. This can be a physics object.

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

Getter Method

Signature SelectedPhysicsObject()

Returns:
Return type:NXOpen.SelectNXObject

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

UpperLimit

LimitSwitchBuilder.UpperLimit

Returns the upper limit used to judge whether need to switch the state.

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

Getter Method

Signature UpperLimit()

Returns:
Return type:NXOpen.Expression

New in version NX11.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

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