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:

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

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 82 of file Factory.h.

Member Typedef Documentation

template<typename Interface >

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

Definition at line 85 of file Factory.h.

template<typename Interface >

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

Definition at line 84 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 87 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 98 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 120 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 109 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 130 of file Factory.h.

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

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

Here is the caller graph for this function:

template<typename Interface >

bool rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::operator< ( const ConnectorInfo &  other ) const

inline

Definition at line 134 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::name, rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::options, rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::remote, and rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::schemas.

template<typename Interface >

void rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::printContents ( std::ostream &  stream ) const

inlineprivate

Definition at line 156 of file Factory.h.

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

Member Data Documentation

template<typename Interface >

std::string rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::name

private

Definition at line 151 of file Factory.h.

Referenced by rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::getName(), and rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::operator<().

template<typename Interface >

OptionList rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::options

private

Definition at line 154 of file Factory.h.

Referenced by rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::getOptions(), rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::operator<(), rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::printContents(), and rsb::transport::ConnectorFactory< Interface >::registerConnector().

template<typename Interface >

bool rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::remote

private

Definition at line 153 of file Factory.h.

Referenced by rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::isRemote(), rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::operator<(), and rsb::transport::ConnectorFactory< Interface >::registerConnector().

template<typename Interface >

SchemaList rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::schemas

private

Definition at line 152 of file Factory.h.

Referenced by rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::getSchemas(), rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::operator<(), and rsb::transport::ConnectorFactory< Interface >::registerConnector().

---

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

• rsb/transport/Factory.h