tcEDDPlotDataSource Class Reference

EDD Server Class to send 2 dimensional plot data. More...

#include <EDDPlotDataSource.h>

Inheritance diagram for tcEDDPlotDataSource:

Collaboration diagram for tcEDDPlotDataSource:

List of all members.

Public Types

enum teAxis { eeX = 0, eeY = 1, eeZ = 2 }

Public Member Functions

tcEDDPlotDataSource (char *apDesc, bool abIsContinuous=false, int anMaxContPoints=1024)

virtual ~tcEDDPlotDataSource (void)

virtual int HandleMsg (tsEDDMsgHdr *apMsg)

int SetLabel (teAxis, char *apLabel)

int SetDescription (char *apDesc)

int SetOffset (teAxis aeAxis, float anOffset)

int SetScale (teAxis aeAxis, float anScale)

int SendPlotData (float *X, float *Y, int N)

int SendPlotData (int32_t *X, int32_t *Y, int N)

int SendPlotData (int16_t *X, int16_t *Y, int N)

int SendPlotData (int8_t *X, int8_t *Y, int N)

int SendPlotData (uint32_t *X, uint32_t *Y, int N)

int SendPlotData (uint16_t *X, uint16_t *Y, int N)

int SendPlotData (uint8_t *X, uint8_t *Y, int N)

int SendPlotData (float *Y, int N)

int SendPlotData (uint32_t *Y, int N)

int SendPlotData (uint16_t *Y, int N)

int SendPlotData (uint8_t *Y, int N)

int SendPlotData (int32_t *Y, int N)

int SendPlotData (int16_t *Y, int N)

int SendPlotData (int8_t *Y, int N)

Static Public Attributes

static const int gnMaxStringLen = 64

Protected Member Functions

int Send2DData (void *Xdata, void *Ydata, int N, int WordSizeBytes, uint8_t anDataType)

int Send1DData (void *Ydata, int N, int WordSizeBytes, uint8_t anDataType)

void SendPlotDescriptor (int32_t anNumPoints, uint8_t anType)

void BuildOutputBuffer (void)

Protected Attributes

int mnPlotType

defines the type of plot that will be generated

char maDescription [gnMaxStringLen]

plot description (plot name)

char maXLabel [gnMaxStringLen]

x-label for plot

char maYLabel [gnMaxStringLen]

y-label for plot

char maZLabel [gnMaxStringLen]

z-label for plot

float maScale [3]

scale factor for plot data (x,y,z indices)

float maOffset [3]

offsets for plot data (x,y,z indices)

uint16_t mnPlotNo

rolling plot number for plot output cycles

char * mpOutputBuffer

working buffer for plot messages

int mnOutputBufferLen

size of the working buffer

int mnMaxContPoints

maximum number of continuous points for rolling plots

bool mbIsContinuous

when true, plots are continuous outputs

Detailed Description

EDD Server Class to send 2 dimensional plot data.

Implementation class for sending 2 dimensional plot data to an Embedded Data Display Client.

Definition at line 18 of file EDDPlotDataSource.h.

Member Enumeration Documentation

enum tcEDDPlotDataSource::teAxis

This enumeration is used for arguements requiring axis qualification

Enumerator:

eeX
eeY
eeZ

Definition at line 22 of file EDDPlotDataSource.h.

Constructor & Destructor Documentation

tcEDDPlotDataSource::tcEDDPlotDataSource	(	char *	apDesc,
		bool	abIsContinuous = `false`,
		int	anMaxContPoints = `1024`
	)

Constructor

Parameters:

	apDesc	default description for plot source.
	abIsContinuous	when true data intended to form a rolling plot (default false)
	anMaxContPoints	may be used to provide a hint to the client as to max numnber of points to save / display (default 0 - client choice)

Definition at line 45 of file EDDPlotDataSource.cpp.

tcEDDPlotDataSource::~tcEDDPlotDataSource ( void ) [virtual]

Desctructor

Definition at line 72 of file EDDPlotDataSource.cpp.

Member Function Documentation

void tcEDDPlotDataSource::BuildOutputBuffer ( void ) [protected]

Definition at line 432 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::HandleMsg ( tsEDDMsgHdr * apMsg ) [virtual]

Implementation of message handler for all Data Source objects.

Parameters:

apMsg

valid input message to process

Returns:: EDDMSG_OK if message is handled, EDDMSG_UNHANDLED if not

Implements tcEDDDataSource.

Definition at line 89 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::Send1DData	(	void *	Ydata,
		int	N,
		int	WordSizeBytes,
		uint8_t	anDataType
	)			`[protected]`

Definition at line 318 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::Send2DData	(	void *	Xdata,
		void *	Ydata,
		int	N,
		int	WordSizeBytes,
		uint8_t	anDataType
	)			`[protected]`

Definition at line 262 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	int8_t *	Y,
		int	N
	)

Definition at line 251 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	int16_t *	Y,
		int	N
	)

Definition at line 240 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	int32_t *	Y,
		int	N
	)

Definition at line 229 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	uint8_t *	Y,
		int	N
	)

Definition at line 218 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	uint16_t *	Y,
		int	N
	)

Definition at line 207 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	uint32_t *	Y,
		int	N
	)

Definition at line 196 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	float *	Y,
		int	N
	)

Send Y data (with assuming linearly changing X data and/or Z data).

Parameters:

`[in]`	Y	pointer to Y data to send
`[in]`	N	number of points to send

Definition at line 185 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	uint8_t *	X,
		uint8_t *	Y,
		int	N
	)

Definition at line 175 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	uint16_t *	X,
		uint16_t *	Y,
		int	N
	)

Definition at line 165 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	uint32_t *	X,
		uint32_t *	Y,
		int	N
	)

Definition at line 155 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	int8_t *	X,
		int8_t *	Y,
		int	N
	)

Definition at line 145 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	int16_t *	X,
		int16_t *	Y,
		int	N
	)

Definition at line 135 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	int32_t *	X,
		int32_t *	Y,
		int	N
	)

Definition at line 125 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SendPlotData	(	float *	X,
		float *	Y,
		int	N
	)

Send a full (contained) set of plot data to any subscribers.

Parameters:

	X	pointer to array of X axis data
	Y	pointer to array of Y axis data
	N	number of axis points

Returns:: 0 on success

Definition at line 115 of file EDDPlotDataSource.cpp.

void tcEDDPlotDataSource::SendPlotDescriptor	(	int32_t	anNumPoints,
		uint8_t	anType
	)			`[protected]`

Definition at line 413 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SetDescription ( char * apDesc )

Sets Description of Plot Data Source

Parameters:

apDesc

new Description text (must be less than gnMaxStringLen bytes)

Returns:: 0 on success.

Definition at line 406 of file EDDPlotDataSource.cpp.

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

Sets effective label for an axis according to the input text.

Parameters:

	aeAxis	label of axis to change
	apLabel	new label text (must be less than gnMaxStringLen bytes)

Returns:: 0 on success.

Definition at line 378 of file EDDPlotDataSource.cpp.

int tcEDDPlotDataSource::SetOffset	(	teAxis	aeAxis,
		float	anOffset
	)			`[inline]`

Definition at line 75 of file EDDPlotDataSource.h.

int tcEDDPlotDataSource::SetScale	(	teAxis	aeAxis,
		float	anScale
	)			`[inline]`

Definition at line 76 of file EDDPlotDataSource.h.

Member Data Documentation

const int tcEDDPlotDataSource::gnMaxStringLen = 64 [static]

Definition at line 78 of file EDDPlotDataSource.h.

char tcEDDPlotDataSource::maDescription[gnMaxStringLen] [protected]

plot description (plot name)

Definition at line 88 of file EDDPlotDataSource.h.

float tcEDDPlotDataSource::maOffset[3] [protected]

offsets for plot data (x,y,z indices)

Definition at line 93 of file EDDPlotDataSource.h.

float tcEDDPlotDataSource::maScale[3] [protected]

scale factor for plot data (x,y,z indices)

Definition at line 92 of file EDDPlotDataSource.h.

char tcEDDPlotDataSource::maXLabel[gnMaxStringLen] [protected]

x-label for plot

Definition at line 89 of file EDDPlotDataSource.h.

char tcEDDPlotDataSource::maYLabel[gnMaxStringLen] [protected]

y-label for plot

Definition at line 90 of file EDDPlotDataSource.h.

char tcEDDPlotDataSource::maZLabel[gnMaxStringLen] [protected]

z-label for plot

Definition at line 91 of file EDDPlotDataSource.h.

bool tcEDDPlotDataSource::mbIsContinuous [protected]

when true, plots are continuous outputs

Definition at line 98 of file EDDPlotDataSource.h.

int tcEDDPlotDataSource::mnMaxContPoints [protected]

maximum number of continuous points for rolling plots

Definition at line 97 of file EDDPlotDataSource.h.

int tcEDDPlotDataSource::mnOutputBufferLen [protected]

size of the working buffer

Definition at line 96 of file EDDPlotDataSource.h.

uint16_t tcEDDPlotDataSource::mnPlotNo [protected]

rolling plot number for plot output cycles

Definition at line 94 of file EDDPlotDataSource.h.

int tcEDDPlotDataSource::mnPlotType [protected]

defines the type of plot that will be generated

Definition at line 87 of file EDDPlotDataSource.h.

char* tcEDDPlotDataSource::mpOutputBuffer [protected]

working buffer for plot messages

Definition at line 95 of file EDDPlotDataSource.h.

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


Public Types
enum	teAxis { eeX = 0, eeY = 1, eeZ = 2 }
Public Member Functions
	tcEDDPlotDataSource (char *apDesc, bool abIsContinuous=false, int anMaxContPoints=1024)
virtual	~tcEDDPlotDataSource (void)
virtual int	HandleMsg (tsEDDMsgHdr *apMsg)
int	SetLabel (teAxis, char *apLabel)
int	SetDescription (char *apDesc)
int	SetOffset (teAxis aeAxis, float anOffset)
int	SetScale (teAxis aeAxis, float anScale)

int	SendPlotData (float X, float Y, int N)
int	SendPlotData (int32_t X, int32_t Y, int N)
int	SendPlotData (int16_t X, int16_t Y, int N)
int	SendPlotData (int8_t X, int8_t Y, int N)
int	SendPlotData (uint32_t X, uint32_t Y, int N)
int	SendPlotData (uint16_t X, uint16_t Y, int N)
int	SendPlotData (uint8_t X, uint8_t Y, int N)

int	SendPlotData (float *Y, int N)
int	SendPlotData (uint32_t *Y, int N)
int	SendPlotData (uint16_t *Y, int N)
int	SendPlotData (uint8_t *Y, int N)
int	SendPlotData (int32_t *Y, int N)
int	SendPlotData (int16_t *Y, int N)
int	SendPlotData (int8_t *Y, int N)
Static Public Attributes
static const int	gnMaxStringLen = 64
Protected Member Functions
int	Send2DData (void Xdata, void Ydata, int N, int WordSizeBytes, uint8_t anDataType)
int	Send1DData (void *Ydata, int N, int WordSizeBytes, uint8_t anDataType)
void	SendPlotDescriptor (int32_t anNumPoints, uint8_t anType)
void	BuildOutputBuffer (void)
Protected Attributes
int	mnPlotType
	defines the type of plot that will be generated
char	maDescription [gnMaxStringLen]
	plot description (plot name)
char	maXLabel [gnMaxStringLen]
	x-label for plot
char	maYLabel [gnMaxStringLen]
	y-label for plot
char	maZLabel [gnMaxStringLen]
	z-label for plot
float	maScale [3]
	scale factor for plot data (x,y,z indices)
float	maOffset [3]
	offsets for plot data (x,y,z indices)
uint16_t	mnPlotNo
	rolling plot number for plot output cycles
char *	mpOutputBuffer
	working buffer for plot messages
int	mnOutputBufferLen
	size of the working buffer
int	mnMaxContPoints
	maximum number of continuous points for rolling plots
bool	mbIsContinuous
	when true, plots are continuous outputs