SystemMessageProvider Class Reference

#include <SystemMessageProvider.h>

Inheritance diagram for SystemMessageProvider:

[legend]List of all members.

Public Types
enum	MessageType {   AD_CHANGE,   TIMER_CHANGE }
enum	Status {   OK,   FAILED }
Public Member Functions
MessageType	getType ()
	Returns the type of SystemMessageProvider.
char	getChannel ()
	Returns the type of SystemMessageProvider.
virtual int	getPayloadLength ()=0
	Returns the size of the payload in bytes.
virtual Status	getPayloadBytes (char *buffer)=0
	Copies the payload into the destination buffer.
virtual	~SystemMessageProvider ()
Protected Member Functions
	SystemMessageProvider (MessageType t, char ch)
	Constructor, requires the MessageType is passed during initialization.
Protected Attributes
const MessageType	type
	A constant to hold the messagetype.
const char	channel
	A constant to hold the channel.

---

Member Enumeration Documentation

enum SystemMessageProvider::MessageType

Enumerator: AD_CHANGE  An analog to digital converter status changed. TIMER_CHANGE  A timer changed state.

enum SystemMessageProvider::Status

Enumerator: OK  Success. FAILED  A problem occured.

---

Constructor & Destructor Documentation

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

SystemMessageProvider::SystemMessageProvider (  MessageType  t, char  ch )  [inline, protected]

Constructor, requires the MessageType is passed during initialization. Parameters: type

---

Member Function Documentation

char SystemMessageProvider::getChannel (   )  [inline]

Returns the type of SystemMessageProvider. Returns: MessageType

virtual Status SystemMessageProvider::getPayloadBytes (  char *  buffer  )  [pure virtual]

Copies the payload into the destination buffer. Parameters: buffer  a buffer the recieve the payload data from the SystemMessageProvider. Returns: Status Implemented in ADMessageProvider.

virtual int SystemMessageProvider::getPayloadLength (   )  [pure virtual]

Returns the size of the payload in bytes. Returns: int Implemented in ADMessageProvider.

MessageType SystemMessageProvider::getType (   )  [inline]

Returns the type of SystemMessageProvider. Returns: MessageType

---

Member Data Documentation

const char SystemMessageProvider::channel [protected]

A constant to hold the channel.

const MessageType SystemMessageProvider::type [protected]

A constant to hold the messagetype.

---

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

• SystemMessageProvider.h

---