NXOpen::Mechatronics::PathConstraintFrameBuilder Class Reference

Represents a frame that constrains the orientation along the path curve. More...

Inheritance diagram for NXOpen::Mechatronics::PathConstraintFrameBuilder:

Public Types
enum	CurveTypes { CurveTypesLine, CurveTypesSpline }
	the curve types More...

Public Member Functions
NXOpen::NXObject *	AssociatedCurve ()
	Returns the associated curve. More...
NXOpen::Mechatronics::PathConstraintFrameBuilder::CurveTypes	CurveType ()
	Returns the curve type. More...
NXOpen::CoordinateSystem *	PathFrame ()
	Returns the path frame. More...
double	PathParameter ()
	Returns the path parameter. More...
void	SetAssociatedCurve (NXOpen::NXObject *curve)
	Sets the associated curve. More...
void	SetCurveType (NXOpen::Mechatronics::PathConstraintFrameBuilder::CurveTypes curveType)
	Sets the curve type. More...
void	SetPathFrame (NXOpen::CoordinateSystem *pathFrame)
	Sets the path frame. More...
void	SetPathParameter (double pathParameter)
	Sets the path parameter. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a frame that constrains the orientation along the path curve.

To create a new instance of this class, use NXOpen::Mechatronics::PathConstraintJointBuilder::NewPathFrame

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::Mechatronics::PathConstraintFrameBuilder::CurveTypes

the curve types

Enumerator
CurveTypesLine	line
CurveTypesSpline	spline

Member Function Documentation

NXOpen::NXObject* NXOpen::Mechatronics::PathConstraintFrameBuilder::AssociatedCurve

(

)

Returns the associated curve.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::PathConstraintFrameBuilder::CurveTypes NXOpen::Mechatronics::PathConstraintFrameBuilder::CurveType

(

)

Returns the curve type.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::CoordinateSystem* NXOpen::Mechatronics::PathConstraintFrameBuilder::PathFrame

(

)

Returns the path frame.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

double NXOpen::Mechatronics::PathConstraintFrameBuilder::PathParameter

(

)

Returns the path parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::PathConstraintFrameBuilder::SetAssociatedCurve

(

NXOpen::NXObject *

curve

)

Sets the associated curve.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

curve

curve

void NXOpen::Mechatronics::PathConstraintFrameBuilder::SetCurveType

(

NXOpen::Mechatronics::PathConstraintFrameBuilder::CurveTypes

curveType

)

Sets the curve type.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

curveType

curvetype

void NXOpen::Mechatronics::PathConstraintFrameBuilder::SetPathFrame

(

NXOpen::CoordinateSystem *

pathFrame

)

Sets the path frame.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

pathFrame

pathframe

void NXOpen::Mechatronics::PathConstraintFrameBuilder::SetPathParameter

(

double

pathParameter

)

Sets the path parameter.

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters

pathParameter

pathparameter

virtual bool NXOpen::Mechatronics::PathConstraintFrameBuilder::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

The documentation for this class was generated from the following file:

• Mechatronics_PathConstraintFrameBuilder.hxx