NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Motion::JointDefine Class Reference

Represents a joint define object. More...

Inheritance diagram for NXOpen::Motion::JointDefine:
NXOpen::TaggedObject

List of all members.

Public Types

enum  OrientationType { OrientationTypeVector, OrientationTypeCsys }
 Defines the orientation type of joint. More...
enum  Type {
  TypeRevolute, TypeSlider, TypeCylindrical, TypeScrew,
  TypeUniversal, TypeSpherical, TypePlanar, TypeFixed,
  TypeConstantvelocity, TypeAtpoint, TypeInline, TypeInplane,
  TypeOrientation, TypeParallel, TypePerpendicular
}
 Joint define type. More...

Public Member Functions

double DisplayScale ()
 Returns the display scale
Created in NX5.0.0.
NXOpen::CoordinateSystemFirstCsys ()
 Returns the csys of first link
Created in NX5.0.0.
NXOpen::Motion::LinkFirstLink ()
 Returns the first link object
Created in NX5.0.0.
NXOpen::NXMatrixFirstMatrix ()
 Returns the matrix of first link
Created in NX5.0.0.
NXOpen::Motion::JointDefine::OrientationType FirstOrientationType ()
 Returns the first orientation type of joint
Created in NX8.0.0.
NXOpen::PointFirstOrigin ()
 Returns the origin of first link
Created in NX5.0.0.
NXOpen::DirectionFirstVector ()
 Returns the direction of first link
Created in NX5.0.0.
NXOpen::Motion::JointDefine::Type JointType ()
 Returns the joint type
Created in NX5.0.0.
bool LimitsDefined ()
 Returns the option of defining limits for joint
Created in NX5.0.0.
double LowerLimit ()
 Returns the lower limit.
NXOpen::ExpressionLowerLimitAngleExpression ()
 Returns the lower limit angular expression.
NXOpen::ExpressionLowerLimitExpression ()
 Returns the lower limit expression.
NXString Name ()
 Returns the joint name
Created in NX5.0.0.
double ScrewRatio ()
 Returns the screw ratio.
NXOpen::ExpressionScrewRatioExpression ()
 Returns the screw ratio expression.
NXOpen::CoordinateSystemSecondCsys ()
 Returns the csys of second link
Created in NX5.0.0.
NXOpen::Motion::LinkSecondLink ()
 Returns the second link
Created in NX5.0.0.
NXOpen::NXMatrixSecondMatrix ()
 Returns the matrix of second link
Created in NX5.0.0.
NXOpen::Motion::JointDefine::OrientationType SecondOrientationType ()
 Returns the second orientation type of joint
Created in NX8.0.0.
NXOpen::PointSecondOrigin ()
 Returns the origin of second link
Created in NX5.0.0.
NXOpen::DirectionSecondVector ()
 Returns the direction of second link
Created in NX5.0.0.
void SetDisplayScale (double displayScale)
 Sets the display scale
Created in NX5.0.0.
void SetFirstCsys (NXOpen::CoordinateSystem *csys1)
 Sets the csys of first link
Created in NX5.0.0.
void SetFirstLink (NXOpen::Motion::Link *link1)
 Sets the first link object
Created in NX5.0.0.
void SetFirstMatrix (NXOpen::NXMatrix *matrix1)
 Sets the matrix of first link
Created in NX5.0.0.
void SetFirstOrientationType (NXOpen::Motion::JointDefine::OrientationType orientationType)
 Sets the first orientation type of joint
Created in NX8.0.0.
void SetFirstOrigin (NXOpen::Point *origin1)
 Sets the origin of first link
Created in NX5.0.0.
void SetFirstVector (NXOpen::Direction *vector1)
 Sets the direction of first link
Created in NX5.0.0.
void SetJointType (NXOpen::Motion::JointDefine::Type jointType)
 Sets the joint type
Created in NX5.0.0.
void SetLimitsDefined (bool limitsDefined)
 Sets the option of defining limits for joint
Created in NX5.0.0.
void SetLowerLimit (double lowerLimit)
 Sets the lower limit.
void SetName (const NXString &jointName)
 Sets the joint name
Created in NX5.0.0.
void SetScrewRatio (double screwRatio)
 Sets the screw ratio.
void SetSecondCsys (NXOpen::CoordinateSystem *csys2)
 Sets the csys of second link
Created in NX5.0.0.
void SetSecondLink (NXOpen::Motion::Link *link2)
 Sets the second link
Created in NX5.0.0.
void SetSecondMatrix (NXOpen::NXMatrix *matrix2)
 Sets the matrix of second link
Created in NX5.0.0.
void SetSecondOrientationType (NXOpen::Motion::JointDefine::OrientationType orientationType)
 Sets the second orientation type of joint
Created in NX8.0.0.
void SetSecondOrigin (NXOpen::Point *origin2)
 Sets the origin of second link
Created in NX5.0.0.
void SetSecondVector (NXOpen::Direction *vector2)
 Sets the direction of second link
Created in NX5.0.0.
void SetSnapLinks (bool snapLinks)
 Sets the option of snap links
Created in NX5.0.0.
void SetUpperLimit (double upperLimit)
 Sets the upper limit.
bool SnapLinks ()
 Returns the option of snap links
Created in NX5.0.0.
double UpperLimit ()
 Returns the upper limit.
NXOpen::ExpressionUpperLimitAngleExpression ()
 Returns the upper limit angular expression.
NXOpen::ExpressionUpperLimitExpression ()
 Returns the upper limit expression.

Detailed Description

Represents a joint define object.


Member Enumeration Documentation

Defines the orientation type of joint.

Enumerator:
OrientationTypeVector 

Vector orientation type.

OrientationTypeCsys 

CSYS orientation type.

Joint define type.

Enumerator:
TypeRevolute 

This joint type is a single axis rotation.

This joint removes 5 degrees of freedom. The origins of csys_1 and csys_2 are identical and the z axes of csys_1 and csys_2 are colinear and codirected.

TypeSlider 

This joint type is a single translation.

This joint removes 5 degrees of freedom. The orientations of csys_1 and csys_2 are identical and the z axes are colinear and codirected.

TypeCylindrical 

This joint type is a single rotation and a single translation.

This joint removes 4 degrees of freedom. The z axes of csys_1 and csys_2 are colinear and codirected

TypeScrew 

This joint type is used to couple the rotation and translation of a cylindrical joint to remove one degree of freedom.

It should be created on the same pair of links as the cylindrical joint. If the screw joint needs to be driven, it may be coupled with a revolution joint and a slider joint instead.

TypeUniversal 

This joint type allows two rotations.

It removes 4 degrees of freedom. The origins of csys_1 and csys_2 are identical. The rotations about the x axis of csys_2 are equal and opposite to the rotations about the x axis of csys_1.

TypeSpherical 

This joint type allows three rotations.

It removes 3 degrees of freedom. The origins of csys_1 and csys_2 are identical

TypePlanar 

This joint type allows a single rotation and two translations.

It removes three degrees of freedom. The z axes of csys_1 and csys_2 are parallel and codirected. The origins of csys_1 and csys_2 are in a common x-y plane.

TypeFixed 

This Joint fixes a link or weld two links, It removes 6 degrees of freedom.

TypeConstantvelocity 

This joint type allows 2 rotation DOFs, rotation about both z axes of the joint markers, Rotation about the second marker's z-axis is equal and opposite to the first marker's rotation.

A constant velocity joint is similar to a universal joint, but the exit angle of a constant velocity joint is equal to the entry angle.The origins of csys_1 and csys_2 are identical.

TypeAtpoint 

This joint type allows 3 DOF: Markers are always coincident, and only rotational motion is allowed.

TypeInline 

This joint type indicates a four-degree-of-freedom (3R + 1T DOF) primitive that allows one translational and three rotational motions of one part with respect to another.One part so that it can only move along a straight line defined on a second part.

The location of the inline joint on the first part must remain on the z-axis of the second part.

TypeInplane 

One part so that it can only move in a plane of a second part.

The origin of the inplane joint on the first part must remain in the xy plane of the second part.Indicates a five-degree-of-freedom (3R + 2T DOF) primitive that allows both translational and rotational motion of one part with respect to another.For an inplane primitive, ADAMS/Solver imposes one translational constraint, which confines the translational motion of the I marker to the x-y plane of the J marker.

TypeOrientation 

The coordinate system of one part so that it cannot rotate with respect to a second part.

The axes of the coordinate systems must maintain the same orientation. The location of the origins of the coordinate systems does not matter.Indicates a three-degree-of-freedom (3T DOF) primitive that allows only translational motion of one part with respect to another . For an orientation primitive, Solver imposes three rotational constraints to keep the orientation of the I marker identical to the orientation of the J marker.

TypeParallel 

This joint type indicates a four-degree-of-freedom(1R + 3T DOF) primitive that allows both translational and rotational motion of one part with respect to another .

For a parallel axes primitive, Solver imposes two rotational constraints so that the z-axis of the I marker stays parallel to the z-axis of the J marker. This primitive permits relative rotation about the common z-axis of I and J and permits all relative displacements.

TypePerpendicular 

This joint type indicates a five-degree-of-freedom (2R +3T DOF) primitive that allows both translational and rotational motion of one part with respect to Another.

For a perpendicular primitive, Solver imposes a single rotational constraint on the I and the J markers so that their z-axes remain perpendicular. This allows relative rotations about either z-axis, but does not allow any relative rotation in the direction perpendicular to both z-axes.


Member Function Documentation

Returns the display scale
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the csys of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the first link object
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the matrix of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the first orientation type of joint
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the origin of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the direction of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the joint type
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the option of defining limits for joint
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the lower limit.

Only used when limits option is TRUE

Deprecated:
Deprecated in NX8.0.0.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Returns the lower limit angular expression.

Only used when limits option is TRUE
Created in NX8.0.0.

License requirements : None

Returns the lower limit expression.

Only used when limits option is TRUE
Created in NX8.0.0.

License requirements : None

Returns the joint name
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the screw ratio.

Used only when joint subtype is Motion::JointDefine::TypeScrew , which is the pitch of a screw's thread

Deprecated:
Deprecated in NX8.0.0.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Returns the screw ratio expression.

Used only when joint subtype is Motion::JointDefine::TypeScrew , which is the pitch of a screw's thread
Created in NX8.0.0.

License requirements : None

Returns the csys of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the matrix of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the second orientation type of joint
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the origin of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the direction of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::JointDefine::SetDisplayScale ( double  displayScale)

Sets the display scale
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
displayScaledisplay scale

Sets the csys of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
csys1csys1

Sets the first link object
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
link1link1

Sets the matrix of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
matrix1matrix1

Sets the first orientation type of joint
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
orientationTypeorientationtype

Sets the origin of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
origin1origin1

Sets the direction of first link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
vector1vector1

Sets the joint type
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
jointTypejoint type
void NXOpen::Motion::JointDefine::SetLimitsDefined ( bool  limitsDefined)

Sets the option of defining limits for joint
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
limitsDefinedlimits defined
void NXOpen::Motion::JointDefine::SetLowerLimit ( double  lowerLimit)

Sets the lower limit.

Only used when limits option is TRUE

Deprecated:
Deprecated in NX8.0.0.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters:
lowerLimitlower limit
void NXOpen::Motion::JointDefine::SetName ( const NXString jointName)

Sets the joint name
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
jointNamejoint name
void NXOpen::Motion::JointDefine::SetScrewRatio ( double  screwRatio)

Sets the screw ratio.

Used only when joint subtype is Motion::JointDefine::TypeScrew , which is the pitch of a screw's thread

Deprecated:
Deprecated in NX8.0.0.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters:
screwRatioscrew ratio

Sets the csys of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
csys2csys2

Sets the second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
link2link2

Sets the matrix of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
matrix2matrix2

Sets the second orientation type of joint
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
orientationTypeorientationtype

Sets the origin of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
origin2origin2

Sets the direction of second link
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
vector2vector2

Sets the option of snap links
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters:
snapLinkssnap links
void NXOpen::Motion::JointDefine::SetUpperLimit ( double  upperLimit)

Sets the upper limit.

Only used when limits option is TRUE

Deprecated:
Deprecated in NX8.0.0.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters:
upperLimitupper limit

Returns the option of snap links
Created in NX5.0.0.



License requirements : mechanisms ("MECHANISMS")

Returns the upper limit.

Only used when limits option is TRUE

Deprecated:
Deprecated in NX8.0.0.


Created in NX5.0.0.

License requirements : mechanisms ("MECHANISMS")

Returns the upper limit angular expression.

Only used when limits option is TRUE
Created in NX8.0.0.

License requirements : None

Returns the upper limit expression.

Only used when limits option is TRUE
Created in NX8.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.