tcEDDImageDataSource Class Reference

EDD Server Class to send image data to an EDD client. More...

#include <EDDImageDataSource.h>

Inheritance diagram for tcEDDImageDataSource:

Collaboration diagram for tcEDDImageDataSource:

List of all members.

Public Types

enum teAxis { eeX, eeY, eeZ }

Public Member Functions

tcEDDImageDataSource (char *apDesc)

virtual ~tcEDDImageDataSource (void)

virtual int HandleMsg (tsEDDMsgHdr *apMsg)

int SetLabel (teAxis aeAxis, char *apLabel)

int SetDescription (char *apDesc)

int SendImageData (uint16_t *apData, uint16_t anRows, uint16_t anCols, uint8_t anType=EDDIMGMSG_MONO_16BIT)

Send an Image.

int SendImageData (uint8_t *apData, uint16_t anRows, uint16_t anCols, uint8_t anType=EDDIMGMSG_MONO_8BIT)

int SendSparseImageData (uint16_t anDefault, uint16_t anRows, uint16_t anCols, uint32_t *apImageOffset, uint16_t *apValue, uint16_t anNumPts, uint8_t anType=EDDIMGMSG_MONO_16BIT)

send an image consisting of sparse data

int SendSparseImageData (uint8_t anDefault, uint16_t anRows, uint16_t anCols, uint32_t *apImageOffset, uint8_t *apValue, uint16_t anNumPts, uint8_t anType=EDDIMGMSG_MONO_8BIT)

Static Public Attributes

static const int gnMaxStringLen = 64

maximum length of labels

Protected Member Functions

void BuildOutputBuffer (void)

void SendImageDescriptor (uint16_t anRows, uint16_t anCols, uint8_t anType, uint8_t anFlags)

int Send3DData (void *apData, uint16_t anRows, uint16_t anCols, int WordSizeBytes, uint8_t anDataType)

int SendSparseData (void *apDefault, uint16_t anRows, uint16_t anCols, uint32_t *apImageOffset, void *apValue, uint16_t anNumPts, int WordSizeBytes, uint8_t anType)

Protected Attributes

int mnImageType

type of image data to transmit

char maDescription [gnMaxStringLen]

image description (name)

char maXLabel [gnMaxStringLen]

image x-axis label

char maYLabel [gnMaxStringLen]

image y-axis label

char maZLabel [gnMaxStringLen]

image z-axis (scale) label

uint16_t mnImageNo

rolling image number

char * mpOutputBuffer

working buffer for sending image messages

int mnOutputBufferLen

size of the working buffer

Detailed Description

EDD Server Class to send image data to an EDD client.

The tcEDDImageDataSource class implements a 3 dimensional (e.g., image) image data transport using the EDD protocol.

Definition at line 17 of file EDDImageDataSource.h.

Member Enumeration Documentation

enum tcEDDImageDataSource::teAxis

This enumeration is used for arguements requiring axis qualification

Enumerator:

eeX
eeY
eeZ

Definition at line 21 of file EDDImageDataSource.h.

Constructor & Destructor Documentation

tcEDDImageDataSource::tcEDDImageDataSource ( char * apDesc )

Definition at line 31 of file EDDImageDataSource.cpp.

tcEDDImageDataSource::~tcEDDImageDataSource ( void ) [virtual]

Definition at line 47 of file EDDImageDataSource.cpp.

Member Function Documentation

void tcEDDImageDataSource::BuildOutputBuffer ( void ) [protected]

Definition at line 80 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::HandleMsg ( tsEDDMsgHdr * apMsg ) [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

Implements tcEDDDataSource.

Definition at line 57 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::Send3DData	(	void *	apData,
		uint16_t	anRows,
		uint16_t	anCols,
		int	WordSizeBytes,
		uint8_t	anDataType
	)			`[protected]`

Definition at line 199 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::SendImageData	(	uint8_t *	apData,
		uint16_t	anRows,
		uint16_t	anCols,
		uint8_t	anType = `EDDIMGMSG_MONO_8BIT`
	)

Definition at line 187 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::SendImageData	(	uint16_t *	apData,
		uint16_t	anRows,
		uint16_t	anCols,
		uint8_t	anType = `EDDIMGMSG_MONO_16BIT`
	)

Send an Image.

This method will send an image to any connected EDD client for display.

Parameters:

	apData	pointer to the data to send
	anRows	number of rows in the image
	anCols	number of columns in the image
	anType	specifies the data type to be sent (see tcEDDImageDataMsg)

Returns:: 0 on success

Definition at line 193 of file EDDImageDataSource.cpp.

void tcEDDImageDataSource::SendImageDescriptor	(	uint16_t	anRows,
		uint16_t	anCols,
		uint8_t	anType,
		uint8_t	anFlags
	)			`[protected]`

Definition at line 96 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::SendSparseData	(	void *	apDefault,
		uint16_t	anRows,
		uint16_t	anCols,
		uint32_t *	apImageOffset,
		void *	apValue,
		uint16_t	anNumPts,
		int	WordSizeBytes,
		uint8_t	anType
	)			`[protected]`

Definition at line 131 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::SendSparseImageData	(	uint8_t	anDefault,
		uint16_t	anRows,
		uint16_t	anCols,
		uint32_t *	apImageOffset,
		uint8_t *	apValue,
		uint16_t	anNumPts,
		uint8_t	anType = `EDDIMGMSG_MONO_8BIT`
	)

Definition at line 123 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::SendSparseImageData	(	uint16_t	anDefault,
		uint16_t	anRows,
		uint16_t	anCols,
		uint32_t *	apImageOffset,
		uint16_t *	apValue,
		uint16_t	anNumPts,
		uint8_t	anType = `EDDIMGMSG_MONO_16BIT`
	)

send an image consisting of sparse data

This method will send an image to any connected EDD client for display. The data will be transmitted using sparse data packing rules.

Parameters:

	anDefault	default value for non-specified pixel locations
	anRows	number of rows in the image
	anCols	number of cols in the image
	apImageOffset	pointer to array of image offset locations
	apValue	pointer to array of sparse data values
	anNumPts	number of sparsely defined data points
	anType	specifies the data type to be sent (see tcEDDImageDataMsg)

Returns:: 0 on success

Definition at line 115 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::SetDescription ( char * apDesc )

Definition at line 267 of file EDDImageDataSource.cpp.

int tcEDDImageDataSource::SetLabel	(	teAxis	aeAxis,
		char *	apLabel
	)

Definition at line 246 of file EDDImageDataSource.cpp.

Member Data Documentation

const int tcEDDImageDataSource::gnMaxStringLen = 64 [static]

maximum length of labels

Definition at line 84 of file EDDImageDataSource.h.

char tcEDDImageDataSource::maDescription[gnMaxStringLen] [protected]

image description (name)

Definition at line 95 of file EDDImageDataSource.h.

char tcEDDImageDataSource::maXLabel[gnMaxStringLen] [protected]

image x-axis label

Definition at line 96 of file EDDImageDataSource.h.

char tcEDDImageDataSource::maYLabel[gnMaxStringLen] [protected]

image y-axis label

Definition at line 97 of file EDDImageDataSource.h.

char tcEDDImageDataSource::maZLabel[gnMaxStringLen] [protected]

image z-axis (scale) label

Definition at line 98 of file EDDImageDataSource.h.

uint16_t tcEDDImageDataSource::mnImageNo [protected]

rolling image number

Definition at line 99 of file EDDImageDataSource.h.

int tcEDDImageDataSource::mnImageType [protected]

type of image data to transmit

Definition at line 94 of file EDDImageDataSource.h.

int tcEDDImageDataSource::mnOutputBufferLen [protected]

size of the working buffer

Definition at line 101 of file EDDImageDataSource.h.

char* tcEDDImageDataSource::mpOutputBuffer [protected]

working buffer for sending image messages

Definition at line 100 of file EDDImageDataSource.h.

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


Public Types
enum	teAxis { eeX, eeY, eeZ }
Public Member Functions
	tcEDDImageDataSource (char *apDesc)
virtual	~tcEDDImageDataSource (void)
virtual int	HandleMsg (tsEDDMsgHdr *apMsg)
int	SetLabel (teAxis aeAxis, char *apLabel)
int	SetDescription (char *apDesc)

int	SendImageData (uint16_t *apData, uint16_t anRows, uint16_t anCols, uint8_t anType=EDDIMGMSG_MONO_16BIT)
	Send an Image.
int	SendImageData (uint8_t *apData, uint16_t anRows, uint16_t anCols, uint8_t anType=EDDIMGMSG_MONO_8BIT)

int	SendSparseImageData (uint16_t anDefault, uint16_t anRows, uint16_t anCols, uint32_t apImageOffset, uint16_t apValue, uint16_t anNumPts, uint8_t anType=EDDIMGMSG_MONO_16BIT)
	send an image consisting of sparse data
int	SendSparseImageData (uint8_t anDefault, uint16_t anRows, uint16_t anCols, uint32_t apImageOffset, uint8_t apValue, uint16_t anNumPts, uint8_t anType=EDDIMGMSG_MONO_8BIT)
Static Public Attributes
static const int	gnMaxStringLen = 64
	maximum length of labels
Protected Member Functions
void	BuildOutputBuffer (void)
void	SendImageDescriptor (uint16_t anRows, uint16_t anCols, uint8_t anType, uint8_t anFlags)
int	Send3DData (void *apData, uint16_t anRows, uint16_t anCols, int WordSizeBytes, uint8_t anDataType)
int	SendSparseData (void apDefault, uint16_t anRows, uint16_t anCols, uint32_t apImageOffset, void *apValue, uint16_t anNumPts, int WordSizeBytes, uint8_t anType)
Protected Attributes
int	mnImageType
	type of image data to transmit
char	maDescription [gnMaxStringLen]
	image description (name)
char	maXLabel [gnMaxStringLen]
	image x-axis label
char	maYLabel [gnMaxStringLen]
	image y-axis label
char	maZLabel [gnMaxStringLen]
	image z-axis (scale) label
uint16_t	mnImageNo
	rolling image number
char *	mpOutputBuffer
	working buffer for sending image messages
int	mnOutputBufferLen
	size of the working buffer