Basda::Microgate::BcuCommand Class Reference

This abstract class is the base for all BCU commands. More...

#include <BcuCommand.h>

Inheritance diagram for Basda::Microgate::BcuCommand:

Collaboration diagram for Basda::Microgate::BcuCommand:

Public Member Functions
	BcuCommand (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
void	setMessageId (uint8_t id)
uint8_t	getMessageId ()
void	enableReply ()
bool	isReplyEnabled ()
void	setMemoryAddress (int32_t addr)
int32_t	getMemoryAddress ()
OpCode	getOpCode ()
uint8_t	getFirstDsp ()
uint8_t	getLastDsp ()
virtual int8_t *	getBeginOfMgpPacket ()=0
virtual uint32_t	getMgpPacketLengthInByte ()=0
virtual	~BcuCommand ()=0
	BcuCommand (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
void	setMessageId (uint8_t id)
uint8_t	getMessageId ()
void	enableReply ()
bool	isReplyEnabled ()
void	setMemoryAddress (int32_t addr)
int32_t	getMemoryAddress ()
OpCode	getOpCode ()
uint8_t	getFirstDsp ()
uint8_t	getLastDsp ()
virtual int8_t *	getBeginOfMgpPacket ()=0
virtual uint32_t	getMgpPacketLengthInByte ()=0
virtual	~BcuCommand ()=0
	BcuCommand (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
void	setMessageId (uint8_t id)
uint8_t	getMessageId ()
void	enableReply ()
bool	isReplyEnabled ()
void	setMemoryAddress (int32_t addr)
int32_t	getMemoryAddress ()
OpCode	getOpCode ()
uint8_t	getFirstDsp ()
uint8_t	getLastDsp ()
virtual int8_t *	getBeginOfMgpPacket ()=0
virtual uint32_t	getMgpPacketLengthInByte ()=0
virtual	~BcuCommand ()=0

Protected Member Functions
MgpHeader *	setupGenericMgpPacket ()
void	clearPacketBuffer ()
MgpHeader *	setupGenericMgpPacket ()
void	clearPacketBuffer ()
MgpHeader *	setupGenericMgpPacket ()
void	clearPacketBuffer ()

Protected Attributes
OpCode	opCode_
uint8_t	messageId_
int8_t	flags_
int32_t	memoryAddr_
int8_t *	packetBuffer_
int8_t	firstDsp_
int8_t	lastDsp_

Static Protected Attributes
static const int8_t	WANT_REPLY_BIT = 1

Detailed Description

This abstract class is the base for all BCU commands.

Warning

FIXME 2011-02-04 borelli, kulas: This code requires computers with little-endian byte order!

Constructor & Destructor Documentation

BcuCommand() [1/3]

Basda::Microgate::BcuCommand::BcuCommand	(	OpCode	opcode,
		uint8_t	firstDsp,
		uint8_t	lastDsp
	)

~BcuCommand() [1/3]

Basda::Microgate::BcuCommand::~BcuCommand ( )

pure virtual

BcuCommand() [2/3]

Basda::Microgate::BcuCommand::BcuCommand	(	OpCode	opcode,
		uint8_t	firstDsp,
		uint8_t	lastDsp
	)

~BcuCommand() [2/3]

virtual Basda::Microgate::BcuCommand::~BcuCommand ( )

pure virtual

BcuCommand() [3/3]

Basda::Microgate::BcuCommand::BcuCommand	(	OpCode	opcode,
		uint8_t	firstDsp,
		uint8_t	lastDsp
	)

~BcuCommand() [3/3]

virtual Basda::Microgate::BcuCommand::~BcuCommand ( )

pure virtual

Member Function Documentation

clearPacketBuffer() [1/3]

void Basda::Microgate::BcuCommand::clearPacketBuffer ( )

protected

clearPacketBuffer() [2/3]

void Basda::Microgate::BcuCommand::clearPacketBuffer ( )

protected

clearPacketBuffer() [3/3]

void Basda::Microgate::BcuCommand::clearPacketBuffer ( )

protected

enableReply() [1/3]

void Basda::Microgate::BcuCommand::enableReply

(

)

enableReply() [2/3]

void Basda::Microgate::BcuCommand::enableReply

(

)

enableReply() [3/3]

void Basda::Microgate::BcuCommand::enableReply

(

)

getBeginOfMgpPacket() [1/3]

virtual int8_t* Basda::Microgate::BcuCommand::getBeginOfMgpPacket ( )

pure virtual

Implemented in Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuReadCommand, Basda::Microgate::BcuReadCommand, and Basda::Microgate::BcuReadCommand.

getBeginOfMgpPacket() [2/3]

virtual int8_t* Basda::Microgate::BcuCommand::getBeginOfMgpPacket ( )

pure virtual

Implemented in Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuReadCommand, Basda::Microgate::BcuReadCommand, and Basda::Microgate::BcuReadCommand.

getBeginOfMgpPacket() [3/3]

virtual int8_t* Basda::Microgate::BcuCommand::getBeginOfMgpPacket ( )

pure virtual

Implemented in Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuReadCommand, Basda::Microgate::BcuReadCommand, and Basda::Microgate::BcuReadCommand.

getFirstDsp() [1/3]

uint8_t Basda::Microgate::BcuCommand::getFirstDsp

(

)

getFirstDsp() [2/3]

uint8_t Basda::Microgate::BcuCommand::getFirstDsp

(

)

getFirstDsp() [3/3]

uint8_t Basda::Microgate::BcuCommand::getFirstDsp

(

)

getLastDsp() [1/3]

uint8_t Basda::Microgate::BcuCommand::getLastDsp

(

)

getLastDsp() [2/3]

uint8_t Basda::Microgate::BcuCommand::getLastDsp

(

)

getLastDsp() [3/3]

uint8_t Basda::Microgate::BcuCommand::getLastDsp

(

)

getMemoryAddress() [1/3]

int32_t Basda::Microgate::BcuCommand::getMemoryAddress

(

)

getMemoryAddress() [2/3]

int32_t Basda::Microgate::BcuCommand::getMemoryAddress

(

)

getMemoryAddress() [3/3]

int32_t Basda::Microgate::BcuCommand::getMemoryAddress

(

)

getMessageId() [1/3]

uint8_t Basda::Microgate::BcuCommand::getMessageId

(

)

getMessageId() [2/3]

uint8_t Basda::Microgate::BcuCommand::getMessageId

(

)

getMessageId() [3/3]

uint8_t Basda::Microgate::BcuCommand::getMessageId

(

)

getMgpPacketLengthInByte() [1/3]

virtual uint32_t Basda::Microgate::BcuCommand::getMgpPacketLengthInByte ( )

pure virtual

Implemented in Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuReadCommand, Basda::Microgate::BcuReadCommand, and Basda::Microgate::BcuReadCommand.

getMgpPacketLengthInByte() [2/3]

virtual uint32_t Basda::Microgate::BcuCommand::getMgpPacketLengthInByte ( )

pure virtual

Implemented in Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuReadCommand, Basda::Microgate::BcuReadCommand, and Basda::Microgate::BcuReadCommand.

getMgpPacketLengthInByte() [3/3]

virtual uint32_t Basda::Microgate::BcuCommand::getMgpPacketLengthInByte ( )

pure virtual

Implemented in Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuWriteCommand, Basda::Microgate::BcuReadCommand, Basda::Microgate::BcuReadCommand, and Basda::Microgate::BcuReadCommand.

getOpCode() [1/3]

OpCode Basda::Microgate::BcuCommand::getOpCode

(

)

getOpCode() [2/3]

OpCode Basda::Microgate::BcuCommand::getOpCode

(

)

getOpCode() [3/3]

OpCode Basda::Microgate::BcuCommand::getOpCode

(

)

isReplyEnabled() [1/3]

bool Basda::Microgate::BcuCommand::isReplyEnabled

(

)

isReplyEnabled() [2/3]

bool Basda::Microgate::BcuCommand::isReplyEnabled

(

)

isReplyEnabled() [3/3]

bool Basda::Microgate::BcuCommand::isReplyEnabled

(

)

setMemoryAddress() [1/3]

void Basda::Microgate::BcuCommand::setMemoryAddress

(

int32_t

addr

)

setMemoryAddress() [2/3]

void Basda::Microgate::BcuCommand::setMemoryAddress

(

int32_t

addr

)

setMemoryAddress() [3/3]

void Basda::Microgate::BcuCommand::setMemoryAddress

(

int32_t

addr

)

setMessageId() [1/3]

void Basda::Microgate::BcuCommand::setMessageId

(

uint8_t

id

)

setMessageId() [2/3]

void Basda::Microgate::BcuCommand::setMessageId

(

uint8_t

id

)

setMessageId() [3/3]

void Basda::Microgate::BcuCommand::setMessageId

(

uint8_t

id

)

setupGenericMgpPacket() [1/3]

MgpHeader* Basda::Microgate::BcuCommand::setupGenericMgpPacket ( )

protected

setupGenericMgpPacket() [2/3]

MgpHeader* Basda::Microgate::BcuCommand::setupGenericMgpPacket ( )

protected

setupGenericMgpPacket() [3/3]

MgpHeader * Basda::Microgate::BcuCommand::setupGenericMgpPacket ( )

protected

Member Data Documentation

firstDsp_

int8_t Basda::Microgate::BcuCommand::firstDsp_

protected

flags_

int8_t Basda::Microgate::BcuCommand::flags_

protected

lastDsp_

int8_t Basda::Microgate::BcuCommand::lastDsp_

protected

memoryAddr_

int32_t Basda::Microgate::BcuCommand::memoryAddr_

protected

messageId_

uint8_t Basda::Microgate::BcuCommand::messageId_

protected

opCode_

OpCode Basda::Microgate::BcuCommand::opCode_

protected

packetBuffer_

int8_t * Basda::Microgate::BcuCommand::packetBuffer_

protected

WANT_REPLY_BIT

static const int8_t Basda::Microgate::BcuCommand::WANT_REPLY_BIT = 1

staticprotected

---

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

• /home/nirva/insroot/include/Basda/Microgate/Mgp/BcuCommand.h
• TwiceAsNice/basda-misda/doc/include/BcuCommand.cpp