Orocos Real-Time Toolkit  2.9.0
Classes | Public Types | Public Member Functions | List of all members
RTT::dev::NameServer< _ValueType > Class Template Reference

A nameserver for Orocos Device classes. More...

#include <rtt/extras/dev/NameServer.hpp>

Classes

class  name_iterator
 An Iterator to iterate over the registered names. More...
 
class  value_iterator
 An Iterator to iterate over the registered objects. More...
 

Public Types

typedef _ValueType ValueType
 
typedef std::string NameType
 
typedef std::map< NameType, ValueTypeRep
 
typedef Rep::iterator iterator
 The iterator for iterating over the internal representation. More...
 
typedef Rep::const_iterator const_iterator
 The const_iterator for iterating over the internal representation. More...
 

Public Member Functions

 NameServer ()
 Construct an empty NameServer. More...
 
 ~NameServer ()
 Destruct a nameserver. More...
 
bool isNameRegistered (const NameType &s) const
 Determine if a given name is registered. More...
 
bool isObjectRegistered (const ValueType o) const
 Determine if a given object is registered. More...
 
ValueType getObject (const NameType &s) const
 Get the object registered for a name. More...
 
const NameTypegetName (const ValueType s) const
 Get the name registered for a object. More...
 
bool registerObject (const ValueType obj, const NameType &name)
 Register an object with a name. More...
 
void unregisterObject (const ValueType obj)
 Remove an object from the nameserver registrations. More...
 
void unregisterName (const NameType &name)
 Remove a name from the nameserver registrations. More...
 
name_iterator getNameBegin ()
 Get an iterator to the beginning of the names list. More...
 
name_iterator getNameEnd ()
 Get an iterator to the end of the names list. More...
 
value_iterator getValueBegin ()
 Get an iterator to the beginning of the objects list. More...
 
value_iterator getValueEnd ()
 Get an iterator to the end of the objects list. More...
 

Detailed Description

template<class _ValueType>
class RTT::dev::NameServer< _ValueType >

A nameserver for Orocos Device classes.

This class allows to globally set up device driver objects and find them back in the same process by querying this class. Every Orocos device driver type has a Device::nameserver type which allows retrieval of the object:

// At application startup code:
Device* init_device = new Device("device_name");
// ...
// In other places:
Device* myDevice = Device::nameserver.getObject("device_name");

In case two objects are registered with the same name, the first one is kept and the second one rejected.

Parameters
_ValueTypeThe type of objects you want to have nameserved( usually a pointer type ).

Definition at line 71 of file NameServer.hpp.

Member Typedef Documentation

template<class _ValueType>
typedef Rep::const_iterator RTT::dev::NameServer< _ValueType >::const_iterator

The const_iterator for iterating over the internal representation.

Definition at line 84 of file NameServer.hpp.

template<class _ValueType>
typedef Rep::iterator RTT::dev::NameServer< _ValueType >::iterator

The iterator for iterating over the internal representation.

Definition at line 80 of file NameServer.hpp.

template<class _ValueType>
typedef std::string RTT::dev::NameServer< _ValueType >::NameType

Definition at line 75 of file NameServer.hpp.

template<class _ValueType>
typedef std::map<NameType, ValueType> RTT::dev::NameServer< _ValueType >::Rep

Definition at line 76 of file NameServer.hpp.

template<class _ValueType>
typedef _ValueType RTT::dev::NameServer< _ValueType >::ValueType

Definition at line 74 of file NameServer.hpp.

Constructor & Destructor Documentation

template<class _ValueType>
RTT::dev::NameServer< _ValueType >::NameServer ( )
inline

Construct an empty NameServer.

Definition at line 89 of file NameServer.hpp.

template<class _ValueType>
RTT::dev::NameServer< _ValueType >::~NameServer ( )
inline

Destruct a nameserver.

Definition at line 95 of file NameServer.hpp.

Member Function Documentation

template<class _ValueType>
const NameType& RTT::dev::NameServer< _ValueType >::getName ( const ValueType  s) const
inline

Get the name registered for a object.

Parameters
sthe object of the name you need
Returns
the name the object is registered with, if the object isn't registered, it will return 0

Definition at line 153 of file NameServer.hpp.

template<class _ValueType>
name_iterator RTT::dev::NameServer< _ValueType >::getNameBegin ( )
inline

Get an iterator to the beginning of the names list.

Definition at line 368 of file NameServer.hpp.

template<class _ValueType>
name_iterator RTT::dev::NameServer< _ValueType >::getNameEnd ( )
inline

Get an iterator to the end of the names list.

Definition at line 373 of file NameServer.hpp.

template<class _ValueType>
ValueType RTT::dev::NameServer< _ValueType >::getObject ( const NameType s) const
inline

Get the object registered for a name.

Parameters
sthe name of the object you need
Returns
the object the name is registered with, if the name isn't registered, it will return 0

Definition at line 136 of file NameServer.hpp.

Referenced by __os_init(), and RTT::os::Thread::Thread().

template<class _ValueType>
value_iterator RTT::dev::NameServer< _ValueType >::getValueBegin ( )
inline

Get an iterator to the beginning of the objects list.

Definition at line 378 of file NameServer.hpp.

template<class _ValueType>
value_iterator RTT::dev::NameServer< _ValueType >::getValueEnd ( )
inline

Get an iterator to the end of the objects list.

Definition at line 383 of file NameServer.hpp.

template<class _ValueType>
bool RTT::dev::NameServer< _ValueType >::isNameRegistered ( const NameType s) const
inline

Determine if a given name is registered.

Parameters
sthe name to check
Returns
true if s is registered, false otherwise

Definition at line 105 of file NameServer.hpp.

Referenced by RTT::dev::NameServer< AnalogOutInterface * >::registerObject().

template<class _ValueType>
bool RTT::dev::NameServer< _ValueType >::isObjectRegistered ( const ValueType  o) const
inline

Determine if a given object is registered.

Parameters
othe object to check
Returns
true if o is registered, false otherwise

Definition at line 117 of file NameServer.hpp.

template<class _ValueType>
bool RTT::dev::NameServer< _ValueType >::registerObject ( const ValueType  obj,
const NameType name 
)
inline

Register an object with a name.

If an object with such a name already exists, the present one will not be overwritten, and this call is a no-op.

Parameters
objThe instance you wish to register with a name
nameThe name of the object

Definition at line 172 of file NameServer.hpp.

Referenced by RTT::dev::NameServerRegistrator< AnalogOutInterface * >::NameServerRegistrator().

template<class _ValueType>
void RTT::dev::NameServer< _ValueType >::unregisterName ( const NameType name)
inline

Remove a name from the nameserver registrations.

Parameters
namethe name of the object you want remove

Definition at line 221 of file NameServer.hpp.

template<class _ValueType>
void RTT::dev::NameServer< _ValueType >::unregisterObject ( const ValueType  obj)
inline

Remove an object from the nameserver registrations.

Parameters
objthe object you want removed
Postcondition
obj will not be registered anymore
Todo:
might be improved by using equal_range

Definition at line 190 of file NameServer.hpp.

Referenced by RTT::dev::NameServerRegistrator< AnalogOutInterface * >::~NameServerRegistrator().


The documentation for this class was generated from the following file: