tinymodem::DataCodec Class Reference

Converts between characters and the data bits of a frame. More...

#include <DataCodecs.h>

Inheritance diagram for tinymodem::DataCodec:

Public Member Functions
virtual	~DataCodec ()=default
virtual void	reset ()
	resets the internal state (called when the carrier is acquired)
virtual int	encode (uint32_t words[2], uint8_t ch)
	Converts a character into 0, 1 or 2 data words: returns the count.
virtual size_t	decode (Print &out, uint64_t bits, unsigned n_bits)=0
	Decodes the data bits of a frame: returns the number of written bytes.

Detailed Description

Converts between characters and the data bits of a frame.

Copyright

GPLv3

Constructor & Destructor Documentation

~DataCodec()

virtual tinymodem::DataCodec::~DataCodec ( )

virtualdefault

Member Function Documentation

decode()

virtual size_t tinymodem::DataCodec::decode ( Print & out, uint64_t bits, unsigned n_bits )

pure virtual

Decodes the data bits of a frame: returns the number of written bytes.

Implemented in tinymodem::AsciiCodec, tinymodem::BaudotCodec, tinymodem::BinaryCodec, tinymodem::CallerIDCodec, and tinymodem::UICCodec.

encode()

virtual int tinymodem::DataCodec::encode ( uint32_t words[2], uint8_t ch )

inlinevirtual

Converts a character into 0, 1 or 2 data words: returns the count.

Reimplemented in tinymodem::BaudotCodec.

reset()

virtual void tinymodem::DataCodec::reset ( )

inlinevirtual

resets the internal state (called when the carrier is acquired)

Reimplemented in tinymodem::BaudotCodec, and tinymodem::CallerIDCodec.

---

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

• src/modem/DataCodecs.h