GraphControlBuilder Class¶
-
class
NXOpen.Mechatronics.
GraphControlBuilder
¶ Bases:
NXOpen.Mechatronics.PhysicsConstraintBuilder
Represents a
NXOpen.Mechatronics.GraphControl
builderTo create a new instance of this class, use
NXOpen.Mechatronics.GraphControlCollection.CreateGraphControlBuilder
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
CamProfile | Returns or sets a cam profile that contains a number of curves that describes the dependency of the motion of a Slave Axis with respect to the Master Axis. |
GraphEndAction | Returns or sets the graph end action. |
InitialTime | Returns the initial offset. |
MasterAxisType | Returns or sets the master axis type |
MasterOffset | Returns an offset that specifies from the master axis zero point relative to the path zero point for path interpolation. |
MasterScaleFactor | Returns the transformation that is described between the normalized representation to the absolute values. |
MasterUnit | Returns or sets the master value unit |
MotionProfile | Returns or sets the motion profile. |
Name | Returns or sets the name. |
SelectAxisControl | Returns the select axis control. |
SelectMasterJoint | Returns the select axis joint. |
SelectMasterSignal | Returns the select axis joint. |
SlaveOffset | Returns an offset that specifies from the master slave zero point relative to the path zero point for path interpolation. |
SlaveScaleFactor | Returns the transformation that is described between the normalized representation to the absolute values. |
SlaveUnit | Returns or sets the slave value unit |
Tag | Returns the Tag for this object. |
ValueOffset | Returns the value offset. |
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. |
Enumerations¶
GraphControlBuilderEndAction Enumeration | the action in the end of graph. |
GraphControlBuilderMasterJointType Enumeration | the Master axis types. |
GraphControlBuilderMasterValueUnit Enumeration | the Master Unit types. |
GraphControlBuilderSlaveValueUnit Enumeration | the Slave Unit types. |
Property Detail¶
CamProfile¶
-
GraphControlBuilder.
CamProfile
¶ Returns or sets a cam profile that contains a number of curves that describes the dependency of the motion of a Slave Axis with respect to the Master Axis.
This can be
NXOpen.Mechatronics.CamProfile
.-------------------------------------
Getter Method
Signature
CamProfile()
Returns: Return type: NXOpen.Mechatronics.CamProfile
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CamProfile(profile)
Parameters: profile ( NXOpen.Mechatronics.CamProfile
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
GraphEndAction¶
-
GraphControlBuilder.
GraphEndAction
¶ Returns or sets the graph end action.
-------------------------------------
Getter Method
Signature
GraphEndAction()
Returns: Return type: NXOpen.Mechatronics.GraphControlBuilderEndAction
New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
GraphEndAction(graphEndAction)
Parameters: graphEndAction ( NXOpen.Mechatronics.GraphControlBuilderEndAction
) –New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
InitialTime¶
-
GraphControlBuilder.
InitialTime
¶ Returns the initial offset.
-------------------------------------
Getter Method
Signature
InitialTime()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
MasterAxisType¶
-
GraphControlBuilder.
MasterAxisType
¶ Returns or sets the master axis type
-------------------------------------
Getter Method
Signature
MasterAxisType()
Returns: Return type: NXOpen.Mechatronics.GraphControlBuilderMasterJointType
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MasterAxisType(type)
Parameters: type ( NXOpen.Mechatronics.GraphControlBuilderMasterJointType
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
MasterOffset¶
-
GraphControlBuilder.
MasterOffset
¶ Returns an offset that specifies from the master axis zero point relative to the path zero point for path interpolation.
-------------------------------------
Getter Method
Signature
MasterOffset()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
MasterScaleFactor¶
-
GraphControlBuilder.
MasterScaleFactor
¶ Returns the transformation that is described between the normalized representation to the absolute values.
It applied to slave axis.
-------------------------------------
Getter Method
Signature
MasterScaleFactor()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
MasterUnit¶
-
GraphControlBuilder.
MasterUnit
¶ Returns or sets the master value unit
-------------------------------------
Getter Method
Signature
MasterUnit()
Returns: Return type: NXOpen.Mechatronics.GraphControlBuilderMasterValueUnit
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MasterUnit(masterType)
Parameters: masterType ( NXOpen.Mechatronics.GraphControlBuilderMasterValueUnit
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
MotionProfile¶
-
GraphControlBuilder.
MotionProfile
¶ Returns or sets the motion profile.
This can be
NXOpen.Mechatronics.MotionProfile
.-------------------------------------
Getter Method
Signature
MotionProfile()
Returns: Return type: NXOpen.Mechatronics.MotionProfile
New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
MotionProfile(profile)
Parameters: profile ( NXOpen.Mechatronics.MotionProfile
) –New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SelectAxisControl¶
-
GraphControlBuilder.
SelectAxisControl
¶ Returns the select axis control.
This can be a
NXOpen.Mechatronics.SpeedControl
,NXOpen.Mechatronics.PositionControl
.-------------------------------------
Getter Method
Signature
SelectAxisControl()
Returns: Return type: NXOpen.Mechatronics.SelectPhysicsConstraint
New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SelectMasterJoint¶
-
GraphControlBuilder.
SelectMasterJoint
¶ Returns the select axis joint.
This can be a *
NXOpen.Mechatronics.HingeJoint
,NXOpen.Mechatronics.SlidingJoint
,NXOpen.Mechatronics.CylindricalJoint
.-------------------------------------
Getter Method
Signature
SelectMasterJoint()
Returns: Return type: NXOpen.Mechatronics.SelectPhysicsJoint
New in version NX9.0.0.
License requirements: None.
SelectMasterSignal¶
-
GraphControlBuilder.
SelectMasterSignal
¶ Returns the select axis joint.
This can be a *
NXOpen.Mechatronics.AdapterSignal
.-------------------------------------
Getter Method
Signature
SelectMasterSignal()
Returns: Return type: NXOpen.Mechatronics.SelectAdapterSignal
New in version NX10.0.0.
License requirements: None.
SlaveOffset¶
-
GraphControlBuilder.
SlaveOffset
¶ Returns an offset that specifies from the master slave zero point relative to the path zero point for path interpolation.
-------------------------------------
Getter Method
Signature
SlaveOffset()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
SlaveScaleFactor¶
-
GraphControlBuilder.
SlaveScaleFactor
¶ Returns the transformation that is described between the normalized representation to the absolute values.
It applied to slave axis.
-------------------------------------
Getter Method
Signature
SlaveScaleFactor()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
SlaveUnit¶
-
GraphControlBuilder.
SlaveUnit
¶ Returns or sets the slave value unit
-------------------------------------
Getter Method
Signature
SlaveUnit()
Returns: Return type: NXOpen.Mechatronics.GraphControlBuilderSlaveValueUnit
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SlaveUnit(slaveType)
Parameters: slaveType ( NXOpen.Mechatronics.GraphControlBuilderSlaveValueUnit
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ValueOffset¶
-
GraphControlBuilder.
ValueOffset
¶ Returns the value offset.
-------------------------------------
Getter Method
Signature
ValueOffset()
Returns: Return type: NXOpen.Expression
New in version NX8.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
GraphControlBuilder.
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.