tcEDDDataSource Class Reference

Abstraction class for EDD Data Source. More...

#include <EDDDataSource.h>

Inheritance diagram for tcEDDDataSource:

[legend]

List of all members.

Public Member Functions
	tcEDDDataSource (void)
virtual	~tcEDDDataSource (void)
void	RegisterWithMsgLoop (void)
void	UnRegisterWithMsgLoop (void)
void	SendSourceDescMsg (char **apFields, char **apItems, int NumItems)
void	BuildHeader (tsEDDMsgHdr *apMsgHdr, uint16_t MsgID, uint16_t len)
bool	IsSubscribed (void)
virtual int	HandleMsg (tsEDDMsgHdr *apMsg)=0
Public Attributes
uint32_t	mnBytesSent
	number of bytes transmitted
Protected Attributes
int	mnSourceId
	EDD Data Source Source ID.

---

Detailed Description

Abstraction class for EDD Data Source.

Abstraction class for Embedded Data Display (EDD) Data Source. All EDD Data Sources (e.g., tcEDDPlotDataSource, tcEDDImagaDataSource) must derive from this class. This class is responsible for interfacing with the underlying EDD Message Loop (tcEDDMsgLoop) class, including registering and unregistering with the server loop.

Definition at line 24 of file EDDDataSource.h.

---

Constructor & Destructor Documentation

tcEDDDataSource::tcEDDDataSource

(

void

)

Definition at line 15 of file EDDDataSource.cpp.

tcEDDDataSource::~tcEDDDataSource

(

void

)

[virtual]

Definition at line 21 of file EDDDataSource.cpp.

---

Member Function Documentation

void tcEDDDataSource::BuildHeader	(	tsEDDMsgHdr *	apMsgHdr,
		uint16_t	MsgID,
		uint16_t	len
	)

Definition at line 80 of file EDDDataSource.cpp.

virtual int tcEDDDataSource::HandleMsg

(

tsEDDMsgHdr *

apMsg

)

[pure virtual]

Handle a directed message from an EDD client, typically a data information/description request.

Returns:

EDDMSG_UNHANDLED if the message is unhandled EDDMSG_ERROR if there was an error in processing' EDDMSG_OK if the messae was processed successfully

Implemented in tcEDDImageDataSource, and tcEDDPlotDataSource.

bool tcEDDDataSource::IsSubscribed

(

void

)

Definition at line 74 of file EDDDataSource.cpp.

void tcEDDDataSource::RegisterWithMsgLoop

(

void

)

Definition at line 26 of file EDDDataSource.cpp.

void tcEDDDataSource::SendSourceDescMsg	(	char **	apFields,
		char **	apItems,
		int	NumItems
	)

Definition at line 41 of file EDDDataSource.cpp.

void tcEDDDataSource::UnRegisterWithMsgLoop

(

void

)

Definition at line 32 of file EDDDataSource.cpp.

---

Member Data Documentation

uint32_t tcEDDDataSource::mnBytesSent

number of bytes transmitted

Definition at line 49 of file EDDDataSource.h.

int tcEDDDataSource::mnSourceId [protected]

EDD Data Source Source ID.

Definition at line 52 of file EDDDataSource.h.

---

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

• EDDDataSource.h
• EDDDataSource.cpp