NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::SIM::KinematicConfigurator Class Reference

Represents the ISV base class object. More...

Inheritance diagram for NXOpen::SIM::KinematicConfigurator:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  UniteTypes { UniteTypesCreate, UniteTypesUnite }
 The unite types for spinning geometries. More...

Public Member Functions

void AddChannel (const NXString &channel)
 Adds a new user channel name to the list of channels
Created in NX7.5.0.
void AddHoldingSystem (const NXString &holdSys)
 Adds a new user holding system to the list of holding systems
Created in NX7.5.0.
void AddUserClassification (const NXString &userClass)
 Adds a new user class name to the list of user classes
Created in NX7.5.0.
NXOpen::SIM::KinematicComponentCollectionComponentCollection ()
 Returns the ComponentCollection instance belonging to this SimKim
Created in NX7.5.0.
NXOpen::SIM::KinematicAxisBuilderCreateAxisBuilder (NXOpen::SIM::KinematicComponent *parent, NXOpen::SIM::KinematicJunction *jct, NXOpen::SIM::KinematicAxis *axis)
 Creates a builder for a kinematic axis.
NXOpen::SIM::KinematicJunctionBuilderCreateJunctionBuilder (NXOpen::SIM::KinematicComponent *parent, NXOpen::SIM::KinematicJunction *jct)
 Creates a builder for a kinematic junction.
NXOpen::SIM::KinematicComponentCreateSpinningClone (NXOpen::SIM::KinematicComponent *source, bool combine)
 Creates a copy of the given component and spins its assigned geometry around a spinning axis.
void DeleteAllChannels ()
 Deletes all channels from the kinematic model
Created in NX7.5.0.
void DeleteAllHoldingSystems ()
 Delete all holding systems from the kinematic model
Created in NX7.5.0.
void DeleteAxis (NXOpen::SIM::KinematicAxis *axis)
 Deletes the given axis
Created in NX7.5.0.
void DeleteChannel (const NXString &channel)
 Deletes a channel name from the list of channels
Created in NX7.5.0.
void DeleteComponent (NXOpen::SIM::KinematicComponent *comp)
 Deletes the given component
Created in NX7.5.0.
void DeleteHoldingSystem (const NXString &holdSys)
 Delete a holding system from the list
Created in NX7.5.0.
void DeleteJunction (NXOpen::SIM::KinematicJunction *jct)
 Deletes the given junction
Created in NX7.5.0.
void DeleteModel ()
 Deletes the entire kinematic model
Created in NX7.5.0.
void DeleteRootComponent (NXOpen::SIM::KinematicComponent *oldRoot)
 Delete a root component from the SIM::KinematicConfigurator object
Created in NX7.5.0.
void DeleteUserClassification (const NXString &userClass)
 Deletes a user class name from the list of user classes
Created in NX7.5.0.
NXOpen::SIM::KinematicAxisFindAxis (const NXString &name, NXOpen::SIM::KinematicComponent **pComp, NXOpen::SIM::KinematicJunction **pJct)
 Find the axis with the given name.
void FindComponentsBySystemClass (int sysclass, std::vector< NXOpen::SIM::KinematicComponent * > &comps)
 Finds component which are of the given system class
Created in NX7.5.0.
NXOpen::SIM::KinematicJunctionFindJunction (const NXString &name)
 Find the junction with the given name.
NXOpen::SIM::KinematicJunctionFindJunction (NXOpen::NXObject *csys)
 Finds a junction by its coordinate system.
NXOpen::SIM::KinematicComponentFindOwnerOfJunction (NXOpen::SIM::KinematicJunction *jct)
 Finds the SIM::KinematicComponent which is the owner of this junction.
NXOpen::SIM::KinematicComponentFindParentComponent (NXOpen::SIM::KinematicComponent *comp)
 Finds the SIM::KinematicComponent which is the parent of this component.
void GetChannels (std::vector< NXString > &channels)
 Get a list of all channels
Created in NX7.5.0.
void GetHoldingSystems (std::vector< NXString > &holdSys)
 Get a list of all holding systems
Created in NX7.5.0.
void GetJunctionNames (std::vector< NXString > &junctions)
 Gets a list of all junction names in the kinematic
Created in NX7.5.0.
void GetJunctions (std::vector< NXOpen::SIM::KinematicJunction * > &junctions)
 Gets a list of all junctions in the kinematic
Created in NX7.5.0.
void GetUserClassifications (std::vector< NXString > &uClasses)
 Get a list of all user classes
Created in NX7.5.0.
void InsertRootComponent (NXOpen::SIM::KinematicComponent *newRoot)
 Adds a new root component to the SIM::KinematicConfigurator object
Created in NX7.5.0.
void RenameChannel (const NXString &oldName, const NXString &newName)
 Renames a channel name from the list
Created in NX7.5.0.
void RenameHoldingSystem (const NXString &oldName, const NXString &newName)
 Renames a holding system from the list
Created in NX7.5.0.
void RenameUserClassification (const NXString &oldName, const NXString &newName)
 Renames a user class name from the list
Created in NX7.5.0.
void SetName (const NXString &name)
 Sets the custom name of the kinematic model
Created in NX7.5.0.

Detailed Description

Represents the ISV base class object.


To obtain an instance of this class, use Part::KinematicConfigurator

Created in NX7.5.0.


Member Enumeration Documentation

The unite types for spinning geometries.

Enumerator:
UniteTypesCreate 

Create the spinning geometries as individual bodies.

UniteTypesUnite 

Unite the spinning geometries into one body.


Member Function Documentation

Adds a new user channel name to the list of channels
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
channelThe new channel name.
NOTE: The full Unicode character set is not supported for this parameter.

Adds a new user holding system to the list of holding systems
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
holdSysThe new holding system.
NOTE: The full Unicode character set is not supported for this parameter.

Adds a new user class name to the list of user classes
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
userClassThe new user class name
NOTE: The full Unicode character set is not supported for this parameter.

Returns the ComponentCollection instance belonging to this SimKim
Created in NX7.5.0.


Creates a builder for a kinematic axis.

Returns:
The new axis builder
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
parentThe parent component
jctThe junction used for the axis
axisThe axis to edit. If NULL, a new axis is craeted

Creates a builder for a kinematic junction.

Returns:
The new junction builder
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
parentThe parent component
jctThe junction to edit. If NULL, a new junction is created

Creates a copy of the given component and spins its assigned geometry around a spinning axis.

For tool components, the X-axis of the tool tip junction is used as spinning axis. If none is defined and for other types of components, the X-axis of the WCS is used. The new component has the same parent as the source component.

Returns:
The new spinning component
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
sourceThe source component.
combineSpecifies whether to combine the spinning geometries into one, or not

Deletes all channels from the kinematic model
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Delete all holding systems from the kinematic model
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Deletes the given axis
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
axisthe component to delete

Deletes a channel name from the list of channels
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
channelThe channel name to delete.
NOTE: The full Unicode character set is not supported for this parameter.

Deletes the given component
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
compthe component to delete

Delete a holding system from the list
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
holdSysThe holding system to delete.
NOTE: The full Unicode character set is not supported for this parameter.

Deletes the given junction
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
jctthe component to delete

Deletes the entire kinematic model
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Delete a root component from the SIM::KinematicConfigurator object
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
oldRootThe root component to remove

Deletes a user class name from the list of user classes
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
userClassThe user class name to delete.
NOTE: The full Unicode character set is not supported for this parameter.

Find the axis with the given name.

Returns:
The axis, if found
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
nameThe name to look for
NOTE: The full Unicode character set is not supported for this parameter.
pCompThe parent component of the axis
pJctThe parent junction of the axis

Finds component which are of the given system class
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
sysclassThe system class to look for.
compsThe found components

Find the junction with the given name.

Returns:
The junction, if found
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
nameThe name to look for
NOTE: The full Unicode character set is not supported for this parameter.

Finds a junction by its coordinate system.

Returns:
The junction for the csys
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
csysthe csys of a junction

Finds the SIM::KinematicComponent which is the owner of this junction.

Returns:
The owning component of the junction
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
jctThe junction

Finds the SIM::KinematicComponent which is the parent of this component.

Returns:
The parent Component. NULL if comp is root component
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
compThe component
void NXOpen::SIM::KinematicConfigurator::GetChannels ( std::vector< NXString > &  channels)

Get a list of all channels
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
channelsThe list of channels

Get a list of all holding systems
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
holdSysThe holding systems
void NXOpen::SIM::KinematicConfigurator::GetJunctionNames ( std::vector< NXString > &  junctions)

Gets a list of all junction names in the kinematic
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
junctionsThe list of junction names

Gets a list of all junctions in the kinematic
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
junctionsThe list of junctions

Get a list of all user classes
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
uClassesThe list of user classes

Adds a new root component to the SIM::KinematicConfigurator object
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
newRootThe new root component
void NXOpen::SIM::KinematicConfigurator::RenameChannel ( const NXString oldName,
const NXString newName 
)

Renames a channel name from the list
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
oldNameThe old channel name
NOTE: The full Unicode character set is not supported for this parameter.
newNameThe new channel name
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::SIM::KinematicConfigurator::RenameHoldingSystem ( const NXString oldName,
const NXString newName 
)

Renames a holding system from the list
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
oldNameThe old holding system
NOTE: The full Unicode character set is not supported for this parameter.
newNameThe new holding system
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::SIM::KinematicConfigurator::RenameUserClassification ( const NXString oldName,
const NXString newName 
)

Renames a user class name from the list
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
oldNameThe old user class name
NOTE: The full Unicode character set is not supported for this parameter.
newNameThe new user class name
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::SIM::KinematicConfigurator::SetName ( const NXString name) [virtual]

Sets the custom name of the kinematic model
Created in NX7.5.0.



License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters:
nameThe new kinematic model name

Reimplemented from NXOpen::NXObject.


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