4S Device Communication Module Collection  Version 0.6-SNAPSHOT
Public interfaces of the modules in the 4SDC collection (aimed at users of the 4SDC modules)
Public Member Functions | Static Public Member Functions | Friends | List of all members
FSYS::MsgAddr Class Reference

The MsgAddr class contains a unique address in the message system. More...

#include <msgaddr.h>

+ Collaboration diagram for FSYS::MsgAddr:

Public Member Functions

 MsgAddr (void)
 Default constructor. More...
 
void clear (void)
 Funciton that clears the address stored in the object.
 
bool isValid (void)
 Function to determine if this address is valid (!=null) More...
 
bool operator== (MsgAddr const &compareTo) const
 operator == More...
 
bool operator!= (MsgAddr const &compareTo) const
 operator != More...
 

Static Public Member Functions

static MsgAddr & broadcastAddr (void)
 Returns the broadcast address. More...
 

Friends

template<class parentClass >
class MsgAddrGenerator
 
class MsgSenderBase
 
class MsgQueue
 

Detailed Description

A MsgAddr identifies a specific instance of a specifc object to the message system.

Constructor & Destructor Documentation

FSYS::MsgAddr::MsgAddr ( void  )

The default constructor doesn't do anything except initializing the private members.

Member Function Documentation

static MsgAddr& FSYS::MsgAddr::broadcastAddr ( void  )
static

The broadcast address is an address that will match all addresses, and hence can be used for sending to all addresses

Returns
The bradcast address
bool FSYS::MsgAddr::isValid ( void  )

This function verifies if the address is null or not, or if part of the address is null - it does not try to determine if the address is actually a valid address of an existing object.

Returns
true if the address is non-null
false if the addres or part it is null
bool FSYS::MsgAddr::operator!= ( MsgAddr const &  compareTo) const
inline

Compares two addresses and return false if they are equal

Parameters
compareTothe addres this object should be compared to
Returns
false if the addresses are equal, true if not
bool FSYS::MsgAddr::operator== ( MsgAddr const &  compareTo) const
inline

Compares two addresses and return true if they are equal

Parameters
compareTothe addres this object should be compared to
Returns
true if the addresses are equal, false if not
The documentation for this class was generated from the following file: