freedm::broker::IDGIModule Class Reference

An interface for an object which can handle recieving incoming messages.

#include <IDGIModule.hpp>

Inheritance diagram for freedm::broker::IDGIModule:

Public Member Functions
	IDGIModule ()
	Constructor, initializes the reference to self. More...
virtual	~IDGIModule ()
	Virtual destructor for inhertiance. More...
virtual void	HandleIncomingMessage (boost::shared_ptr< const ModuleMessage > msg, CPeerNode peer)=0
	Handles received messages. More...

Protected Member Functions
CPeerNode	GetMe ()
	Gets a CPeerNode representing this process. More...
std::string	GetUUID () const
	Gets the UUID of this process. More...

Private Attributes
CPeerNode	m_me
	The CPeerNode this represents. More...

Constructor & Destructor Documentation

IDGIModule::IDGIModule

(

)

IDGIModule

Description:

Constructor for an IDGIModule. Gets the uuid from CGlobalConfiguration and makes a CPeerNode referencing it.

Precondition:

CGlobalConfiguration is loaded.

Postcondition:

m_me is created.

virtual freedm::broker::IDGIModule::~IDGIModule ( )

inlinevirtual

Member Function Documentation

CPeerNode IDGIModule::GetMe ( )

protected

GetMe

Description:

Gets a CPeerNode that refers to this process.

Returns

A CPeerNode referring to this process.

std::string IDGIModule::GetUUID ( ) const

protected

GetUUID

Description:

Gets this process's UUID.

Returns

This process's UUID

virtual void freedm::broker::IDGIModule::HandleIncomingMessage ( boost::shared_ptr< const ModuleMessage >  msg, CPeerNode  peer  )

pure virtual

Implemented in freedm::broker::sc::SCAgent, freedm::broker::lb::LBAgent, freedm::broker::gm::GMAgent, and freedm::broker::CClockSynchronizer.

Member Data Documentation

CPeerNode freedm::broker::IDGIModule::m_me

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/freedm/checkouts/opnet-ecn/Broker/src/IDGIModule.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/freedm/checkouts/opnet-ecn/Broker/src/IDGIModule.cpp