NXOpen::SIM::KinematicChannelBuilder Class Reference

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

Inheritance diagram for NXOpen::SIM::KinematicChannelBuilder:

Public Member Functions
NXString	GeometryAxisX ()
	Returns the geometry X axis of the channel Created in NX9.0.3. More...
NXString	GeometryAxisY ()
	Returns the geometry Y axis of the channel Created in NX9.0.3. More...
NXString	GeometryAxisZ ()
	Returns the geometry Z axis of the channel Created in NX9.0.3. More...
void	GetAssignedAxes (std::vector< NXString > &assignedAxes)
	Gets a list of assigned axes of the channel Created in NX9.0.3. More...
void	GetReferencedSpindles (std::vector< NXString > &refSpindles)
	Gets a list of referenced spindles of the channel Created in NX9.0.3. More...
NXString	MainSpindle ()
	Returns the main spindle of the channel Created in NX9.0.3. More...
NXString	Name ()
	Returns the name of the channel Created in NX9.0.3. More...
void	SetAssignedAxes (std::vector< NXString > &assignedAxes)
	Sets a list of assigned axes of the channel Created in NX9.0.3. More...
void	SetAssignedAxis (const NXString &axisName)
	Sets an assigned axis of the channel Created in NX9.0.3. More...
void	SetAssignedAxis (const char *axisName)
	Sets an assigned axis of the channel Created in NX9.0.3. More...
void	SetGeometryAxisX (const NXString &xAxis)
	Sets the geometry X axis of the channel Created in NX9.0.3. More...
void	SetGeometryAxisX (const char *xAxis)
	Sets the geometry X axis of the channel Created in NX9.0.3. More...
void	SetGeometryAxisY (const NXString &yAxis)
	Sets the geometry Y axis of the channel Created in NX9.0.3. More...
void	SetGeometryAxisY (const char *yAxis)
	Sets the geometry Y axis of the channel Created in NX9.0.3. More...
void	SetGeometryAxisZ (const NXString &zAxis)
	Sets the geometry Z axis of the channel Created in NX9.0.3. More...
void	SetGeometryAxisZ (const char *zAxis)
	Sets the geometry Z axis of the channel Created in NX9.0.3. More...
void	SetMainSpindle (const NXString &mainSpindle)
	Sets the main spindle of the channel Created in NX9.0.3. More...
void	SetMainSpindle (const char *mainSpindle)
	Sets the main spindle of the channel Created in NX9.0.3. More...
void	SetName (const NXString &name)
	Sets the name of the channel Created in NX9.0.3. More...
void	SetName (const char *name)
	Sets the name of the channel Created in NX9.0.3. More...
void	SetReferencedSpindle (const NXString &spindleName)
	Sets a referenced spindle of the channel Created in NX9.0.3. More...
void	SetReferencedSpindle (const char *spindleName)
	Sets a referenced spindle of the channel Created in NX9.0.3. More...
void	SetReferencedSpindles (std::vector< NXString > &refSpindles)
	Sets a list of referenced spindles of the channel Created in NX9.0.3. More...
void	SetUnassignedAxis (const NXString &axisName)
	Sets an unassigned axis of the channel Created in NX9.0.3. More...
void	SetUnassignedAxis (const char *axisName)
	Sets an unassigned axis of the channel Created in NX9.0.3. More...
void	SetUnreferencedSpindle (const NXString &spindleName)
	Sets an unreferenced spindle of the channel Created in NX9.0.3. More...
void	SetUnreferencedSpindle (const char *spindleName)
	Sets an unreferenced spindle of the channel Created in NX9.0.3. 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

This class is used for add kinematic channel to the channel configuratation list.

Calling Builder::Commit on this builder will only return NULL.
To create a new instance of this class, use NXOpen::SIM::KinematicConfigurator::CreateKinematicChannelBuilder

Created in NX9.0.3.

Member Function Documentation

NXString NXOpen::SIM::KinematicChannelBuilder::GeometryAxisX

(

)

Returns the geometry X axis of the channel
Created in NX9.0.3.

License requirements : None

NXString NXOpen::SIM::KinematicChannelBuilder::GeometryAxisY

(

)

Returns the geometry Y axis of the channel
Created in NX9.0.3.

License requirements : None

NXString NXOpen::SIM::KinematicChannelBuilder::GeometryAxisZ

(

)

Returns the geometry Z axis of the channel
Created in NX9.0.3.

License requirements : None

void NXOpen::SIM::KinematicChannelBuilder::GetAssignedAxes

(

std::vector< NXString > &

assignedAxes

)

Gets a list of assigned axes of the channel
Created in NX9.0.3.

License requirements : None

Parameters

assignedAxes

the list of assigned axes

void NXOpen::SIM::KinematicChannelBuilder::GetReferencedSpindles

(

std::vector< NXString > &

refSpindles

)

Gets a list of referenced spindles of the channel
Created in NX9.0.3.

License requirements : None

Parameters

refSpindles

the list of referenced spindles

NXString NXOpen::SIM::KinematicChannelBuilder::MainSpindle

(

)

Returns the main spindle of the channel
Created in NX9.0.3.

License requirements : None

NXString NXOpen::SIM::KinematicChannelBuilder::Name

(

)

Returns the name of the channel
Created in NX9.0.3.

License requirements : None

void NXOpen::SIM::KinematicChannelBuilder::SetAssignedAxes

(

std::vector< NXString > &

assignedAxes

)

Sets a list of assigned axes of the channel
Created in NX9.0.3.

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

Parameters

assignedAxes

the list of assigned axes

void NXOpen::SIM::KinematicChannelBuilder::SetAssignedAxis

(

const NXString &

axisName

)

Sets an assigned axis of the channel
Created in NX9.0.3.

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

Parameters

axisName

the assigned axis

void NXOpen::SIM::KinematicChannelBuilder::SetAssignedAxis

(

const char *

axisName

)

Sets an assigned axis of the channel
Created in NX9.0.3.

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

Parameters

axisName

the assigned axis

void NXOpen::SIM::KinematicChannelBuilder::SetGeometryAxisX

(

const NXString &

xAxis

)

Sets the geometry X axis of the channel
Created in NX9.0.3.

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::KinematicChannelBuilder::SetGeometryAxisX

(

const char *

xAxis

)

Sets the geometry X axis of the channel
Created in NX9.0.3.

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::KinematicChannelBuilder::SetGeometryAxisY

(

const NXString &

yAxis

)

Sets the geometry Y axis of the channel
Created in NX9.0.3.

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::KinematicChannelBuilder::SetGeometryAxisY

(

const char *

yAxis

)

Sets the geometry Y axis of the channel
Created in NX9.0.3.

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::KinematicChannelBuilder::SetGeometryAxisZ

(

const NXString &

zAxis

)

Sets the geometry Z axis of the channel
Created in NX9.0.3.

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::KinematicChannelBuilder::SetGeometryAxisZ

(

const char *

zAxis

)

Sets the geometry Z axis of the channel
Created in NX9.0.3.

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::KinematicChannelBuilder::SetMainSpindle

(

const NXString &

mainSpindle

)

Sets the main spindle of the channel
Created in NX9.0.3.

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

Parameters

mainSpindle

the main spindle

void NXOpen::SIM::KinematicChannelBuilder::SetMainSpindle

(

const char *

mainSpindle

)

Sets the main spindle of the channel
Created in NX9.0.3.

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

Parameters

mainSpindle

the main spindle

void NXOpen::SIM::KinematicChannelBuilder::SetName

(

const NXString &

name

)

Sets the name of the channel
Created in NX9.0.3.

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

Parameters

name	the channel's new name

void NXOpen::SIM::KinematicChannelBuilder::SetName

(

const char *

name

)

Sets the name of the channel
Created in NX9.0.3.

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

Parameters

name	the channel's new name

void NXOpen::SIM::KinematicChannelBuilder::SetReferencedSpindle

(

const NXString &

spindleName

)

Sets a referenced spindle of the channel
Created in NX9.0.3.

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

Parameters

spindleName

the referenced spindle

void NXOpen::SIM::KinematicChannelBuilder::SetReferencedSpindle

(

const char *

spindleName

)

Sets a referenced spindle of the channel
Created in NX9.0.3.

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

Parameters

spindleName

the referenced spindle

void NXOpen::SIM::KinematicChannelBuilder::SetReferencedSpindles

(

std::vector< NXString > &

refSpindles

)

Sets a list of referenced spindles of the channel
Created in NX9.0.3.

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

Parameters

refSpindles

the list of referenced spindles

void NXOpen::SIM::KinematicChannelBuilder::SetUnassignedAxis

(

const NXString &

axisName

)

Sets an unassigned axis of the channel
Created in NX9.0.3.

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

Parameters

axisName

the unassigned axis

void NXOpen::SIM::KinematicChannelBuilder::SetUnassignedAxis

(

const char *

axisName

)

Sets an unassigned axis of the channel
Created in NX9.0.3.

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

Parameters

axisName

the unassigned axis

void NXOpen::SIM::KinematicChannelBuilder::SetUnreferencedSpindle

(

const NXString &

spindleName

)

Sets an unreferenced spindle of the channel
Created in NX9.0.3.

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

Parameters

spindleName

the unreferenced spindle

void NXOpen::SIM::KinematicChannelBuilder::SetUnreferencedSpindle

(

const char *

spindleName

)

Sets an unreferenced spindle of the channel
Created in NX9.0.3.

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

Parameters

spindleName

the unreferenced spindle

virtual bool NXOpen::SIM::KinematicChannelBuilder::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:

• SIM_KinematicChannelBuilder.hxx