Robox Library for Cpp: BCC/31 module 1.0.0
RLibCpp BCC/31 protocol implementation
Public Member Functions | Public Attributes | List of all members
Message::bccMessage Struct Reference

The Bcc message raw data structure. More...

#include <message.h>

Public Member Functions

 bccMessage ()
 Default constructor.
 
 bccMessage (bccMessage *source)
 Copy constructor.
 
void clear ()
 Clears the message.
 
void copyFrom (const bccMessage *source)
 Copy from a source object.
 
bool isSameOf (const bccMessage &other)
 Compare to ither message.
 

Public Attributes

uint8_t dst
 Destination ID.
 
uint8_t dch
 Destination channel ID.
 
uint8_t src
 Source ID.
 
uint8_t sch
 Source channel ID.
 
uint16_t msg
 Message code.
 
uint8_t len
 Size of the data area (0 = no data)
 
uint8_t pid
 Protocol ID.
 
uint8_t res
 Reserved (eg DLC)
 
uint8_t data [255]
 Optional message data.
 

Detailed Description

The Bcc message raw data structure.

Constructor & Destructor Documentation

◆ bccMessage() [1/2]

bccMessage ( )
inline

Default constructor.

◆ bccMessage() [2/2]

bccMessage ( bccMessage * source)
inline

Copy constructor.

Parameters
sourceThe source object

Member Function Documentation

◆ clear()

void clear ( )
inline

Clears the message.

◆ copyFrom()

void copyFrom ( const bccMessage * source)
inline

Copy from a source object.

Parameters
sourceThe source object

◆ isSameOf()

bool isSameOf ( const bccMessage & other)
inline

Compare to ither message.

Parameters
otherThe message to comapre
Returns
true if the objects have the same content

Member Data Documentation

◆ data

uint8_t data[255]

Optional message data.

◆ dch

uint8_t dch

Destination channel ID.

◆ dst

uint8_t dst

Destination ID.

◆ len

uint8_t len

Size of the data area (0 = no data)

◆ msg

uint16_t msg

Message code.

◆ pid

uint8_t pid

Protocol ID.

◆ res

uint8_t res

Reserved (eg DLC)

◆ sch

uint8_t sch

Source channel ID.

◆ src

uint8_t src

Source ID.