/users/dtb26/GITROOT/VetSim-Core/src/vetserial/vetprot.h File Reference

This file implements a command structure in support of the vet serial specification. More...

#include "excepts.h"
#include <string.h>
#include <sstream>

Go to the source code of this file.

Namespaces
namespace	cornelluniversity
namespace	vetserial
namespace	cornelluniversity::vetserial
Classes
class	cornelluniversity::vetserial::base_command
	A pure virtual abstraction which serves as the basis of the vet serial protocol command structure. More...
class	cornelluniversity::vetserial::control_request
	base_command Implements a control (or header-only) command. More...
class	cornelluniversity::vetserial::status_request
	base_command Implements a control command soliciting a status check from the remote machine. More...
class	cornelluniversity::vetserial::status_response
	base_command Implements a control command responding to another machine's request for a status check. More...
class	cornelluniversity::vetserial::mp3_play_request
	base_command Implements a request to initiate the playing of an MP3 device on the remote device. More...
class	cornelluniversity::vetserial::mp3_stop_request
	base_command Implements a request to to stop the playing of a track that is currently in playback on the remote device. More...
Defines
#define	NULLPTR   0
Typedefs
typedef unsigned char	uint8_
typedef unsigned short	uint16_
typedef unsigned int	uint32_
typedef enum cornelluniversity::vetserial::STATUS_TYPE	cornelluniversity::vetserial::status_t
typedef enum cornelluniversity::vetserial::COMMAND_ID	cornelluniversity::vetserial::cmnd_id
typedef enum cornelluniversity::vetserial::ERROR_CODE	cornelluniversity::vetserial::err_code
typedef enum cornelluniversity::vetserial::FLAG_TYPE	cornelluniversity::vetserial::flag_t
Enumerations
enum	cornelluniversity::vetserial::STATUS_TYPE { cornelluniversity::vetserial::STATUS_ERROR = 0x10, cornelluniversity::vetserial::STATUS_READY = 0x20, cornelluniversity::vetserial::STATUS_BUSY = 0x40 }
	System status flags. More...
enum	cornelluniversity::vetserial::COMMAND_ID {   cornelluniversity::vetserial::CMD_CNTRL = 0x00, cornelluniversity::vetserial::CMD_REQSTAT = 0x01, cornelluniversity::vetserial::CMD_RSPSTAT = 0x02, cornelluniversity::vetserial::CMD_PLAY_MP3 = 0x03,   cornelluniversity::vetserial::CMD_STOP_MP3 = 0x04, cornelluniversity::vetserial::CMD_MAXCMD = 0xFF }
	System command identifiers. More...
enum	cornelluniversity::vetserial::ERROR_CODE {   cornelluniversity::vetserial::E_NOERROR = 0x00, cornelluniversity::vetserial::E_DATAOOB = 0x01, cornelluniversity::vetserial::E_NULLPTR = 0x02, cornelluniversity::vetserial::E_CHKSUM = 0x03,   cornelluniversity::vetserial::E_NONPROTO = 0xFE, cornelluniversity::vetserial::E_UNKNOWN = 0xFF }
	System error codes. More...
enum	cornelluniversity::vetserial::FLAG_TYPE {   cornelluniversity::vetserial::FLAG_REQ = 0x01, cornelluniversity::vetserial::FLAG_ACK = 0x02, cornelluniversity::vetserial::FLAG_NAK = 0x04, cornelluniversity::vetserial::FLAG_DATA = 0x08,   cornelluniversity::vetserial::FLAG_ERR = 0x10, cornelluniversity::vetserial::FLAG_RDY = 0x20, cornelluniversity::vetserial::FLAG_BUSY = 0x40, cornelluniversity::vetserial::FLAG_RESRVD = 0x80 }
	System control flags (a bit field). More...

---

Detailed Description

This file implements a command structure in support of the vet serial specification.

However, while these structures are currently intended for use over RS232 it is being implemented as an abstract "packet delivery" structure which should work fine over any transport capable of delivering serialized ascii data. See the protocol definition documentation for details.

Definition in file vetprot.h.

---

Define Documentation

#define NULLPTR   0

reliable NULL symbolic

Definition at line 40 of file vetprot.h.

---

Typedef Documentation

typedef unsigned short uint16_

convenience type representing 16-bit wide integers

Definition at line 43 of file vetprot.h.

typedef unsigned int uint32_

convenience type representing 32-bit wide integers

Definition at line 44 of file vetprot.h.

typedef unsigned char uint8_

convenience type representing 8-bit wide integers

Definition at line 42 of file vetprot.h.

---