MotionProfileBuilder Class

class NXOpen.Mechatronics.MotionProfileBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Mechatronics.MotionProfile builder.

To create a new instance of this class, use NXOpen.Mechatronics.MotionProfileCollection.CreateMotionProfileBuilder()

New in version NX7.5.1.

Properties

Property Description
CyclicType Returns or sets the cyclic type of a cam profile
IsForElecCam Returns or sets the indicator that a motion profile is designed for a electronic cam
MasterMaximum Returns the masterMax.
MasterMinimum Returns the masterMin.
MasterUnit Returns or sets the masterUnit.
Name Returns or sets the name
SlaveMaximum Returns the slaveMax.
SlaveMinimum Returns the slaveMin.
SlaveUnit Returns or sets the slaveUnit.
Tag Returns the Tag for this object.

Methods

Method Description
AddElement Add element to builder.
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

MotionProfileBuilderMasterValueUnit Enumeration the Master Unit types
MotionProfileBuilderProfileCyclicType Enumeration Indicates which cyclic type should be take.
MotionProfileBuilderSlaveValueUnit Enumeration the Slave Unit types

Property Detail

CyclicType

MotionProfileBuilder.CyclicType

Returns or sets the cyclic type of a cam profile

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

Getter Method

Signature CyclicType

Returns:
Return type:NXOpen.Mechatronics.MotionProfileBuilderProfileCyclicType

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature CyclicType

Parameters:cyclicType (NXOpen.Mechatronics.MotionProfileBuilderProfileCyclicType) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

IsForElecCam

MotionProfileBuilder.IsForElecCam

Returns or sets the indicator that a motion profile is designed for a electronic cam

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

Getter Method

Signature IsForElecCam

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature IsForElecCam

Parameters:isForElecCam (bool) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterMaximum

MotionProfileBuilder.MasterMaximum

Returns the masterMax.

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

Getter Method

Signature MasterMaximum

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterMinimum

MotionProfileBuilder.MasterMinimum

Returns the masterMin.

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

Getter Method

Signature MasterMinimum

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterUnit

MotionProfileBuilder.MasterUnit

Returns or sets the masterUnit.

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

Getter Method

Signature MasterUnit

Returns:
Return type:NXOpen.Mechatronics.MotionProfileBuilderMasterValueUnit

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature MasterUnit

Parameters:masterUnit (NXOpen.Mechatronics.MotionProfileBuilderMasterValueUnit) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Name

MotionProfileBuilder.Name

Returns or sets the name

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SlaveMaximum

MotionProfileBuilder.SlaveMaximum

Returns the slaveMax.

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

Getter Method

Signature SlaveMaximum

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SlaveMinimum

MotionProfileBuilder.SlaveMinimum

Returns the slaveMin.

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

Getter Method

Signature SlaveMinimum

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SlaveUnit

MotionProfileBuilder.SlaveUnit

Returns or sets the slaveUnit.

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

Getter Method

Signature SlaveUnit

Returns:
Return type:NXOpen.Mechatronics.MotionProfileBuilderSlaveValueUnit

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

Setter Method

Signature SlaveUnit

Parameters:slaveUnit (NXOpen.Mechatronics.MotionProfileBuilderSlaveValueUnit) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail

AddElement

MotionProfileBuilder.AddElement

Add element to builder.

Signature AddElement(part, name, masterPos, slavePos, vin, vout, ain, aout, vinEqVout, ainEqAout, constantSpeed)

Parameters:
  • part (NXOpen.NXObject) –
  • name (str) –
  • masterPos (float) –
  • slavePos (float) –
  • vin (float) –
  • vout (float) –
  • ain (float) –
  • aout (float) –
  • vinEqVout (bool) –
  • ainEqAout (bool) –
  • constantSpeed (bool) –

New in version NX8.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate

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