MeshNet  1.0.0
Public Member Functions
RawPrintable Class Reference

Interface for converting class or structure instance to raw bytes, which can be sent. More...

#include <meshHelper.h>

Inheritance diagram for RawPrintable:
Inheritance graph
[legend]
Collaboration diagram for RawPrintable:
Collaboration graph
[legend]

Public Member Functions

virtual size_t sizeOf () const
 Gets size of whole current instance uncompressed (including dynamically allocated memory) in bytes. More...
 
virtual size_t printRaw (OSTREAM *stream, void(*CRC_calculation)(uint8_t *, size_t)) const
 Prints current instance into stream in raw bytes. More...
 
virtual size_t getRawSize () const
 Gets size of data, that will be printed to stream using printRaw() in bytes. More...
 
- Public Member Functions inherited from InlinePrintable
virtual size_t printHeader (OSTREAM *stream) const
 Prints header of table. More...
 
virtual size_t printLine (OSTREAM *stream) const
 Prints this data as row to table. More...
 

Detailed Description

Interface for converting class or structure instance to raw bytes, which can be sent.

Member Function Documentation

◆ getRawSize()

virtual size_t RawPrintable::getRawSize ( ) const
inlinevirtual

Gets size of data, that will be printed to stream using printRaw() in bytes.

Returns
Size of raw data in bytes.

Reimplemented in MeshPacket.

◆ printRaw()

virtual size_t RawPrintable::printRaw ( OSTREAM stream,
void(*)(uint8_t *, size_t)  CRC_calculation 
) const
inlinevirtual

Prints current instance into stream in raw bytes.

Parameters
CRC_calculationPointer to function, which provides CRC calculation, every sent byte has to be passed to this function. First parameter is pointer to data, that were printed and second is number of printed bytes.
Returns
Number of printed characters.

Reimplemented in MeshPacket.

◆ sizeOf()

virtual size_t RawPrintable::sizeOf ( ) const
inlinevirtual

Gets size of whole current instance uncompressed (including dynamically allocated memory) in bytes.

Returns
Size of instance in bytes.

Reimplemented in MeshPacket.


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