This class is used for add kinematic chain to the list. More...

Inheritance diagram for NXOpen::SIM::KinematicChain:

Public Types
enum	CoordinatePlaneTypes { CoordinatePlaneTypesZx, CoordinatePlaneTypesXy }
	Represents the coordinate plane type. More...

enum	Types { TypesUnknown = -1, TypesMilling, TypesTurning, TypesPolar }
	Represents the kinematic chain type. More...

Public Member Functions
NXString	Axial ()
	Returns the axial axis of the kinematic chain Created in NX9.0.0.

NXString	CoordinateAxes ()
	Returns the coordinate axes name of the kinematic chain Created in NX9.0.0.

NXOpen::SIM::KinematicChain::CoordinatePlaneTypes	CoordinatePlane ()
	Returns the coordinate plane type of the kinematic chain Created in NX9.0.0.

NXString	Device ()
	Returns the device component of the kinematic chain Created in NX9.0.0.

NXString	Name ()
	Returns the name of the kinematic chain Created in NX9.0.0.

NXString	Radial ()
	Returns the radial axis of the kinematic chain Created in NX9.0.0.

NXString	ReferencePointJunction ()
	Returns the reference point junction of the kinematic chain Created in NX9.0.0.

NXString	Rotary1 ()
	Returns the rotary1 axis of the kinematic chain Created in NX9.0.0.

NXString	Rotary2 ()
	Returns the rotary2 axis of the kinematic chain Created in NX9.0.0.

void	SetAxial (const NXString &axis)
	Sets the axial axis of the kinematic chain Created in NX9.0.0.

void	SetAxial (const char *axis)
	Sets the axial axis of the kinematic chain Created in NX9.0.0.

void	SetCoordinateAxes (const NXString &axis)
	Sets the coordinate axes name of the kinematic chain Created in NX9.0.0.

void	SetCoordinateAxes (const char *axis)
	Sets the coordinate axes name of the kinematic chain Created in NX9.0.0.

void	SetCoordinatePlane (NXOpen::SIM::KinematicChain::CoordinatePlaneTypes type)
	Sets the coordinate plane type of the kinematic chain Created in NX9.0.0.

void	SetDevice (const NXString &device)
	Sets the device component of the kinematic chain Created in NX9.0.0.

void	SetDevice (const char *device)
	Sets the device component of the kinematic chain Created in NX9.0.0.

void	SetName (const NXString &name)
	Sets the name of the kinematic chain Created in NX9.0.0.

void	SetName (const char *name)
	Sets the name of the kinematic chain Created in NX9.0.0.

void	SetRadial (const NXString &axis)
	Sets the radial axis of the kinematic chain Created in NX9.0.0.

void	SetRadial (const char *axis)
	Sets the radial axis of the kinematic chain Created in NX9.0.0.

void	SetReferencePointJunction (const NXString &refPointJunction)
	Sets the reference point junction of the kinematic chain Created in NX9.0.0.

void	SetReferencePointJunction (const char *refPointJunction)
	Sets the reference point junction of the kinematic chain Created in NX9.0.0.

void	SetRotary1 (const NXString &rotary1)
	Sets the rotary1 axis of the kinematic chain Created in NX9.0.0.

void	SetRotary1 (const char *rotary1)
	Sets the rotary1 axis of the kinematic chain Created in NX9.0.0.

void	SetRotary2 (const NXString &rotary2)
	Sets the rotary2 axis of the kinematic chain Created in NX9.0.0.

void	SetRotary2 (const char *rotary2)
	Sets the rotary2 axis of the kinematic chain Created in NX9.0.0.

void	SetSetup (const NXString &setup)
	Sets the setup component of the kinematic chain Created in NX9.0.0.

void	SetSetup (const char *setup)
	Sets the setup component of the kinematic chain Created in NX9.0.0.

void	SetType (NXOpen::SIM::KinematicChain::Types chainType)
	Sets the type of the kinematic chain Created in NX9.0.0.

NXString	Setup ()
	Returns the setup component of the kinematic chain Created in NX9.0.0.

void	SetX (const NXString &xAxis)
	Sets the X axis of the kinematic chain Created in NX9.0.0.

void	SetX (const char *xAxis)
	Sets the X axis of the kinematic chain Created in NX9.0.0.

void	SetY (const NXString &yAxis)
	Sets the Y axis of the kinematic chain Created in NX9.0.0.

void	SetY (const char *yAxis)
	Sets the Y axis of the kinematic chain Created in NX9.0.0.

void	SetZ (const NXString &zAxis)
	Sets the Z axis of the kinematic chain Created in NX9.0.0.

void	SetZ (const char *zAxis)
	Sets the Z axis of the kinematic chain Created in NX9.0.0.

NXOpen::SIM::KinematicChain::Types	Type ()
	Returns the type of the kinematic chain Created in NX9.0.0.

NXString	X ()
	Returns the X axis of the kinematic chain Created in NX9.0.0.

NXString	Y ()
	Returns the Y axis of the kinematic chain Created in NX9.0.0.

NXString	Z ()
	Returns the Z axis of the kinematic chain Created in NX9.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

This class is used for add kinematic chain to the list.

   Calling @link Builder::Commit Builder::Commit@endlink  on this builder will only return NULL.
<br> To create a new instance of this class, use @link SIM::KinematicConfigurator::CreateKinematicChain  SIM::KinematicConfigurator::CreateKinematicChain @endlink  <br>

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::SIM::KinematicChain::CoordinatePlaneTypes

Represents the coordinate plane type.

Enumerator:

CoordinatePlaneTypesZx	ZX.
CoordinatePlaneTypesXy	XY.

enum NXOpen::SIM::KinematicChain::Types

Represents the kinematic chain type.

Enumerator:

TypesMilling	Milling.
TypesTurning	Turning.
TypesPolar	Polar.

Member Function Documentation

NXString NXOpen::SIM::KinematicChain::Axial ( )

Returns the axial axis of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::CoordinateAxes ( )

Returns the coordinate axes name of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXOpen::SIM::KinematicChain::CoordinatePlaneTypes NXOpen::SIM::KinematicChain::CoordinatePlane ( )

Returns the coordinate plane type of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::Device ( )

Returns the device component of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::Name ( )

Returns the name of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::Radial ( )

Returns the radial axis of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::ReferencePointJunction ( )

Returns the reference point junction of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::Rotary1 ( )

Returns the rotary1 axis of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::Rotary2 ( )

Returns the rotary2 axis of the kinematic chain
Created in NX9.0.0.

License requirements : None

void NXOpen::SIM::KinematicChain::SetAxial ( const NXString & axis )

Sets the axial axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

axis	the axial axis

void NXOpen::SIM::KinematicChain::SetAxial ( const char * axis )

Sets the axial axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

axis	the axial axis

void NXOpen::SIM::KinematicChain::SetCoordinateAxes ( const NXString & axis )

Sets the coordinate axes name of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

axis	the coordinate axes

void NXOpen::SIM::KinematicChain::SetCoordinateAxes ( const char * axis )

Sets the coordinate axes name of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

axis	the coordinate axes

void NXOpen::SIM::KinematicChain::SetCoordinatePlane ( NXOpen::SIM::KinematicChain::CoordinatePlaneTypes type )

Sets the coordinate plane type of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

type	the coordinate plane type

void NXOpen::SIM::KinematicChain::SetDevice ( const NXString & device )

Sets the device component of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

device the chain device

void NXOpen::SIM::KinematicChain::SetDevice ( const char * device )

Sets the device component of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

device the chain device

void NXOpen::SIM::KinematicChain::SetName ( const NXString & name )

Sets the name of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

name	the chain's new name

void NXOpen::SIM::KinematicChain::SetName ( const char * name )

Sets the name of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

name	the chain's new name

void NXOpen::SIM::KinematicChain::SetRadial ( const NXString & axis )

Sets the radial axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

axis	the radial axis

void NXOpen::SIM::KinematicChain::SetRadial ( const char * axis )

Sets the radial axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

axis	the radial axis

void NXOpen::SIM::KinematicChain::SetReferencePointJunction ( const NXString & refPointJunction )

Sets the reference point junction of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

refPointJunction the reference point junction

void NXOpen::SIM::KinematicChain::SetReferencePointJunction ( const char * refPointJunction )

Sets the reference point junction of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

refPointJunction the reference point junction

void NXOpen::SIM::KinematicChain::SetRotary1 ( const NXString & rotary1 )

Sets the rotary1 axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

rotary1 the rotary1

void NXOpen::SIM::KinematicChain::SetRotary1 ( const char * rotary1 )

Sets the rotary1 axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

rotary1 the rotary1

void NXOpen::SIM::KinematicChain::SetRotary2 ( const NXString & rotary2 )

Sets the rotary2 axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

rotary2 the rotary2

void NXOpen::SIM::KinematicChain::SetRotary2 ( const char * rotary2 )

Sets the rotary2 axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

rotary2 the rotary2

void NXOpen::SIM::KinematicChain::SetSetup ( const NXString & setup )

Sets the setup component of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

setup the chain setup

void NXOpen::SIM::KinematicChain::SetSetup ( const char * setup )

Sets the setup component of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

setup the chain setup

void NXOpen::SIM::KinematicChain::SetType ( NXOpen::SIM::KinematicChain::Types chainType )

Sets the type of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

chainType the chain type

NXString NXOpen::SIM::KinematicChain::Setup ( )

Returns the setup component of the kinematic chain
Created in NX9.0.0.

License requirements : None

void NXOpen::SIM::KinematicChain::SetX ( const NXString & xAxis )

Sets the X axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

xAxis the x axis

void NXOpen::SIM::KinematicChain::SetX ( const char * xAxis )

Sets the X axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

xAxis the x axis

void NXOpen::SIM::KinematicChain::SetY ( const NXString & yAxis )

Sets the Y axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

yAxis the Y axis

void NXOpen::SIM::KinematicChain::SetY ( const char * yAxis )

Sets the Y axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

yAxis the Y axis

void NXOpen::SIM::KinematicChain::SetZ ( const NXString & zAxis )

Sets the Z axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

zAxis the z axis

void NXOpen::SIM::KinematicChain::SetZ ( const char * zAxis )

Sets the Z axis of the kinematic chain
Created in NX9.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters

zAxis the z axis

NXOpen::SIM::KinematicChain::Types NXOpen::SIM::KinematicChain::Type ( )

Returns the type of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::X ( )

Returns the X axis of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::Y ( )

Returns the Y axis of the kinematic chain
Created in NX9.0.0.

License requirements : None

NXString NXOpen::SIM::KinematicChain::Z ( )

Returns the Z axis of the kinematic chain
Created in NX9.0.0.

License requirements : None

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

SIM_KinematicChain.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation