VRUT::PacketParser Class Reference

PacketParser class extends textParser to be ready for parsing DTrack -ASCII format UDP packet. More...

#include <pparser.h>

List of all members.

Public Member Functions
	PacketParser (const char *input=NULL)
	Constructor.
	~PacketParser ()
	destructor
bool	Parse ()
	main parsing method
void	SetPacket (char *packet)
	sets new packet to parse
int	FrameCounter ()
	returns Frame Counter value of a last parsed packet
float	TimeStamp ()
	returns Timestamp value of a last parsed packet
int	CalibratedDevices ()
	returns number of calibrated devices
int	ParsedDevices ()
	returns number of devices that were found during last succesful parsing
void	SetQueue (bodyqueue *queue)
	Sets the pointer to queue where tu put parsed devices.
	PacketParser (const char *input=NULL)
	Constructor.
	~PacketParser ()
	destructor
bool	Parse ()
	main parsing method
void	SetPacket (char *packet)
	sets new packet to parse
int	FrameCounter ()
	returns Frame Counter value of a last parsed packet
float	TimeStamp ()
	returns Timestamp value of a last parsed packet
int	CalibratedDevices ()
	returns number of calibrated devices
int	ParsedDevices ()
	returns number of devices that were found during last succesful parsing
void	SetQueue (bodyqueue *queue)
	Sets the pointer to queue where tu put parsed devices.
Private Member Functions
bool	parse6D ()
	parse 6DOF devices. Returns true if all devices succesful.
bool	parse6DF ()
	parse Flystick devices. Returns true if all devices of type succesful.
bool	parse6DF2 ()
	parse Flystick2 devices. Returns true if all devices of type succesful.
bool	parse6DMT ()
	parse Measurement tools. Returns true if all devices of type succesful.
bool	parseGL ()
	parse Fingertracking hands. Returns true if all devices of type succesful.
bool	parse3D ()
	parse 3DOF devices. Returns true if all devices of type succesful.
bool	parseFinger (Finger *finger)
	parse finger - a part of the glove and put data into structure Finger
bool	parseInt (int *target)
	parse Integer and skip separators
bool	parseFloat (float *target)
	parse Float and skip separators
size_t	parseVector (float *target, size_t dimension)
	parse vector and skip separators
bool	parse6D ()
	parse 6DOF devices. Returns true if all devices succesful.
bool	parse6DF ()
	parse Flystick devices. Returns true if all devices of type succesful.
bool	parse6DF2 ()
	parse Flystick2 devices. Returns true if all devices of type succesful.
bool	parse6DMT ()
	parse Measurement tools. Returns true if all devices of type succesful.
bool	parseGL ()
	parse Fingertracking hands. Returns true if all devices of type succesful.
bool	parse3D ()
	parse 3DOF devices. Returns true if all devices of type succesful.
bool	parseFinger (Finger *finger)
	parse finger - a part of the glove and put data into structure Finger
bool	parseInt (int *target)
	parse Integer and skip separators
bool	parseFloat (float *target)
	parse Float and skip separators
size_t	parseVector (float *target, size_t dimension)
	parse vector and skip separators
Private Attributes
bodyqueue *	bQueue
	extern queue where to put parsed devices
TextParser *	textparser
	textparser enables to easily go through the packet data
int	frameCounter
	a Frame counter information of last parsed packet (information from packet)
int	calibDevs
	number of calibrated devices (information from packet data)
int	devicesCount
	number of devices found in last packet
float	timeStamp
	a timestamp of the packet (information from packet data)a
bodyqueue *	bQueue
	extern queue where to put parsed devices
TextParser *	textparser
	textparser enables to easily go through the packet data
Static Private Attributes
static const char	separators []
	enumeration of separators used in DTrack packet
static const char *	tags []
	enumeratiion of tags used in Dtrack packet
static const char *	tags []
	enumeratiion of tags used in Dtrack packet

---

Detailed Description

PacketParser class extends textParser to be ready for parsing DTrack -ASCII format UDP packet.

Definition at line 15 of file pparser.h.

---

Constructor & Destructor Documentation

PacketParser::PacketParser

(

const char *

input = NULL

)

Constructor.

Parameters:

input

-packet

Definition at line 23 of file pparser.cpp.

{
       bQueue = NULL;
       frameCounter = 0;
       timeStamp = -1.0;
       textparser = NULL;
}

PacketParser::~PacketParser

(

)

destructor

Definition at line 30 of file pparser.cpp.

{
       if (textparser != NULL)
       {
              delete textparser;
       }
}

VRUT::PacketParser::PacketParser

(

const char *

input = NULL

)

Constructor.

Parameters:

input

-packet

VRUT::PacketParser::~PacketParser

(

)

destructor

---

Member Function Documentation

bool PacketParser::parse6D

(

)

[private]

parse 6DOF devices. Returns true if all devices succesful.

Definition at line 207 of file pparser.cpp.

{
       int devs; // number of devices of type 3D
       if(!parseInt(&devs)) return false;
       devicesCount += devs;
       for (int i = 0 ; i < devs; i++)
       {
              int id;
              float qu;
              float s[6];
              float b[9];
              if (!parseInt(&id))        return false;
              if (!parseFloat(&qu))      return false;
              if (6 != parseVector(s,6)) return false;
              if (9 != parseVector(b,9)) return false;
              Body * b6d = new Body(id,qu,Body::B6D,s,b);
              bQueue->push(b6d);
       }
       return true;
}

bool PacketParser::parse6DF

(

)

[private]

parse Flystick devices. Returns true if all devices of type succesful.

Definition at line 227 of file pparser.cpp.

{
       int devs; // number of devices of type 3D
       if(!parseInt(&devs)) return false;
       devicesCount += devs;
       for (int i = 0 ; i < devs; i++)
       {
              int id;
              float qu;
              int bt;
              float s[6];
              float b[9]; // pouzt datovou strukturu
              if (!parseInt(&id))        return false;
              if (!parseFloat(&qu))      return false;
              if (!parseInt(&bt))        return false;
              if (6 != parseVector(s,6)) return false;
              if (9 != parseVector(b,9)) return false;
              FlyStick1 * fs1;
              if (qu != -1) fs1 = new FlyStick1(id, qu, bt, s, b);
              else fs1 = new FlyStick1(id,qu, bt);
              bQueue->push(fs1);
       }
       return true;
}

bool PacketParser::parse6DF2

(

)

[private]

parse Flystick2 devices. Returns true if all devices of type succesful.

Definition at line 251 of file pparser.cpp.

{
       int dev_s; // number of devices of type Flystick2 registered
       int devs; // number of followed on the line
       if(!parseInt(&dev_s)) return false;
       if(!parseInt(&devs))  return false;
       devicesCount += devs;
       for (int i = 0 ; i < devs; i++)
       {
              int id;
              float qu;
              int nbt;
              int nct;
              float s[3];
              float b[9]; // pouzit datovou strukturu
              if (!parseInt(&id))        return false;
              if (!parseFloat(&qu))      return false;
              if (!parseInt(&nbt))       return false;
              if (!parseInt(&nct))       return false;
              if (3 != parseVector(s,3)) return false;
              if (9 != parseVector(b,9)) return false;
              FlyStick2 * fs2 = NULL;
              if (qu != -1) fs2 = new FlyStick2(id, qu, nbt, nct, s, b);
              else FlyStick2(id, qu, nbt, nct);
              int intNum = nbt /32;
              if ((nbt%32) != 0) intNum += 1;
              int butt;
              float control;
              for (int j = 0; j < intNum; j++)
              {
                     if (!parseInt(&butt))
                     {
                            delete fs2;
                            return false;
                     }
                     else
                     {
                            fs2->addButtons(j, butt);
                     }
              }
              for (int j = 0; j < nct; j++)
              {
                     if(!parseFloat(&control))
                     {
                            delete fs2;
                            return false;
                     }
                     else
                     {
                            fs2->addControls(j,control);
                     }
              }
              bQueue->push(fs2);
       }
       return true;
}

bool PacketParser::parse6DMT

(

)

[private]

parse Measurement tools. Returns true if all devices of type succesful.

Definition at line 307 of file pparser.cpp.

{
       int devs; // number of devices of type 3D
       if(!parseInt(&devs)) return false;
       devicesCount += devs;
       for (int i = 0 ; i < devs; i++)
       {
              int id;
              float qu;
              int bt;
              float s[3];
              float b[9];
              if (!parseInt(&id))        return false;
              if (!parseFloat(&qu))      return false;
              if (!parseInt(&bt))        return false;
              if (3 != parseVector(s,3)) return false;
              if (9 != parseVector(b,9)) return false;
              Measurer * dmt;
              if (qu != -1)dmt = new Measurer(id, qu, bt, s, b);
              else dmt = new Measurer(id, qu, bt);
              bQueue->push(dmt);
       }
       return true;
}

bool PacketParser::parseGL

(

)

[private]

parse Fingertracking hands. Returns true if all devices of type succesful.

Definition at line 331 of file pparser.cpp.

{
       int devs; // number of devices of type 3D
       if(!textparser->ParseInt(&devs, separators)) return false;
       devicesCount += devs;
       for (int i = 0 ; i < devs; i++)
       {
              int id;
              float qu;
              int hand; // left or right
              int nf;   // number of fingers
              float s[3]; // misto techto 3 pouzit uz datove struktury
              float b[9];
              if (!parseInt(&id))        return false;
              if (!parseFloat(&qu))      return false;
              if (!parseInt(&hand))      return false;
              if (!parseInt(&nf))        return false;
              if (3 != parseVector(s,3)) return false;
              if (9 != parseVector(b,9)) return false;
              bool leftH;
              if (nf == 0) leftH = true; else leftH = false;
              BodyGlove * gl = new BodyGlove(id,qu, nf,leftH,s,b);
              Finger fgrs;
              for (int j = 0 ; j < nf; j++)
              {
                     if(!parseFinger(&fgrs))
                     {
                            delete gl;
                            return false;
                     }
                     else gl->addFinger(j, fgrs);
              }
              bQueue->push(gl);
       }
       return true;
}

bool PacketParser::parse3D

(

)

[private]

parse 3DOF devices. Returns true if all devices of type succesful.

Definition at line 189 of file pparser.cpp.

{
       int devs; // number of devices of type 3D
       if(!parseInt(&devs)) return false;
       devicesCount += devs;
       for (int i = 0 ; i < devs; i++)
       {
              int id;
              float qu;
              float s[3];
              if (!parseInt(&id))        return false;
              if (!parseFloat(&qu))      return false;
              if (3 != parseVector(s,3)) return false;
              Body * b3d = new Body(id,qu,Body::B3D,s);
              bQueue->push(b3d);
       }
       return true;
}

bool PacketParser::parseFinger

(

Finger *

finger

)

[private]

parse finger - a part of the glove and put data into structure Finger

Parameters:

finger

a pointer to data structure where to store a information about finger returns true if succesful

Definition at line 367 of file pparser.cpp.

{
       if (3 != parseVector(finger->Position, 3)) return false;
       if (9 != parseVector(finger->Matrix, 9))   return false;
       if (!parseFloat(&finger->Radius))          return false;
       if (!parseFloat(&(finger->Length[0])))     return false;
       if (!parseFloat(&(finger->Angle[0])))      return false;
       if (!parseFloat(&(finger->Length[1])))     return false;
       if (!parseFloat(&(finger->Angle[1])))      return false;
       if (!parseFloat(&(finger->Length[2])))     return false;
       return true;
}

bool PacketParser::parseInt

(

int *

target

)

[inline, private]

parse Integer and skip separators

Parameters:

target

a pointer to an integer where to put a value returns true if succesful

Definition at line 171 of file pparser.cpp.

{
       if (!textparser->ParseInt(target, separators)) return false;
       textparser->SkipCharsAndComments(separators);
       return true;
}

bool PacketParser::parseFloat

(

float *

target

)

[inline, private]

parse Float and skip separators

Parameters:

target

a pointer to a float where to put a value returns true if succesful

Definition at line 177 of file pparser.cpp.

{
       if (!textparser->ParseFloat(target, separators)) return false;
       textparser->SkipCharsAndComments(separators);
       return true;
}

size_t PacketParser::parseVector	(	float *	target,
		size_t	dimension
	)			[inline, private]

parse vector and skip separators

Parameters:

	target	a pointer to a float where to put a value
	dimension	- the nuber of floats to be read (length of target array) returns the number of vector values read

Definition at line 183 of file pparser.cpp.

{
       size_t read = textparser->ParseVector(target, dimension, true, separators);
       textparser->SkipCharsAndComments(separators);
       return read;
}

bool PacketParser::Parse

(

)

main parsing method

returns true if parsing succesful (input data matching packet format)

Definition at line 58 of file pparser.cpp.

{
       if (NULL == bQueue)
       {
              LOGERROR(wxT("<Tracking> No Queue is set, where to save devices. Parsing unsuccesful!"));
              return false;
       }
       calibDevs = 0;
       devicesCount = 0;
       while(!textparser->IsEmpty())
       {
              switch (textparser->KeywordsSwitch(tags, separators))
              {
              case 0: // fr
                     {
                            int fCounter;
                            if (!textparser->ParseInt(&fCounter, separators))
                            {
                                   LOGERROR(wxT("<Tracking>Unexpected chunks while parsing fr"));
                                   //frameCounter = 0;
                                   return false;
                            }
                            if (fCounter <= frameCounter) LOGWARNING(wxT("<Tracking>Packet order varied"));
                            frameCounter = fCounter;
                            break;
                     }
              case 1: // ts
                     {
                            if(!textparser->ParseFloat(&timeStamp,separators))
                            {
                                   LOGERROR(wxT("<Tracking>Unexpected chunks while parsing ts"));
                                   //timeStamp = 0;
                                   return false;
                            }
                            break;
                     }
              case 2: // 6d
                     {
                            if (!parse6D())
                            {
                                   LOGERROR(wxT("<tracking>Unexpected chunks while parsing 6d"));
                                   return false;
                            }
                            break;
                     }
              case 3: // 6df
                     {
                            if (!parse6DF())
                            {
                                   LOGERROR(wxT("<tracking>Unexpected chunks while parsing 6df"));
                                   return false;
                            }
                            break;
                     }
              case 4: // 6df2
                     {
                            if (!parse6DF2())
                            {
                                   LOGERROR(wxT("<tracking>Unexpected chunks while parsing 6df2"));
                                   return false;
                            }
                            break;
                     }
              case 5: // 6dmt
                     {
                            if (!parse6DMT())
                            {
                                   LOGERROR(wxT("<tracking>Unexpected chunks while parsing 6dmt"));
                                   return false;
                            }
                            break;
                     }
              case 6: // gl
                     {
                            if (!parseGL())
                            {
                                   LOGERROR(wxT("<tracking>Unexpected chunks while parsing gl"));
                                   return false;
                            }
                            break;
                     }
              case 7: // 3d
                     {
                            if (!parse3D())
                            {
                                   LOGERROR(wxT("<tracking>Unexpected chunks while parsing 3d"));
                                   return false;
                            }
                            break;
                     }
              case 8: // 6dcal
                     {
                            if(!textparser->ParseInt(&calibDevs,separators))
                            {
                                   LOGERROR(wxT("<Tracking>Unexpected chunks while parsing 6dcal"));
                                   return false;
                            }
                            break;
                     }
              default: // bad hit
                     {
                            wxString aaa = wxT("<Tracking> Unexpected token while parsing tag: ") + textparser->GetWxLine();
                            LOGERROR(aaa);
                            // resit co kdyz bylo nacteno nejake zarizeni, ale pak nastala chyba...
                            // >>> otazka, jestli transformovat behem parsovani, nebo ukladat do fronty a pak postupne obsluhovat frontu
                            return false;
                            break;
                     }
              }
       }
       return true; // ujisti se, jestli byl fr parsovany
}

void PacketParser::SetPacket

(

char *

packet

)

sets new packet to parse

Definition at line 37 of file pparser.cpp.

{
       if (textparser != NULL) delete textparser;
       textparser = new TextParser(packet);
}

int PacketParser::FrameCounter

(

)

returns Frame Counter value of a last parsed packet

Definition at line 46 of file pparser.cpp.

{
       return frameCounter;
}

float PacketParser::TimeStamp

(

)

returns Timestamp value of a last parsed packet

Note that this information is only available when it is included in packet data. Dummy value is returned if it is not included.

Definition at line 42 of file pparser.cpp.

{
       return timeStamp;
}

int PacketParser::CalibratedDevices

(

)

returns number of calibrated devices

Note, this is a number that is carried with UDP packet, so be sure that this information is included before using this! If it is not 0 is returned!

Definition at line 50 of file pparser.cpp.

{
       return calibDevs;
}

int PacketParser::ParsedDevices

(

)

returns number of devices that were found during last succesful parsing

Note that if last parsing was unsuccesful, dummy value is returned!

Definition at line 54 of file pparser.cpp.

{
       return devicesCount;
}

void PacketParser::SetQueue

(

VRUT::bodyqueue *

queue

)

Sets the pointer to queue where tu put parsed devices.

Definition at line 380 of file pparser.cpp.

{
       this->bQueue = queue;
}

bool VRUT::PacketParser::parse6D

(

)

[private]

parse 6DOF devices. Returns true if all devices succesful.

bool VRUT::PacketParser::parse6DF

(

)

[private]

parse Flystick devices. Returns true if all devices of type succesful.

bool VRUT::PacketParser::parse6DF2

(

)

[private]

parse Flystick2 devices. Returns true if all devices of type succesful.

bool VRUT::PacketParser::parse6DMT

(

)

[private]

parse Measurement tools. Returns true if all devices of type succesful.

bool VRUT::PacketParser::parseGL

(

)

[private]

parse Fingertracking hands. Returns true if all devices of type succesful.

bool VRUT::PacketParser::parse3D

(

)

[private]

parse 3DOF devices. Returns true if all devices of type succesful.

bool VRUT::PacketParser::parseFinger

(

Finger *

finger

)

[private]

parse finger - a part of the glove and put data into structure Finger

Parameters:

finger

a pointer to data structure where to store a information about finger returns true if succesful

bool VRUT::PacketParser::parseInt

(

int *

target

)

[inline, private]

parse Integer and skip separators

Parameters:

target

a pointer to an integer where to put a value returns true if succesful

bool VRUT::PacketParser::parseFloat

(

float *

target

)

[inline, private]

parse Float and skip separators

Parameters:

target

a pointer to a float where to put a value returns true if succesful

size_t VRUT::PacketParser::parseVector	(	float *	target,
		size_t	dimension
	)			[inline, private]

parse vector and skip separators

Parameters:

	target	a pointer to a float where to put a value
	dimension	- the nuber of floats to be read (length of target array) returns the number of vector values read

bool VRUT::PacketParser::Parse

(

)

main parsing method

returns true if parsing succesful (input data matching packet format)

void VRUT::PacketParser::SetPacket

(

char *

packet

)

sets new packet to parse

int VRUT::PacketParser::FrameCounter

(

)

returns Frame Counter value of a last parsed packet

float VRUT::PacketParser::TimeStamp

(

)

returns Timestamp value of a last parsed packet

Note that this information is only available when it is included in packet data. Dummy value is returned if it is not included.

int VRUT::PacketParser::CalibratedDevices

(

)

returns number of calibrated devices

Note, this is a number that is carried with UDP packet, so be sure that this information is included before using this! If it is not 0 is returned!

int VRUT::PacketParser::ParsedDevices

(

)

returns number of devices that were found during last succesful parsing

Note that if last parsing was unsuccesful, dummy value is returned!

void VRUT::PacketParser::SetQueue

(

bodyqueue *

queue

)

Sets the pointer to queue where tu put parsed devices.

---

Member Data Documentation

bodyqueue* VRUT::PacketParser::bQueue [private]

extern queue where to put parsed devices

Definition at line 19 of file pparser.h.

static const char VRUT::PacketParser::separators [static, private]

Initial value:

{
       '[', 
       ']', 
       ' '  
}

enumeration of separators used in DTrack packet

Definition at line 22 of file pparser.h.

const char * PacketParser::tags [static, private]

Initial value:

{
       "fr",   
       "ts",   
       "6d",   
       "6df",  
       "6df2", 
       "6dmt", 
       "gl",   
       "3d",   
       "6dcal",
       "" 
}

enumeratiion of tags used in Dtrack packet

Definition at line 24 of file pparser.h.

TextParser* VRUT::PacketParser::textparser [private]

textparser enables to easily go through the packet data

Definition at line 26 of file pparser.h.

int VRUT::PacketParser::frameCounter [private]

a Frame counter information of last parsed packet (information from packet)

Definition at line 28 of file pparser.h.

int VRUT::PacketParser::calibDevs [private]

number of calibrated devices (information from packet data)

Definition at line 30 of file pparser.h.

int VRUT::PacketParser::devicesCount [private]

number of devices found in last packet

Definition at line 32 of file pparser.h.

float VRUT::PacketParser::timeStamp [private]

a timestamp of the packet (information from packet data)a

Definition at line 34 of file pparser.h.

bodyqueue* VRUT::PacketParser::bQueue [private]

extern queue where to put parsed devices

Definition at line 19 of file pparser.h.

const char* VRUT::PacketParser::tags[] [static, private]

enumeratiion of tags used in Dtrack packet

Definition at line 24 of file pparser.h.

TextParser* VRUT::PacketParser::textparser [private]

textparser enables to easily go through the packet data

Definition at line 26 of file pparser.h.

---

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

• /cygdrive/d/src/svn/vrut/trunk/modules/tracking/backup/pparser.h
• /cygdrive/d/src/svn/vrut/trunk/modules/tracking/pparser.h
• /cygdrive/d/src/svn/vrut/trunk/modules/tracking/backup/pparser.cpp
• /cygdrive/d/src/svn/vrut/trunk/modules/tracking/pparser.cpp