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

Represents the KinamaticComponentBuilder class object. More...

Inheritance diagram for NXOpen::SIM::KinematicComponentBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  RegisterTypes { RegisterTypesSameAsPocketId, RegisterTypesSpecify }
 The register types. More...
enum  SystemClass {
  SystemClassMachine, SystemClassTool, SystemClassTurret, SystemClassPocket,
  SystemClassTemporary, SystemClassPart, SystemClassWorkpiece, SystemClassSetupElement,
  SystemClassBasic, SystemClassLatheSpindle, SystemClassPocketOnHead, SystemClassToolCutting,
  SystemClassSpinning, SystemClassHead
}
 The SIM KIM system classes. More...
enum  WorkPositionAngleTypes { WorkPositionAngleTypesNone, WorkPositionAngleTypesSpecifyAngle }
 The Working Position Angle type. More...

Public Member Functions

void AddChannelName (const NXString &channel)
 Adds a channel name to the component
Created in NX7.5.0.
void AddGeometry (NXOpen::NXObject *geo)
 Adds a single geometry element
Created in NX7.5.0.
void AddHoldingSystem (const NXString &holdSys)
 Adds a holding system to the component
Created in NX7.5.0.
void AddSystemClass (NXOpen::SIM::KinematicComponentBuilder::SystemClass sysClass)
 Add a system class
Created in NX7.5.0.
void AddUserClassName (const NXString &uclass)
 Adds a user class to the component
Created in NX7.5.0.
int AdjustRegister ()
 Returns the adjust register
Created in NX7.5.0.
NXOpen::SIM::KinematicComponentBuilder::RegisterTypes AdjustRegisterType ()
 Returns the adjust register type
Created in NX7.5.0.
int CutcomRegister ()
 Returns the cutcom register
Created in NX7.5.0.
NXOpen::SIM::KinematicComponentBuilder::RegisterTypes CutcomRegisterType ()
 Returns the cutcom register type
Created in NX7.5.0.
void DeleteAllGeometries ()
 Deletes all geometry elements from the component
Created in NX7.5.0.
void DeleteAllSystemClasses ()
 Delete all system classes of the component
Created in NX7.5.0.
void DeleteChannelName (const NXString &channel)
 Deletes a channel name from the component
Created in NX7.5.0.
void DeleteGeometry (NXOpen::NXObject *geo)
 Deletes a single geometry element from the component
Created in NX7.5.0.
void DeleteHoldingSystem (const NXString &holdSys)
 Deletes a holding system from the component
Created in NX7.5.0.
void DeleteSystemClass (NXOpen::SIM::KinematicComponentBuilder::SystemClass sysClasses)
 Delete a system class
Created in NX7.5.0.
void DeleteUserClassName (const NXString &uclass)
 Deletes a user class from the component
Created in NX7.5.0.
NXString DeviceId ()
 Returns the device id
Created in NX7.5.0.
std::vector< NXStringGetChannelNames ()
 Get a list of channel names of the component.
void GetGeometries (std::vector< NXOpen::NXObject * > &geos)
 Returns the geometry elements assigned to this component
Created in NX7.5.0.
std::vector< NXStringGetHoldingSystems ()
 Get a list of holding systems of the component.
void GetSystemClasses (std::vector< NXOpen::SIM::KinematicComponentBuilder::SystemClass > &sysClasses)
 Returns the component's system classes
Created in NX7.5.0.
std::vector< NXStringGetUserClassNames ()
 Get a list of user classes of the component.
int HolderId ()
 Returns the holder id
Created in NX7.5.0.
bool IsOfSystemClass (NXOpen::SIM::KinematicComponentBuilder::SystemClass sysClass)
 Test if the compomnent is a member of the given system class.
NXOpen::SIM::KinematicJunctionBuilderListJunctionList ()
 Returns the junction list
Created in NX7.5.0.
NXString Name ()
 Returns the kim component's name
Created in NX7.5.0.
void RenameChannelName (const NXString &oldName, const NXString &newName)
 Renames a channel name from the component
Created in NX7.5.0.
void RenameHoldingSystem (const NXString &oldName, const NXString &newName)
 Renames a holding system from the component
Created in NX7.5.0.
void RenameUserClass (const NXString &oldName, const NXString &newName)
 Renames a user class from the component
Created in NX7.5.0.
void SetAdjustRegister (int adjustReg)
 Sets the adjust register
Created in NX7.5.0.
void SetAdjustRegisterType (NXOpen::SIM::KinematicComponentBuilder::RegisterTypes regType)
 Sets the adjust register type
Created in NX7.5.0.
void SetCutcomRegister (int cutcomReg)
 Sets the cutcom register
Created in NX7.5.0.
void SetCutcomRegisterType (NXOpen::SIM::KinematicComponentBuilder::RegisterTypes regType)
 Sets the cutcom register type
Created in NX7.5.0.
void SetDeviceId (const NXString &deviceId)
 Sets the device id
Created in NX7.5.0.
void SetGeometries (const std::vector< NXOpen::NXObject * > &geos)
 Sets geometry elements for the component
Created in NX7.5.0.
void SetHolderId (int holderId)
 Sets the holder id
Created in NX7.5.0.
void SetName (const NXString &name)
 Sets the kim component's name
Created in NX7.5.0.
void SetWorkPositionAngle (double angle)
 Sets the working position angle
Created in NX7.5.0.
void SetWorkPositionAngleType (NXOpen::SIM::KinematicComponentBuilder::WorkPositionAngleTypes type)
 Sets the working position angle type
Created in NX7.5.0.
double WorkPositionAngle ()
 Returns the working position angle
Created in NX7.5.0.
NXOpen::SIM::KinematicComponentBuilder::WorkPositionAngleTypes WorkPositionAngleType ()
 Returns the working position angle type
Created in NX7.5.0.

Detailed Description

Represents the KinamaticComponentBuilder class object.


To create a new instance of this class, use SIM::KinematicComponentCollection::CreateHeadBaseComponentBuilder

Created in NX7.5.0.


Member Enumeration Documentation

The register types.

Enumerator:
RegisterTypesSameAsPocketId 

the pocket id defined the register

RegisterTypesSpecify 

the register is specified

The SIM KIM system classes.

Enumerator:
SystemClassMachine 

Machine Base class.

SystemClassTool 

tool class

SystemClassTurret 

turret class

SystemClassPocket 

Pocket class.

SystemClassTemporary 

temporary class

SystemClassPart 

Design part setup class.

SystemClassWorkpiece 

Blank setup class.

SystemClassSetupElement 

Any setup element.

SystemClassBasic 

On available in a BASIC machine.

If this bit is set, then the machine part can be used for simulation when only UG_ISV_BASIC license is available

SystemClassLatheSpindle 

lathe spindle class

SystemClassPocketOnHead 

Pocket on a machine head class.

SystemClassToolCutting 

Cutting portion of a tool.

SystemClassSpinning 

Component defines spinning geometry.

SystemClassHead 

Head class.

The Working Position Angle type.

Enumerator:
WorkPositionAngleTypesNone 

no angle specified

WorkPositionAngleTypesSpecifyAngle 

angle is specified


Member Function Documentation

Adds a channel name to the component
Created in NX7.5.0.



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

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

Adds a single geometry element
Created in NX7.5.0.



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

Parameters:
geoThe geometry element to add

Adds a holding system to the component
Created in NX7.5.0.



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

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

Add a system class
Created in NX7.5.0.



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

Parameters:
sysClassthe system class to add

Adds a user class to the component
Created in NX7.5.0.



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

Parameters:
uclassThe user cass to add
NOTE: The full Unicode character set is not supported for this parameter.

Returns the adjust register
Created in NX7.5.0.



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

Returns the adjust register type
Created in NX7.5.0.



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

Returns the cutcom register
Created in NX7.5.0.



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

Returns the cutcom register type
Created in NX7.5.0.



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

Deletes all geometry elements from the component
Created in NX7.5.0.



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

Delete all system classes of the component
Created in NX7.5.0.



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

Deletes a channel name from the component
Created in NX7.5.0.



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

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

Deletes a single geometry element from the component
Created in NX7.5.0.



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

Parameters:
geoThe geometry to remove

Deletes a holding system from the component
Created in NX7.5.0.



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

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

Delete a system class
Created in NX7.5.0.



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

Parameters:
sysClassesthe system class to delete

Deletes a user class from the component
Created in NX7.5.0.



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

Parameters:
uclassThe user cass to remove
NOTE: The full Unicode character set is not supported for this parameter.

Returns the device id
Created in NX7.5.0.



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

Get a list of channel names of the component.

Returns:
The channel names of the component
Created in NX7.5.0.

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

Returns the geometry elements assigned to this component
Created in NX7.5.0.



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

Parameters:
geosThe geometry elements

Get a list of holding systems of the component.

Returns:
The channel names of the component
Created in NX7.5.0.

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

Returns the component's system classes
Created in NX7.5.0.



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

Parameters:
sysClassesthe component's system classes

Get a list of user classes of the component.

Returns:
The user classes of the component
Created in NX7.5.0.

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

Returns the holder id
Created in NX7.5.0.



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

Test if the compomnent is a member of the given system class.

Returns:
TRUE if component is of the system class
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification")
Parameters:
sysClassthe system class to test

Returns the junction list
Created in NX7.5.0.



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

Returns the kim component's name
Created in NX7.5.0.



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

void NXOpen::SIM::KinematicComponentBuilder::RenameChannelName ( const NXString oldName,
const NXString newName 
)

Renames a channel name from the component
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::KinematicComponentBuilder::RenameHoldingSystem ( const NXString oldName,
const NXString newName 
)

Renames a holding system from the component
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::KinematicComponentBuilder::RenameUserClass ( const NXString oldName,
const NXString newName 
)

Renames a user class from the component
Created in NX7.5.0.



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

Parameters:
oldNameThe old user class
NOTE: The full Unicode character set is not supported for this parameter.
newNameThe new user class
NOTE: The full Unicode character set is not supported for this parameter.

Sets the adjust register
Created in NX7.5.0.



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

Parameters:
adjustRegthe adjust regsiter

Sets the adjust register type
Created in NX7.5.0.



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

Parameters:
regTypethe adjust register type

Sets the cutcom register
Created in NX7.5.0.



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

Parameters:
cutcomRegthe cutcom regsiter

Sets the cutcom register type
Created in NX7.5.0.



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

Parameters:
regTypethe cutcom register type

Sets the device id
Created in NX7.5.0.



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

Parameters:
deviceIdthe new device id

Sets geometry elements for the component
Created in NX7.5.0.



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

Parameters:
geosthe geometry elements

Sets the holder id
Created in NX7.5.0.



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

Parameters:
holderIdthe holder id

Sets the kim component's name
Created in NX7.5.0.



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

Parameters:
namethe component's new name

Sets the working position angle
Created in NX7.5.0.



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

Parameters:
anglethe working position angle

Sets the working position angle type
Created in NX7.5.0.



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

Parameters:
typeThe working position angle type

Returns the working position angle
Created in NX7.5.0.



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

Returns the working position angle type
Created in NX7.5.0.



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


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