Public Member Functions | Protected Attributes

Communicator Class Reference

The class holds information about a generic communicator service, defined by wosh::interfaces::communication::Communicator. More...

#include <H:/WOSH/win32_vc2010/src/bundles/CommunicationManager/Communicator.h>

List of all members.

Public Member Functions

 Communicator ()
 Empty constructor.
 Communicator (const Communicator &m)
 Copy constructor.
virtual ~Communicator ()
 Empty destructor.
Setters
virtual void setName (const std::string &value)
 Set the name (string) associated with the object, it will also update URI's name.
void setChannelTypes (int value)
void setChannelLink (CHANNEL_LINK value)
void setProtocol (wosh::Notification::PROTOCOL value)
void setCost (double value)
void setPriority (int value)
void setReliability (int value)
void setSeen ()
Operators Overloading
virtual Communicatoroperator= (const Communicator &m)
virtual bool operator== (const Communicator &other) const
virtual bool operator!= (const Communicator &other) const
Serialization interface
virtual std::string toString () const
virtual bool updateHash (wosh::DataHashContext *hash_context) const

Protected Attributes

int64 timestamp
 last seen (epoch) of real object
wosh::InterfacesProvider Interfaces
 implemented interfaces
int channelTypes
 describes the supported service {as messaging, phone, video}. See CHANNEL_TYPE
CHANNEL_LINK channelLink
 describes the communication channel {synch, asynch}
wosh::Notification::PROTOCOL protocol
 describes the communication protocol {human language, shell syntax, ..}
double cost
 cost of the service, / message
int priority
 priority of the service
int reliability
 reliability of the service
std::vector< std::string > locations
 location(s) of communicator (usually its a device)

Getters

int getChannelTypes () const
std::string getChannelTypesAsString () const
CHANNEL_LINK getChannelLink () const
wosh::Notification::PROTOCOL getProtocol () const
const char * getProtocolAsString () const
double getCost () const
int getPriority () const
int getReliability () const
const wosh::InterfacesProvidergetInterfaces () const
wosh::InterfacesProvidergetInterfaces ()
int64 getSeen () const
const std::vector< std::string > & getLocations () const
std::vector< std::string > & getLocations ()
bool isInLocation (const std::string &location) const
static std::string getChannelTypesAsString (int types)

Detailed Description

The class holds information about a generic communicator service, defined by wosh::interfaces::communication::Communicator.

See also:
wosh::bundles::CommunicatorManagerBundle
Version:
Id:
Communicator.h 3775 2011-01-01 16:38:17Z alex
Author:
Alessandro Polo

Definition at line 51 of file bundles/CommunicationManager/Communicator.h.


Constructor & Destructor Documentation

Communicator::Communicator (  )

Empty constructor.

Definition at line 48 of file Communicator.cpp.

Communicator::Communicator ( const Communicator m ) [inline]

Copy constructor.

Parameters:
m[in] the source object to be copied

Definition at line 82 of file bundles/CommunicationManager/Communicator.h.

virtual Communicator::~Communicator (  ) [inline, virtual]

Empty destructor.

Definition at line 88 of file bundles/CommunicationManager/Communicator.h.


Member Function Documentation

void Communicator::setName ( const std::string &  value ) [virtual]

Set the name (string) associated with the object, it will also update URI's name.

Parameters:
value[in] the name of the object as STL string

Reimplemented from wosh::Object.

Definition at line 61 of file Communicator.cpp.


Member Data Documentation

CHANNEL_LINK Communicator::channelLink [protected]

describes the communication channel {synch, asynch}

Definition at line 168 of file bundles/CommunicationManager/Communicator.h.

int Communicator::channelTypes [protected]

describes the supported service {as messaging, phone, video}. See CHANNEL_TYPE

Definition at line 167 of file bundles/CommunicationManager/Communicator.h.

double Communicator::cost [protected]

cost of the service, / message

Definition at line 171 of file bundles/CommunicationManager/Communicator.h.

implemented interfaces

Definition at line 165 of file bundles/CommunicationManager/Communicator.h.

std::vector<std::string> Communicator::locations [protected]

location(s) of communicator (usually its a device)

Definition at line 175 of file bundles/CommunicationManager/Communicator.h.

int Communicator::priority [protected]

priority of the service

Definition at line 172 of file bundles/CommunicationManager/Communicator.h.

wosh:: Notification::PROTOCOL Communicator::protocol [protected]

describes the communication protocol {human language, shell syntax, ..}

Definition at line 170 of file bundles/CommunicationManager/Communicator.h.

int Communicator::reliability [protected]

reliability of the service

Definition at line 173 of file bundles/CommunicationManager/Communicator.h.

int64 Communicator::timestamp [protected]

last seen (epoch) of real object

Definition at line 164 of file bundles/CommunicationManager/Communicator.h.


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

Generated on Tue Feb 8 2011 09:33:24 for WOSH system 0.8.888 [wolf] by Alessandro Polo, using DoxyGen 1.7.2 hosted by WOSH Framework