PathConstraintFrameBuilder Class¶
-
class
NXOpen.Mechatronics.
PathConstraintFrameBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a frame that constrains the orientation along the path curve.
To create a new instance of this class, use
NXOpen.Mechatronics.PathConstraintJointBuilder.NewPathFrame
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
AssociatedCurve | Returns or sets the associated curve. |
CurveType | Returns or sets the curve type. |
PathFrame | Returns or sets the path frame. |
PathParameter | Returns or sets the path parameter. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
PathConstraintFrameBuilderCurveTypes Enumeration | the curve types |
Property Detail¶
AssociatedCurve¶
-
PathConstraintFrameBuilder.
AssociatedCurve
¶ Returns or sets the associated curve.
-------------------------------------
Getter Method
Signature
AssociatedCurve()
Returns: Return type: NXOpen.NXObject
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
AssociatedCurve(curve)
Parameters: curve ( NXOpen.NXObject
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CurveType¶
-
PathConstraintFrameBuilder.
CurveType
¶ Returns or sets the curve type.
-------------------------------------
Getter Method
Signature
CurveType()
Returns: Return type: NXOpen.Mechatronics.PathConstraintFrameBuilderCurveTypes
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CurveType(curveType)
Parameters: curveType ( NXOpen.Mechatronics.PathConstraintFrameBuilderCurveTypes
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
PathFrame¶
-
PathConstraintFrameBuilder.
PathFrame
¶ Returns or sets the path frame.
-------------------------------------
Getter Method
Signature
PathFrame()
Returns: Return type: NXOpen.CoordinateSystem
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
PathFrame(pathFrame)
Parameters: pathFrame ( NXOpen.CoordinateSystem
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
PathParameter¶
-
PathConstraintFrameBuilder.
PathParameter
¶ Returns or sets the path parameter.
-------------------------------------
Getter Method
Signature
PathParameter()
Returns: Return type: float New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
PathParameter(pathParameter)
Parameters: pathParameter (float) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
PathConstraintFrameBuilder.
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.