NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::SIM::KinematicComponentCollection Class Reference

Represents the SimKimComponent Collection
To obtain an instance of this class, refer to NXOpen::SIM::KinematicConfigurator

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::SIM::KinematicComponentCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::SIM::KinematicComponentBuilderCreateComponentBuilder (NXOpen::SIM::KinematicComponent *parent, NXOpen::SIM::KinematicComponent *comp)
 Creates a builder for a kinematic component. More...
 
NXOpen::SIM::KinematicComponentBuilderCreateHeadBaseComponentBuilder (NXOpen::SIM::KinematicComponent *head)
 Creates a bulder for head base component. More...
 
NXOpen::SIM::KinematicComponentBuilderCreateMachineBaseComponentBuilder (NXOpen::SIM::KinematicComponent *machine)
 Creates a builder for a machine base component. More...
 
NXOpen::SIM::KinematicComponentBuilderCreateToolBaseComponentBuilder (NXOpen::SIM::KinematicComponent *tool)
 Creates a bulder for tool base component. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::SIM::KinematicComponentFindObject (const NXString &sid)
 Finds the SIM.KinematicComponent object with the given identifier as recorded in a journal. More...
 
NXOpen::SIM::KinematicComponentFindObject (const char *sid)
 Finds the SIM.KinematicComponent object with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the SimKimComponent Collection
To obtain an instance of this class, refer to NXOpen::SIM::KinematicConfigurator

Created in NX7.5.0.


Member Function Documentation

iterator NXOpen::SIM::KinematicComponentCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::SIM::KinematicComponentBuilder* NXOpen::SIM::KinematicComponentCollection::CreateComponentBuilder ( NXOpen::SIM::KinematicComponent parent,
NXOpen::SIM::KinematicComponent comp 
)

Creates a builder for a kinematic component.

Returns
The component builder
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")
Parameters
parentThe parent for the new component. Can be NULL
compThe component to edit. If NULL, a new component will be created
NXOpen::SIM::KinematicComponentBuilder* NXOpen::SIM::KinematicComponentCollection::CreateHeadBaseComponentBuilder ( NXOpen::SIM::KinematicComponent head)

Creates a bulder for head base component.

Returns
The new head base component builder
Created in NX8.0.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
headThe head component to edit. If NULL, then a new head base component is created
NXOpen::SIM::KinematicComponentBuilder* NXOpen::SIM::KinematicComponentCollection::CreateMachineBaseComponentBuilder ( NXOpen::SIM::KinematicComponent machine)

Creates a builder for a machine base component.

Returns
The new machine base component builder
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
machineThe machine base component to edit. If NULL, then a new machine base component is created
NXOpen::SIM::KinematicComponentBuilder* NXOpen::SIM::KinematicComponentCollection::CreateToolBaseComponentBuilder ( NXOpen::SIM::KinematicComponent tool)

Creates a bulder for tool base component.

Returns
The new tool base component builder
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder") OR resource_manager_nx ("Teamcenter Resource Manager")
Parameters
toolThe tool component to edit. If NULL, then a new tool base component is created
iterator NXOpen::SIM::KinematicComponentCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::SIM::KinematicComponent* NXOpen::SIM::KinematicComponentCollection::FindObject ( const NXString sid)

Finds the SIM.KinematicComponent object with the given identifier as recorded in a journal.

Returns
the found object
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
sidthe name of the object
NXOpen::SIM::KinematicComponent* NXOpen::SIM::KinematicComponentCollection::FindObject ( const char *  sid)

Finds the SIM.KinematicComponent object with the given identifier as recorded in a journal.

Returns
the found object
Created in NX7.5.0.

License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
Parameters
sidthe name of the object
tag_t NXOpen::SIM::KinematicComponentCollection::Tag ( ) const

Returns the tag of this object.


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