Roboid Control for C++
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Passer::RoboidControl::ThingMsg Class Reference

Detailed Description

Message providing generic information about a Thing.

#include <ThingMsg.h>

Inheritance diagram for Passer::RoboidControl::ThingMsg:
Passer::RoboidControl::IMessage

Public Member Functions

 ThingMsg (unsigned char networkId, Thing *thing)
 Create a message for sending.
 
 ThingMsg (const char *buffer)
 Create a message for receiving.
 
virtual ~ThingMsg ()
 Destructor for the message.
 
virtual unsigned char Serialize (char *buffer) override
 Serialize the message into a byte array for sending.
 

Public Attributes

unsigned char networkId
 The network ID of the thing.
 
unsigned char thingId
 The ID of the thing.
 
unsigned char thingType
 The Thing.Type of the thing.
 
unsigned char parentId
 The parent of the thing in the hierarachy. This is null for root Things.
 

Static Public Attributes

static const unsigned char id = 0x80
 The message ID.
 
static const unsigned char length = 5
 The length of the message.
 

Constructor & Destructor Documentation

◆ ThingMsg() [1/2]

Passer::RoboidControl::ThingMsg::ThingMsg ( unsigned char  networkId,
Thing thing 
)

Create a message for sending.

Parameters
networkIdThe network ID of the thing
Parameters
thingThe thing

◆ ThingMsg() [2/2]

Passer::RoboidControl::ThingMsg::ThingMsg ( const char *  buffer)

Create a message for receiving.

Parameters
bufferThe byte array to parse

Member Function Documentation

◆ Serialize()

unsigned char Passer::RoboidControl::ThingMsg::Serialize ( char *  buffer)
overridevirtual

Serialize the message into a byte array for sending.

Parameters
bufferThe buffer to serilize into
Returns
The length of the message in the buffer

Reimplemented from Passer::RoboidControl::IMessage.