RIT VEXU Core API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
VDP::Part Class Referenceabstract

#include <protocol.hpp>

Inheritance diagram for VDP::Part:
VDP::Number< float, Type::Float > VDP::Number< double, Type::Double > VDP::Number< uint8_t, Type::Uint8 > VDP::Number< uint16_t, Type::Uint16 > VDP::Number< uint32_t, Type::Uint32 > VDP::Number< uint64_t, Type::Uint64 > VDP::Number< int8_t, Type::Int8 > VDP::Number< int16_t, Type::Int16 > VDP::Number< int32_t, Type::Int32 > VDP::Number< int64_t, Type::Int64 > VDP::Number< NumT, schemaType > VDP::Record VDP::String

Public Member Functions

 Part (std::string name)
 
std::string pretty_print () const
 
std::string pretty_print_data () const
 
virtual void read_data_from_message (PacketReader &reader)=0
 

Protected Member Functions

virtual void write_schema (PacketWriter &sofar) const =0
 
virtual void write_message (PacketWriter &sofar) const =0
 
virtual void pprint (std::stringstream &ss, size_t indent) const =0
 
virtual void pprint_data (std::stringstream &ss, size_t indent) const =0
 

Detailed Description

defines a Part, which has a name and contains data essentially defines data formatted so that it can be sent to the debug board

Constructor & Destructor Documentation

◆ Part()

VDP::Part::Part ( std::string name)

Creates a Part with a name a part is essentially data formatted so that it can be sent to the debug board

Parameters
namename for the Part

Member Function Documentation

◆ pprint()

virtual void VDP::Part::pprint ( std::stringstream & ss,
size_t indent ) const
protectedpure virtual

changes a stringstream to a specified format, meant to be overrided

Parameters
ssthe stream of strings to change
indentthe amount of double spaced indents to add to the string

Implemented in VDP::Number< NumT, schemaType >, VDP::Number< double, Type::Double >, VDP::Number< double, Type::Double >, VDP::Number< float, Type::Float >, VDP::Number< float, Type::Float >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Number< uint8_t, Type::Uint8 >, and VDP::String.

◆ pprint_data()

virtual void VDP::Part::pprint_data ( std::stringstream & ss,
size_t indent ) const
protectedpure virtual

changes a stringstream to the contain the Part's data in a specified format, meant to be overrided

Parameters
ssthe stream of strings to change
indentthe amount of double spaced indents to add to the string

Implemented in VDP::Number< NumT, schemaType >, VDP::Number< double, Type::Double >, VDP::Number< double, Type::Double >, VDP::Number< float, Type::Float >, VDP::Number< float, Type::Float >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Number< uint8_t, Type::Uint8 >, and VDP::String.

◆ pretty_print()

std::string VDP::Part::pretty_print ( ) const
Returns
a string of the Part with the format "name: string"
a stringstream of the Part with the format "name: string"

◆ pretty_print_data()

std::string VDP::Part::pretty_print_data ( ) const
Returns
a string of the Part's data with the format "name: value"
a stringstream of the Part's data with the format "name: value"

◆ read_data_from_message()

virtual void VDP::Part::read_data_from_message ( PacketReader & reader)
pure virtual

sets the data the part contains to the data from a packet, meant to be overrided

Parameters
readerthe PacketReader to read data from

Implemented in VDP::Number< NumT, schemaType >, VDP::Number< double, Type::Double >, VDP::Number< double, Type::Double >, VDP::Number< float, Type::Float >, VDP::Number< float, Type::Float >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Record, and VDP::String.

◆ write_message()

virtual void VDP::Part::write_message ( PacketWriter & sofar) const
protectedpure virtual

writes the value of the Part to a packet so that it can be sent to the debug board

Parameters
sofarthe packet writer to write with

Implemented in VDP::Number< NumT, schemaType >, VDP::Number< double, Type::Double >, VDP::Number< double, Type::Double >, VDP::Number< float, Type::Float >, VDP::Number< float, Type::Float >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Record, and VDP::String.

◆ write_schema()

virtual void VDP::Part::write_schema ( PacketWriter & sofar) const
protectedpure virtual

writes the Part schematic to a packet so that it can be sent to the debug board, meant to be overrided

Parameters
sofarthe packet writer to write with

Implemented in VDP::Number< NumT, schemaType >, VDP::Number< double, Type::Double >, VDP::Number< double, Type::Double >, VDP::Number< float, Type::Float >, VDP::Number< float, Type::Float >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int16_t, Type::Int16 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int32_t, Type::Int32 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int64_t, Type::Int64 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< int8_t, Type::Int8 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint16_t, Type::Uint16 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint32_t, Type::Uint32 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint64_t, Type::Uint64 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Number< uint8_t, Type::Uint8 >, VDP::Record, and VDP::String.

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