MeshNet  1.0.0
Public Member Functions | Static Public Member Functions | Data Fields
MeshOIDTableRow Struct Reference

Structure, that contains one row with data from out ID table. More...

#include <meshTables.h>

Public Member Functions

 MeshOIDTableRow ()=default
 
 MeshOIDTableRow (uint8_t id, uint8_t destination, SystemPacketType type)
 
void clear ()
 Removes all data from current row. More...
 
size_t printRow (OSTREAM &stream) const
 
bool operator== (const MeshOIDTableRow &another) const
 

Static Public Member Functions

static size_t printHeader (OSTREAM &stream)
 Print header for table of rows. More...
 

Data Fields

uint8_t ID = 0
 ID of message. More...
 
uint8_t Destination = 0
 Message destination. If set to UNKNOWN_MESH_ADDRESS (253), no destination is specified. More...
 
SystemPacketType Type = SystemPacketType::SPT_DATA
 Type of system message. More...
 

Detailed Description

Structure, that contains one row with data from out ID table.

Constructor & Destructor Documentation

◆ MeshOIDTableRow() [1/2]

MeshOIDTableRow::MeshOIDTableRow ( )
default

◆ MeshOIDTableRow() [2/2]

MeshOIDTableRow::MeshOIDTableRow ( uint8_t  id,
uint8_t  destination,
SystemPacketType  type 
)

Member Function Documentation

◆ clear()

void MeshOIDTableRow::clear ( )
inline

Removes all data from current row.

◆ operator==()

bool MeshOIDTableRow::operator== ( const MeshOIDTableRow another) const
inline

◆ printHeader()

size_t MeshOIDTableRow::printHeader ( OSTREAM stream)
static

Print header for table of rows.

Parameters
streamStream, where header will be printed.
Returns
Returns number of printed characters.

◆ printRow()

size_t MeshOIDTableRow::printRow ( OSTREAM stream) const

@breif Prints row to stream.

Parameters
streamStream, where row will be printed.
Returns
Returns number of printed characters.

Field Documentation

◆ Destination

uint8_t MeshOIDTableRow::Destination = 0

Message destination. If set to UNKNOWN_MESH_ADDRESS (253), no destination is specified.

◆ ID

uint8_t MeshOIDTableRow::ID = 0

ID of message.

◆ Type

SystemPacketType MeshOIDTableRow::Type = SystemPacketType::SPT_DATA

Type of system message.

Warning
Enums: SPT_ACK and SPT_ACK_ERR are invalid here, but enum SPT_DATA can be used.

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