orxonox::WANDiscoverable Class Reference

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/network/WANDiscoverable.h>

Inheritance diagram for orxonox::WANDiscoverable:

Public Member Functions
	WANDiscoverable ()
	constructor More...
	~WANDiscoverable ()
	destructor More...
std::string	getMSAddress ()
void	setActivity (bool bActive)
	Function used to set the activity/discoverability. More...
void	setConfigValues ()
	Function used for the configuration file parameter update. More...
void	updateClientNumber (int clientNumber)
Public Member Functions inherited from orxonox::Configurable
	Configurable ()
void	setConfigValues ()
	Function to collect the SetConfigValue-macro calls. More...
Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...
	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...
virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...
Context *	getContext () const
void	setContext (Context *context)
	Changes the context. More...
void	unregisterObject ()
	Removes this object from the object-lists. More...
Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...
virtual	~Identifiable ()
ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...
template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...
template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...
Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...
bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...
bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...
template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...
bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...
bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...
template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...
bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...
bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...
template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...
bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...
bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...
template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...
bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Public Attributes
MasterServerComm	msc
	Master server communications object. More...

Private Member Functions
bool	connect ()
	Function used to connect to the master server. More...
void	disconnect ()
	Function used to disconnect from the master server. More...

Private Attributes
bool	bActive_
std::string	msaddress
	master server address More...
std::string	ownName

Constructor & Destructor Documentation

orxonox::WANDiscoverable::WANDiscoverable

(

)

constructor

orxonox::WANDiscoverable::~WANDiscoverable

(

)

destructor

Member Function Documentation

bool orxonox::WANDiscoverable::connect ( )

private

Function used to connect to the master server.

void orxonox::WANDiscoverable::disconnect ( )

private

Function used to disconnect from the master server.

std::string orxonox::WANDiscoverable::getMSAddress ( )

inline

Returns

Address of the master server

Get the master server address

void orxonox::WANDiscoverable::setActivity

(

bool

bActive

)

Function used to set the activity/discoverability.

void orxonox::WANDiscoverable::setConfigValues

(

void

)

Function used for the configuration file parameter update.

void orxonox::WANDiscoverable::updateClientNumber

(

int

clientNumber

)

Member Data Documentation

bool orxonox::WANDiscoverable::bActive_

private

std::string orxonox::WANDiscoverable::msaddress

private

master server address

MasterServerComm orxonox::WANDiscoverable::msc

Master server communications object.

std::string orxonox::WANDiscoverable::ownName

private

---

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

• libraries/network/WANDiscoverable.h
• libraries/network/WANDiscoverable.cc