rsb::ParticipantConfig::Transport Class Reference

Description of a desired transport. More...

#include <ParticipantConfig.h>

Inheritance diagram for rsb::ParticipantConfig::Transport:

Collaboration diagram for rsb::ParticipantConfig::Transport:

Public Types
typedef std::set< std::pair < std::string, std::string > >	ConverterNames

Public Member Functions
	Transport (const std::string &name, bool enabled=true)
	Creates a new transport description for the transport with the given name.
virtual	~Transport ()
std::string	getName () const
	Returns the name of this transport description.
ConverterNames	getConverters () const
rsc::runtime::Properties	getOptions () const
	Returns the specified options for the transport.
rsc::runtime::Properties &	mutableOptions ()
	Returns the options for the transport.
void	setOptions (const rsc::runtime::Properties &options)
	Sets the options for the transport.
bool	isEnabled () const
void	setEnabled (bool value)
bool	operator== (const Transport &other) const
bool	operator< (const Transport &other) const
std::string	getClassName () const
void	printContents (std::ostream &stream) const
void	handleOption (const std::vector< std::string > &key, const std::string &value)

Private Attributes
std::string	name
ConverterNames	converters
rsc::runtime::Properties	options

Detailed Description

Description of a desired transport.

Transport configurations are compared by the name of the transport they describe because one transport can exist only once per participant.

Author

jwienke

Definition at line 72 of file ParticipantConfig.h.

Member Typedef Documentation

typedef std::set<std::pair<std::string, std::string> > rsb::ParticipantConfig::Transport::ConverterNames

Definition at line 76 of file ParticipantConfig.h.

Constructor & Destructor Documentation

rsb::ParticipantConfig::Transport::Transport ( const std::string &  name, bool  enabled = true  )

explicit

Creates a new transport description for the transport with the given name.

Parameters

name	name of the transport to describe
enabled	controls whether the transport is used by default.

Exceptions

std::invalid_argument

empty name given, a transport cannot have an empty name

Definition at line 51 of file ParticipantConfig.cpp.

References setEnabled().

Here is the call graph for this function:

rsb::ParticipantConfig::Transport::~Transport ( )

virtual

Definition at line 63 of file ParticipantConfig.cpp.

Member Function Documentation

string rsb::ParticipantConfig::Transport::getClassName

(

)

const

Definition at line 132 of file ParticipantConfig.cpp.

ParticipantConfig::Transport::ConverterNames rsb::ParticipantConfig::Transport::getConverters

(

)

const

Definition at line 70 of file ParticipantConfig.cpp.

string rsb::ParticipantConfig::Transport::getName

(

)

const

Returns the name of this transport description.

Definition at line 66 of file ParticipantConfig.cpp.

Referenced by rsb::ParticipantConfig::addTransport(), and rsb::ParticipantConfig::removeTransport().

Here is the caller graph for this function:

rsc::runtime::Properties rsb::ParticipantConfig::Transport::getOptions

(

)

const

Returns the specified options for the transport.

Returns

copy of options for the transport

Definition at line 74 of file ParticipantConfig.cpp.

References rsb::ParticipantConfig::options.

void rsb::ParticipantConfig::Transport::handleOption	(	const std::vector< std::string > &	key,
		const std::string &	value
	)

Definition at line 97 of file ParticipantConfig.cpp.

References rsb::ParticipantConfig::options.

Referenced by rsb::ParticipantConfig::handleOption().

Here is the caller graph for this function:

bool rsb::ParticipantConfig::Transport::isEnabled

(

)

const

Definition at line 87 of file ParticipantConfig.cpp.

References rsb::ParticipantConfig::getOptions().

Here is the call graph for this function:

rsc::runtime::Properties & rsb::ParticipantConfig::Transport::mutableOptions

(

)

Returns the options for the transport.

Returns

mutable reference to options for the transport

Definition at line 78 of file ParticipantConfig.cpp.

References rsb::ParticipantConfig::options.

bool rsb::ParticipantConfig::Transport::operator<

(

const Transport &

other

)

const

Definition at line 128 of file ParticipantConfig.cpp.

References name.

bool rsb::ParticipantConfig::Transport::operator==

(

const Transport &

other

)

const

Definition at line 124 of file ParticipantConfig.cpp.

References name.

void rsb::ParticipantConfig::Transport::printContents

(

std::ostream &

stream

)

const

Definition at line 136 of file ParticipantConfig.cpp.

References rsb::ParticipantConfig::options.

void rsb::ParticipantConfig::Transport::setEnabled

(

bool

value

)

Definition at line 91 of file ParticipantConfig.cpp.

References rsb::ParticipantConfig::getOptions(), rsb::ParticipantConfig::options, and rsb::ParticipantConfig::setOptions().

Referenced by rsb::Factory::Factory(), and Transport().

Here is the call graph for this function:

Here is the caller graph for this function:

void rsb::ParticipantConfig::Transport::setOptions

(

const rsc::runtime::Properties &

options

)

Sets the options for the transport.

Parameters

options

new options replacing all old ones

Definition at line 83 of file ParticipantConfig.cpp.

References rsb::ParticipantConfig::options.

Member Data Documentation

ConverterNames rsb::ParticipantConfig::Transport::converters

private

Definition at line 134 of file ParticipantConfig.h.

std::string rsb::ParticipantConfig::Transport::name

private

Definition at line 133 of file ParticipantConfig.h.

Referenced by operator<(), and operator==().

rsc::runtime::Properties rsb::ParticipantConfig::Transport::options

private

Definition at line 135 of file ParticipantConfig.h.

---

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

• rsb/ParticipantConfig.h
• rsb/ParticipantConfig.cpp