RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rsb::transport::ConnectorFactory< Interface >::ConnectorInfo Class Reference

Instances of this class describe capabilities and properties of connector implementations. More...

#include <Factory.h>

Inheritance diagram for rsb::transport::ConnectorFactory< Interface >::ConnectorInfo:
Inheritance graph
Collaboration diagram for rsb::transport::ConnectorFactory< Interface >::ConnectorInfo:
Collaboration graph

Public Types

typedef std::set< std::string > SchemaList
 
typedef std::set< std::string > OptionList
 

Public Member Functions

 ConnectorInfo (const std::string &name, const SchemaList &schemas, bool remote, const OptionList &options)
 
std::string getName () const
 Return the name of the implementation. More...
 
SchemaList getSchemas () const
 Return the set of schemas supported by the connector implementation. More...
 
OptionList getOptions () const
 Return a list of option names describing configurations options recognized by the implementation. More...
 
bool isRemote () const
 Return "remoteness" of the implementation. More...
 
bool operator< (const ConnectorInfo &other) const
 

Private Member Functions

void printContents (std::ostream &stream) const
 

Private Attributes

std::string name
 
SchemaList schemas
 
bool remote
 
OptionList options
 

Detailed Description

template<typename Interface>
class rsb::transport::ConnectorFactory< Interface >::ConnectorInfo

Instances of this class describe capabilities and properties of connector implementations.

Author
jmoringe

Definition at line 91 of file Factory.h.

Member Typedef Documentation

template<typename Interface >
typedef std::set<std::string> rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::OptionList

Definition at line 94 of file Factory.h.

template<typename Interface >
typedef std::set<std::string> rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::SchemaList

Definition at line 93 of file Factory.h.

Constructor & Destructor Documentation

template<typename Interface >
rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::ConnectorInfo ( const std::string &  name,
const SchemaList schemas,
bool  remote,
const OptionList options 
)
inline

Definition at line 96 of file Factory.h.

Member Function Documentation

template<typename Interface >
std::string rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::getName ( ) const
inline

Return the name of the implementation.

Definition at line 107 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::name.

template<typename Interface >
OptionList rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::getOptions ( ) const
inline

Return a list of option names describing configurations options recognized by the implementation.

Returns
A std::set containing the names of recognized options.

Definition at line 129 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::options.

template<typename Interface >
SchemaList rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::getSchemas ( ) const
inline

Return the set of schemas supported by the connector implementation.

Returns
A std::set containing the supported schemas as strings.

Definition at line 118 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::schemas.

template<typename Interface >
bool rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::isRemote ( ) const
inline

Return "remoteness" of the implementation.

Returns
true if the transport allows communication across process boundaries, false otherwise.

Definition at line 139 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::remote.

Referenced by rsb::transport::isRemote().

Here is the caller graph for this function:

Member Data Documentation


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