RTT::types::TypeInfoRepository Class Reference

#include <TypeInfoRepository.hpp>

List of all members.

Public Types

typedef boost::shared_ptr
< TypeInfoRepository > 		shared_ptr
typedef boost::shared_ptr
< TypeInfoRepository > 		shared_ptr

Public Member Functions

bool addType (TypeInfo *ti)
bool addType (TypeInfo *ti)
bool aliasType (const std::string &alias, TypeInfo *source=0)
bool aliasType (const std::string &alias, TypeInfo *source=0)
std::vector< std::string > getDottedTypes () const
std::vector< std::string > getDottedTypes () const
TypeInfo * getTypeById (std::string type_id_name) const
TypeInfo * getTypeById (std::string type_id_name) const
template<class T >
TypeInfo * getTypeInfo () const
template<class T >
TypeInfo * getTypeInfo () const
std::vector< std::string > getTypes () const
std::vector< std::string > getTypes () const
void logTypeInfo () const
void logTypeInfo () const
void registerTransport (TransportPlugin *tr)
void registerTransport (TransportPlugin *tr)
std::string toDot (const std::string &type) const
std::string toDot (const std::string &type) const
TypeInfo * type (const std::string &name) const
TypeInfo * type (const std::string &name) const
 ~TypeInfoRepository ()
 ~TypeInfoRepository ()

Static Public Member Functions

static shared_ptr Instance ()
static shared_ptr Instance ()

Private Types

typedef std::map< std::string,
TypeInfo * > 		map_t
typedef std::map< std::string,
TypeInfo * > 		map_t
typedef std::vector
< TransportPlugin * > 		Transports
typedef std::vector
< TransportPlugin * > 		Transports

Private Member Functions

 TypeInfoRepository ()
 TypeInfoRepository ()

Private Attributes

map_t data
Transports transports

Detailed Description

This class contains all known types to Orocos.

See also:
TemplateTypeInfo to add your own classes to Orocos.

Definition at line 54 of file install/include/rtt/types/TypeInfoRepository.hpp.

Member Typedef Documentation

typedef std::map<std::string, TypeInfo*> RTT::types::TypeInfoRepository::map_t [private]

Definition at line 57 of file rtt/types/TypeInfoRepository.hpp.

typedef std::map<std::string, TypeInfo*> RTT::types::TypeInfoRepository::map_t [private]

Definition at line 57 of file install/include/rtt/types/TypeInfoRepository.hpp.

typedef boost::shared_ptr<TypeInfoRepository> RTT::types::TypeInfoRepository::shared_ptr

Definition at line 64 of file rtt/types/TypeInfoRepository.hpp.

typedef boost::shared_ptr<TypeInfoRepository> RTT::types::TypeInfoRepository::shared_ptr

Definition at line 64 of file install/include/rtt/types/TypeInfoRepository.hpp.

typedef std::vector<TransportPlugin*> RTT::types::TypeInfoRepository::Transports [private]

Definition at line 60 of file rtt/types/TypeInfoRepository.hpp.

typedef std::vector<TransportPlugin*> RTT::types::TypeInfoRepository::Transports [private]

Definition at line 60 of file install/include/rtt/types/TypeInfoRepository.hpp.

Constructor & Destructor Documentation

RTT::TypeInfoRepository::TypeInfoRepository (  )  [private]

Definition at line 59 of file TypeInfoRepository.cpp.

RTT::TypeInfoRepository::~TypeInfoRepository (  ) 

Definition at line 86 of file TypeInfoRepository.cpp.

RTT::types::TypeInfoRepository::TypeInfoRepository (  )  [private]
RTT::types::TypeInfoRepository::~TypeInfoRepository (  ) 

Member Function Documentation

bool RTT::types::TypeInfoRepository::addType ( TypeInfo *  ti  ) 

Add a type to the Orocos type repository.

Parameters:
ti A type info object that becomes owned by the TypeInfoRepository. It's name must be unique.
Returns:
false if ti was already added or if ti->getTypeName() already exists in this repository.
bool RTT::TypeInfoRepository::addType ( TypeInfo *  ti  ) 

Add a type to the Orocos type repository.

Parameters:
ti A type info object that becomes owned by the TypeInfoRepository. It's name must be unique.
Returns:
false if ti was already added or if ti->getTypeName() already exists in this repository.

Definition at line 110 of file TypeInfoRepository.cpp.

bool RTT::types::TypeInfoRepository::aliasType ( const std::string &  alias,
TypeInfo *  source = 0 
)

Alias a type in the Orocos type repository with a new type info object. If alias has an existing type info object, it is deleted.

Parameters:
alias The alias for source, i.e. when requesting the alias, the type info of source is returned.
source The type info that represents 'orig' and 'alias'. Note that this is not the same as using addType() above, you still need source to be added with addType().
Returns:
false if source is null.
bool RTT::types::TypeInfoRepository::aliasType ( const std::string &  alias,
TypeInfo *  source = 0 
)

Alias a type in the Orocos type repository with a new type info object. If alias has an existing type info object, it is deleted.

Parameters:
alias The alias for source, i.e. when requesting the alias, the type info of source is returned.
source The type info that represents 'orig' and 'alias'. Note that this is not the same as using addType() above, you still need source to be added with addType().
Returns:
false if source is null.
std::vector<std::string> RTT::types::TypeInfoRepository::getDottedTypes (  )  const

List all registered types in the package.type notation.

std::vector< std::string > RTT::TypeInfoRepository::getDottedTypes (  )  const

List all registered types in the package.type notation.

Definition at line 158 of file TypeInfoRepository.cpp.

TypeInfo* RTT::types::TypeInfoRepository::getTypeById ( std::string  type_id_name  )  const

Return the type info structure of a given type name.

TypeInfo * RTT::TypeInfoRepository::getTypeById ( std::string  type_id_name  )  const

Return the type info structure of a given type name.

Definition at line 100 of file TypeInfoRepository.cpp.

template<class T >
TypeInfo* RTT::types::TypeInfoRepository::getTypeInfo (  )  const [inline]

Return the type info structure of a given type T.

Definition at line 122 of file rtt/types/TypeInfoRepository.hpp.

template<class T >
TypeInfo* RTT::types::TypeInfoRepository::getTypeInfo (  )  const [inline]

Return the type info structure of a given type T.

Definition at line 122 of file install/include/rtt/types/TypeInfoRepository.hpp.

std::vector<std::string> RTT::types::TypeInfoRepository::getTypes (  )  const

List all types registered with their original type name. See getDottedTypes for the typenames written in the 'package.type' notation.

std::vector< std::string > RTT::TypeInfoRepository::getTypes (  )  const

List all types registered with their original type name. See getDottedTypes for the typenames written in the 'package.type' notation.

Definition at line 142 of file TypeInfoRepository.cpp.

static shared_ptr RTT::types::TypeInfoRepository::Instance (  )  [static]
boost::shared_ptr< TypeInfoRepository > RTT::TypeInfoRepository::Instance (  )  [static]

Definition at line 63 of file TypeInfoRepository.cpp.

void RTT::types::TypeInfoRepository::logTypeInfo (  )  const

Dump all known types, along with transports and their types, to the log.

void RTT::TypeInfoRepository::logTypeInfo (  )  const

Dump all known types, along with transports and their types, to the log.

Definition at line 180 of file TypeInfoRepository.cpp.

void RTT::types::TypeInfoRepository::registerTransport ( TransportPlugin *  tr  ) 

Call this function to add a new (network) transport for Orocos types.

void RTT::TypeInfoRepository::registerTransport ( TransportPlugin *  tr  ) 

Call this function to add a new (network) transport for Orocos types.

Definition at line 166 of file TypeInfoRepository.cpp.

std::string RTT::types::TypeInfoRepository::toDot ( const std::string &  type  )  const

Convert any type name returned by getTypes() to the dotted type notation.

std::string RTT::types::TypeInfoRepository::toDot ( const std::string &  type  )  const

Convert any type name returned by getTypes() to the dotted type notation.

TypeInfo* RTT::types::TypeInfoRepository::type ( const std::string &  name  )  const

Retrieve a type with a given name.

Parameters:
name The type name as specified by the TypeInfo object, or it's dotted equivalent.
TypeInfo * RTT::TypeInfoRepository::type ( const std::string &  name  )  const

Retrieve a type with a given name.

Parameters:
name The type name as specified by the TypeInfo object, or it's dotted equivalent.

Definition at line 72 of file TypeInfoRepository.cpp.

Member Data Documentation

map_t RTT::types::TypeInfoRepository::data [private]

Definition at line 58 of file install/include/rtt/types/TypeInfoRepository.hpp.

Transports RTT::types::TypeInfoRepository::transports [private]

Definition at line 61 of file install/include/rtt/types/TypeInfoRepository.hpp.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:50:19 2013