CMOOSCommunity Class Reference

#include <MOOSCommunity.h>

Collaboration diagram for CMOOSCommunity:

List of all members.

Public Types
typedef std::pair< std::string, std::string >	SP
Public Member Functions
std::string	GetFormattedName ()
std::string	GetCommsName ()
std::string	GetCommunityName ()
std::string	GetUDPHost ()
bool	DoRegistration ()
bool	Initialise (const std::string &sCommunityName)
bool	InitialiseMOOSClient (const std::string &sHostName, long nPort, const std::string &sMOOSName, int nFreq)
bool	AddSource (const std::string &sStr)
bool	AddSink (const SP &sIndex, const std::string &sAlias)
bool	WantsToSink (const SP &sIndex)
std::string	GetAlias (const SP &sIndex)
	CMOOSCommunity ()
virtual	~CMOOSCommunity ()
bool	Fetch (MOOSMSG_LIST &Mail)
bool	Post (CMOOSMsg &M)
bool	SetUDPInfo (const std::string &sHost, int nPort)
bool	IsMOOSClientRunning ()
int	GetUDPPort ()
bool	HasUDPConfigured () const
bool	HasMOOSSRegistration (const std::string &sVariable)
Protected Attributes
CMOOSCommClient	m_CommClient
std::set< std::string >	m_Sources
std::map< SP, std::string >	m_Sinks
std::string	m_sCommunityName
int	m_nSharedFreq
bool	m_bMOOSClientRunning
std::string	m_sUDPHost
int	m_nUDPPort

---

Detailed Description

Definition at line 44 of file MOOSCommunity.h.

---

Member Typedef Documentation

typedef std::pair<std::string,std::string> CMOOSCommunity::SP

Definition at line 47 of file MOOSCommunity.h.

---

Constructor & Destructor Documentation

CMOOSCommunity::CMOOSCommunity

(

)

Definition at line 54 of file MOOSCommunity.cpp.

CMOOSCommunity::~CMOOSCommunity

(

)

[virtual]

Definition at line 62 of file MOOSCommunity.cpp.

---

Member Function Documentation

bool CMOOSCommunity::AddSink	(	const SP &	sIndex,
		const std::string &	sAlias
	)

Definition at line 91 of file MOOSCommunity.cpp.

bool CMOOSCommunity::AddSource

(

const std::string &

sStr

)

Definition at line 75 of file MOOSCommunity.cpp.

bool CMOOSCommunity::DoRegistration

(

)

Definition at line 206 of file MOOSCommunity.cpp.

bool CMOOSCommunity::Fetch

(

MOOSMSG_LIST &

Mail

)

Definition at line 195 of file MOOSCommunity.cpp.

std::string CMOOSCommunity::GetAlias

(

const SP &

sIndex

)

Definition at line 108 of file MOOSCommunity.cpp.

string CMOOSCommunity::GetCommsName

(

)

Definition at line 225 of file MOOSCommunity.cpp.

std::string CMOOSCommunity::GetCommunityName

(

)

Definition at line 160 of file MOOSCommunity.cpp.

string CMOOSCommunity::GetFormattedName

(

)

Definition at line 220 of file MOOSCommunity.cpp.

std::string CMOOSCommunity::GetUDPHost

(

)

Definition at line 190 of file MOOSCommunity.cpp.

int CMOOSCommunity::GetUDPPort

(

)

Definition at line 185 of file MOOSCommunity.cpp.

bool CMOOSCommunity::HasMOOSSRegistration

(

const std::string &

sVariable

)

Definition at line 149 of file MOOSCommunity.cpp.

bool CMOOSCommunity::HasUDPConfigured

(

)

const

Definition at line 180 of file MOOSCommunity.cpp.

bool CMOOSCommunity::Initialise

(

const std::string &

sCommunityName

)

bool CMOOSCommunity::InitialiseMOOSClient	(	const std::string &	sHostName,
		long	nPort,
		const std::string &	sMOOSName,
		int	nFreq
	)

Definition at line 123 of file MOOSCommunity.cpp.

bool CMOOSCommunity::IsMOOSClientRunning

(

)

Definition at line 155 of file MOOSCommunity.cpp.

bool CMOOSCommunity::Post

(

CMOOSMsg &

M

)

Definition at line 200 of file MOOSCommunity.cpp.

bool CMOOSCommunity::SetUDPInfo	(	const std::string &	sHost,
		int	nPort
	)

Definition at line 172 of file MOOSCommunity.cpp.

bool CMOOSCommunity::WantsToSink

(

const SP &

sIndex

)

Definition at line 67 of file MOOSCommunity.cpp.

---

Member Data Documentation

bool CMOOSCommunity::m_bMOOSClientRunning [protected]

Definition at line 85 of file MOOSCommunity.h.

CMOOSCommClient CMOOSCommunity::m_CommClient [protected]

Definition at line 77 of file MOOSCommunity.h.

int CMOOSCommunity::m_nSharedFreq [protected]

Definition at line 83 of file MOOSCommunity.h.

int CMOOSCommunity::m_nUDPPort [protected]

Definition at line 88 of file MOOSCommunity.h.

std::string CMOOSCommunity::m_sCommunityName [protected]

Definition at line 82 of file MOOSCommunity.h.

std::map<SP,std::string> CMOOSCommunity::m_Sinks [protected]

Definition at line 80 of file MOOSCommunity.h.

std::set<std::string> CMOOSCommunity::m_Sources [protected]

Definition at line 79 of file MOOSCommunity.h.

std::string CMOOSCommunity::m_sUDPHost [protected]

Definition at line 87 of file MOOSCommunity.h.

---

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

• /home/toby/moos-ivp/MOOS-2375-Oct0611/Essentials/pMOOSBridge/MOOSCommunity.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/Essentials/pMOOSBridge/MOOSCommunity.cpp