TwiceAsNice  2019-02-18
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
Basda::Microgate::BcuReadCommand Class Reference

This BCU command is useful for reading the contents of different RAM types. More...

#include <BcuReadCommand.h>

Inheritance diagram for Basda::Microgate::BcuReadCommand:
Inheritance graph
Collaboration diagram for Basda::Microgate::BcuReadCommand:
Collaboration graph

Public Member Functions

 BcuReadCommand (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
 
void setReadLengthInDword (uint16_t readLength)
 
uint16_t getReadLengthInDword ()
 
virtual int8_tgetBeginOfMgpPacket ()
 
virtual uint32_t getMgpPacketLengthInByte ()
 
std::string toString ()
 
virtual ~BcuReadCommand ()
 
 BcuReadCommand (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
 
void setReadLengthInDword (uint16_t readLength)
 
uint16_t getReadLengthInDword ()
 
virtual int8_tgetBeginOfMgpPacket ()
 
virtual uint32_t getMgpPacketLengthInByte ()
 
std::string toString ()
 
virtual ~BcuReadCommand ()
 
 BcuReadCommand (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
 
void setReadLengthInDword (uint16_t readLength)
 
uint16_t getReadLengthInDword ()
 
virtual int8_tgetBeginOfMgpPacket ()
 
virtual uint32_t getMgpPacketLengthInByte ()
 
std::string toString ()
 
virtual ~BcuReadCommand ()
 
- Public Member Functions inherited from Basda::Microgate::BcuCommand
 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 ~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 ~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 ~BcuCommand ()=0
 

Static Public Member Functions

static BcuReadCommandPtr create (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
 
static BcuReadCommandPtr create (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
 
static BcuReadCommandPtr create (OpCode opcode, uint8_t firstDsp, uint8_t lastDsp)
 

Private Attributes

uint16_t dataLengthInDword_
 

Additional Inherited Members

- Protected Member Functions inherited from Basda::Microgate::BcuCommand
MgpHeadersetupGenericMgpPacket ()
 
void clearPacketBuffer ()
 
MgpHeadersetupGenericMgpPacket ()
 
void clearPacketBuffer ()
 
MgpHeadersetupGenericMgpPacket ()
 
void clearPacketBuffer ()
 
- Protected Attributes inherited from Basda::Microgate::BcuCommand
OpCode opCode_
 
uint8_t messageId_
 
int8_t flags_
 
int32_t memoryAddr_
 
int8_tpacketBuffer_
 
int8_t firstDsp_
 
int8_t lastDsp_
 
- Static Protected Attributes inherited from Basda::Microgate::BcuCommand
static const int8_t WANT_REPLY_BIT = 1
 

Detailed Description

This BCU command is useful for reading the contents of different RAM types.

Constructor & Destructor Documentation

◆ BcuReadCommand() [1/3]

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

◆ ~BcuReadCommand() [1/3]

Basda::Microgate::BcuReadCommand::~BcuReadCommand ( )
virtual
Note
overridden

◆ BcuReadCommand() [2/3]

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

◆ ~BcuReadCommand() [2/3]

virtual Basda::Microgate::BcuReadCommand::~BcuReadCommand ( )
virtual
Note
overridden

◆ BcuReadCommand() [3/3]

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

◆ ~BcuReadCommand() [3/3]

virtual Basda::Microgate::BcuReadCommand::~BcuReadCommand ( )
virtual
Note
overridden

Member Function Documentation

◆ create() [1/3]

BcuReadCommandPtr Basda::Microgate::BcuReadCommand::create ( OpCode  opcode,
uint8_t  firstDsp,
uint8_t  lastDsp 
)
static

◆ create() [2/3]

static BcuReadCommandPtr Basda::Microgate::BcuReadCommand::create ( OpCode  opcode,
uint8_t  firstDsp,
uint8_t  lastDsp 
)
static

◆ create() [3/3]

static BcuReadCommandPtr Basda::Microgate::BcuReadCommand::create ( OpCode  opcode,
uint8_t  firstDsp,
uint8_t  lastDsp 
)
static

◆ getBeginOfMgpPacket() [1/3]

virtual int8_t* Basda::Microgate::BcuReadCommand::getBeginOfMgpPacket ( )
virtual
Note
overridden

Implements Basda::Microgate::BcuCommand.

◆ getBeginOfMgpPacket() [2/3]

int8_t * Basda::Microgate::BcuReadCommand::getBeginOfMgpPacket ( )
virtual
Note
overridden

Implements Basda::Microgate::BcuCommand.

◆ getBeginOfMgpPacket() [3/3]

virtual int8_t* Basda::Microgate::BcuReadCommand::getBeginOfMgpPacket ( )
virtual
Note
overridden

Implements Basda::Microgate::BcuCommand.

◆ getMgpPacketLengthInByte() [1/3]

virtual uint32_t Basda::Microgate::BcuReadCommand::getMgpPacketLengthInByte ( )
virtual
Note
overridden

Implements Basda::Microgate::BcuCommand.

◆ getMgpPacketLengthInByte() [2/3]

uint32_t Basda::Microgate::BcuReadCommand::getMgpPacketLengthInByte ( )
virtual
Note
overridden

Implements Basda::Microgate::BcuCommand.

◆ getMgpPacketLengthInByte() [3/3]

virtual uint32_t Basda::Microgate::BcuReadCommand::getMgpPacketLengthInByte ( )
virtual
Note
overridden

Implements Basda::Microgate::BcuCommand.

◆ getReadLengthInDword() [1/3]

uint16_t Basda::Microgate::BcuReadCommand::getReadLengthInDword ( )

◆ getReadLengthInDword() [2/3]

uint16_t Basda::Microgate::BcuReadCommand::getReadLengthInDword ( )

◆ getReadLengthInDword() [3/3]

uint16_t Basda::Microgate::BcuReadCommand::getReadLengthInDword ( )

◆ setReadLengthInDword() [1/3]

void Basda::Microgate::BcuReadCommand::setReadLengthInDword ( uint16_t  readLength)

◆ setReadLengthInDword() [2/3]

void Basda::Microgate::BcuReadCommand::setReadLengthInDword ( uint16_t  readLength)

◆ setReadLengthInDword() [3/3]

void Basda::Microgate::BcuReadCommand::setReadLengthInDword ( uint16_t  readLength)

◆ toString() [1/3]

std::string Basda::Microgate::BcuReadCommand::toString ( )

◆ toString() [2/3]

std::string Basda::Microgate::BcuReadCommand::toString ( )

◆ toString() [3/3]

std::string Basda::Microgate::BcuReadCommand::toString ( )

Member Data Documentation

◆ dataLengthInDword_

uint16_t Basda::Microgate::BcuReadCommand::dataLengthInDword_
private

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