GearBuilder Class

class NXOpen.Mechatronics.GearBuilder

Bases: NXOpen.Mechatronics.CouplingBuilder

Represents a NXOpen.Mechatronics.Gear builder.

To create a new instance of this class, use NXOpen.Mechatronics.GearCollection.CreateGearBuilder()

New in version NX7.5.1.

Properties

Property Description
AllowSlip Returns or sets the coulping can slip or not.
AxisType Returns or sets the axis joint type.
ExpressionMasterMultiple Returns the master multiple expression.
ExpressionSlaveMultiple Returns the slave multiple expression.
MasterAxisJoint Returns the master axis joint.
MasterMultiple Returns or sets the master multiple.
Name Returns or sets the name.
SlaveAxisJoint Returns the slave axis joint.
SlaveMultiple Returns or sets the slave multiple.
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.
SetMasterAxisJoint Sets the master axis.
SetSlaveAxisJoint Sets the slave axis.
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

GearBuilderAxisJointType Enumeration the axis joint types.

Property Detail

AxisType

GearBuilder.AxisType

Returns or sets the axis joint type.

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

Getter Method

Signature AxisType

Returns:
Return type:NXOpen.Mechatronics.GearBuilderAxisJointType

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature AxisType

Parameters:axisType (NXOpen.Mechatronics.GearBuilderAxisJointType) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ExpressionMasterMultiple

GearBuilder.ExpressionMasterMultiple

Returns the master multiple expression.

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

Getter Method

Signature ExpressionMasterMultiple

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ExpressionSlaveMultiple

GearBuilder.ExpressionSlaveMultiple

Returns the slave multiple expression.

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

Getter Method

Signature ExpressionSlaveMultiple

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterMultiple

GearBuilder.MasterMultiple

Returns or sets the master multiple.

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

Getter Method

Signature MasterMultiple

Returns:
Return type:float

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature MasterMultiple

Parameters:masterMultiple (float) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SlaveMultiple

GearBuilder.SlaveMultiple

Returns or sets the slave multiple.

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

Getter Method

Signature SlaveMultiple

Returns:
Return type:float

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SlaveMultiple

Parameters:slaveMultiple (float) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

Validate

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