CommsHelper Class Reference

List of all members.

---

Detailed Description

This is the class template for communication adaptor helper classes.

The helper class should contain all mechanisms for connecting and disconnecting the system, along with any updates that need to run.

Definition at line 47 of file CommsHelper.H.

Public Member Functions
	CommsHelper (const std::string &name)
virtual	~CommsHelper ()
void	setName (const char *name)
	Set the name of this module.
const std::string	getName ()
	Return the name of this module.
virtual int	initialize (int argc, char *argv[], const bool &override)=0
	Initialize the communication adaptor.
virtual const Protocols	getProtocol ()=0
	Returns the protocol handled by this helper (see CommsManager).
virtual COMBase *	getCOMBase (const std::string interfacetype, const std::string objectName)=0
virtual void	runUpdate ()=0
	Run the update loop of the adaptor.
virtual void	disconnect ()=0
	Clean up the adaptor and disconnect.
virtual void	closeConnections ()=0
Protected Attributes
std::string	m_name
	Name of this module.
unsigned int *	m_supplyCounters
	Number of suppliers of each data type.
unsigned int *	m_counters
	Number of consumers of each data type.
unsigned int	m_numCounters
	Length of the counter arrays.
std::vector< Capability * > *	objectList

---

Constructor & Destructor Documentation

CommsHelper

(

const std::string &

name

)

[inline]

Definition at line 51 of file CommsHelper.H.

References CommsHelper::m_name.

virtual ~CommsHelper

(

)

[inline, virtual]

Definition at line 53 of file CommsHelper.H.

---

Member Function Documentation

void setName

(

const char *

name

)

[inline]

Set the name of this module.

Definition at line 58 of file CommsHelper.H.

References CommsHelper::m_name.

Referenced by CommsManager::setName().

const std::string getName

(

)

[inline]

Return the name of this module.

Definition at line 62 of file CommsHelper.H.

References CommsHelper::m_name.

virtual int initialize	(	int	argc,
		char *	argv[],
		const bool &	override
	)			[pure virtual]

Initialize the communication adaptor.

Parameters:

override

The override parameter allows the adaptor to punt other modules that have the same name.

Todo:

Passing in argc, argv here is absolutely, 100% stupid. We really should have a configuration object.

Referenced by CommsManager::initialize().

virtual const Protocols getProtocol

(

)

[pure virtual]

Returns the protocol handled by this helper (see CommsManager).

virtual COMBase* getCOMBase	(	const std::string	interfacetype,
		const std::string	objectName
	)			[pure virtual]

Referenced by CommsManager::registerObject().

virtual void runUpdate

(

)

[pure virtual]

Run the update loop of the adaptor.

Referenced by CommsManager::cleanUp(), and CommsManager::runUpdate().

virtual void disconnect

(

)

[pure virtual]

Clean up the adaptor and disconnect.

Referenced by CommsManager::cleanUp().

virtual void closeConnections

(

)

[pure virtual]

Referenced by CommsManager::closeConnections().

---

Member Data Documentation

std::string m_name [protected]

Name of this module.

Definition at line 92 of file CommsHelper.H.

Referenced by CommsHelper::CommsHelper(), CommsHelper::getName(), and CommsHelper::setName().

unsigned int* m_supplyCounters [protected]

Number of suppliers of each data type.

Definition at line 97 of file CommsHelper.H.

unsigned int* m_counters [protected]

Number of consumers of each data type.

Definition at line 101 of file CommsHelper.H.

unsigned int m_numCounters [protected]

Length of the counter arrays.

Definition at line 105 of file CommsHelper.H.

std::vector< Capability * >* objectList [protected]

Definition at line 107 of file CommsHelper.H.

---

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

• /home/fwph/code/wurde/rde/core/CommsHelper.H

---