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

Represents a collection of motion couplers
To obtain an instance of this class, refer to Motion::MotionManager

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Motion::CouplerCollection:
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.
 
NXOpen::Motion::CouplerCableBuilderCreateCouplerCableBuilder (NXOpen::Motion::CouplerCable *coupler)
 Creates the builder object of Motion::CouplerCable object.
 
NXOpen::Motion::CouplerGearBuilderCreateCouplerGearBuilder (NXOpen::Motion::CouplerGear *coupler)
 Creates the builder object of Motion::CouplerGear object.
 
NXOpen::Motion::CouplerRckpnBuilderCreateCouplerRckpnBuilder (NXOpen::Motion::CouplerRckpn *coupler)
 Creates the builder object of Motion::CouplerRckpn object.
 
iterator end ()
 Returns an iterator addressing one past the last element.
 
NXOpen::Motion::CouplerFindObject (const NXString &name)
 Finds a coupler with the given name.
 
NXOpen::Motion::CouplerFindObject (const char *name)
 Finds a coupler with the given name.
 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a collection of motion couplers
To obtain an instance of this class, refer to Motion::MotionManager

Created in NX6.0.0.


Member Function Documentation

iterator NXOpen::Motion::CouplerCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Motion::CouplerCableBuilder* NXOpen::Motion::CouplerCollection::CreateCouplerCableBuilder ( NXOpen::Motion::CouplerCable coupler)

Creates the builder object of Motion::CouplerCable object.

Returns

Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
couplercoupler
NXOpen::Motion::CouplerGearBuilder* NXOpen::Motion::CouplerCollection::CreateCouplerGearBuilder ( NXOpen::Motion::CouplerGear coupler)

Creates the builder object of Motion::CouplerGear object.

Returns

Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
couplercoupler
NXOpen::Motion::CouplerRckpnBuilder* NXOpen::Motion::CouplerCollection::CreateCouplerRckpnBuilder ( NXOpen::Motion::CouplerRckpn coupler)

Creates the builder object of Motion::CouplerRckpn object.

Returns

Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
couplercoupler
iterator NXOpen::Motion::CouplerCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Motion::Coupler* NXOpen::Motion::CouplerCollection::FindObject ( const NXString name)

Finds a coupler with the given name.

   An exception will be thrown if no object can be found with given name.  @return  @link  Motion::Coupler   Motion::Coupler @endlink  with this name. 


Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
nameThe name of the Motion::Coupler .
NXOpen::Motion::Coupler* NXOpen::Motion::CouplerCollection::FindObject ( const char *  name)

Finds a coupler with the given name.

   An exception will be thrown if no object can be found with given name.  @return  @link  Motion::Coupler   Motion::Coupler @endlink  with this name. 


Created in NX6.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
nameThe name of the Motion::Coupler .
tag_t NXOpen::Motion::CouplerCollection::Tag ( ) const

Returns the tag of this object.


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