ADMessageProvider Class Reference

#include <ADMessageProvider.h>

Inheritance diagram for ADMessageProvider:

[legend]Collaboration diagram for ADMessageProvider:

[legend]List of all members.

Public Types
enum	MessageType {   AD_CHANGE,   TIMER_CHANGE }
enum	Status {   OK,   FAILED }
Public Member Functions
virtual int	getPayloadLength ()
	Returns the size of the payload in bytes.
virtual Status	getPayloadBytes (char *buffer)
	Copies the payload into the destination buffer.
	ADMessageProvider (MessageType type, char channel)
MessageType	getType ()
	Returns the type of SystemMessageProvider.
char	getChannel ()
	Returns the type of SystemMessageProvider.
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 [inherited]

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

enum SystemMessageProvider::Status [inherited]

Enumerator: OK  Success. FAILED  A problem occured.

---

Constructor & Destructor Documentation

ADMessageProvider::ADMessageProvider (  MessageType  type, char  channel )

---

Member Function Documentation

char SystemMessageProvider::getChannel (   )  [inline, inherited]

Returns the type of SystemMessageProvider. Returns: MessageType

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

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

int ADMessageProvider::getPayloadLength (   )  [virtual]

Returns the size of the payload in bytes. Returns: int Implements SystemMessageProvider.

MessageType SystemMessageProvider::getType (   )  [inline, inherited]

Returns the type of SystemMessageProvider. Returns: MessageType

---

Member Data Documentation

const char SystemMessageProvider::channel [protected, inherited]

A constant to hold the channel.

const MessageType SystemMessageProvider::type [protected, inherited]

A constant to hold the messagetype.

---

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

• ADMessageProvider.h
• ADMessageProvider.cpp

---