Coder

INCLUDE FILE

#include <tpau-cpp-kernal/Coder.h>

class Coder

DEFINITION

            class Coder;
        

constructor Coderprotected

DEFINITION

Coder

(

CoderEngine & engine

);

PARAMETER	DESCRIPTION
`engine`

destructor ~Codervirtual

DEFINITION

virtual ~Coder

(

);

method finishprotected

Finish the coding process.

Subclasses should call this method in their end() method.

DEFINITION

void finish

(

);

method process

Process the given data.

DEFINITION

void process

(

std::string_view data

);

PARAMETER	DESCRIPTION
`data`	The data to process.

method process

Process the given byte.

DEFINITION

void process

(

uint8_t datum

);

PARAMETER	DESCRIPTION
`datum`	The byte to process.

class CoderEngine

DEFINITION

            class CoderEngine;
        

constructor CoderEngine

DEFINITION

CoderEngine

(

CoderOutput & output

);

PARAMETER	DESCRIPTION
`output`

destructor ~CoderEnginevirtual

DEFINITION

virtual ~CoderEngine

(

);

method endprotected

DEFINITION

void end

(

);

method finish

Finish the coding process.

DEFINITION

void finish

(

);

method finish_implementationvirtual protected

Finish the coding process.

DEFINITION

virtual void finish_implementation

(

);

method process

Process the given byte.

DEFINITION

void process

(

uint8_t datum

);

PARAMETER	DESCRIPTION
`datum`	The byte to process.

method process_implementationvirtual protected

Process the given byte.

DEFINITION

virtual void process_implementation

(

uint8_t datum

)

= 0;

PARAMETER	DESCRIPTION
`datum`	The byte to process.

method writeprotected

DEFINITION

void write

(

uint8_t datum

);

PARAMETER	DESCRIPTION
`datum`

member errorprotected

DEFINITION

bool error;

member finishedprotected

DEFINITION

bool finished;

member outputprotected

DEFINITION

CoderOutput & output;

class CoderOutput

DEFINITION

            class CoderOutput;
        

destructor ~CoderOutputvirtual

DEFINITION

virtual ~CoderOutput

(

);

method end

All output has been written.

DEFINITION

void end

(

);

THROWS	DESCRIPTION
`Exception`	if the output has already been ended.
`std::runtime_error`	if an error occurs while ending the output.

method end_implementationvirtual protected

End the output. This is called by end().

DEFINITION

virtual void end_implementation

(

);

THROWS	DESCRIPTION
`std::runtime_error`	if an error occurs while ending the output.

method write

Write the given byte to the output.

DEFINITION

void write

(

uint8_t datum

);

PARAMETER	DESCRIPTION
`datum`	The byte to write.

THROWS	DESCRIPTION
`Exception`	if the output has already been ended.
`std::runtime_error`	if an error occurs while writing the byte.

method write_implementationvirtual protected

Write the given byte to the output. This is called by write().

DEFINITION

virtual void write_implementation

(

uint8_t datum

)

= 0;

PARAMETER	DESCRIPTION
`datum`	The byte to write.

THROWS	DESCRIPTION
`std::runtime_error`	if an error occurs while writing the byte.

member endedprotected

DEFINITION

bool ended;

class StreamCoderOutput

DEFINITION

            class StreamCoderOutput;
        

constructor StreamCoderOutput

DEFINITION

StreamCoderOutput	(	std::ostream & stream,
		size_t line_length = 0,
		size_t indent = 0	);

PARAMETER	DESCRIPTION
`stream`
`line_length`
`indent`

method write_implementationvirtual

Write the given byte to the output. This is called by write().

DEFINITION

virtual void write_implementation

(

uint8_t datum

);

PARAMETER	DESCRIPTION
`datum`	The byte to write.

THROWS	DESCRIPTION
`std::runtime_error`	if an error occurs while writing the byte.

class StringCoderOutput

DEFINITION

            class StringCoderOutput;
        

constructor StringCoderOutput

DEFINITION

StringCoderOutput

(

);

method get_string

Get the string that has been written to the output.

DEFINITION

std::string get_string

(

);

RETURNS	DESCRIPTION
`std::string`	The string that has been written to the output.

THROWS	DESCRIPTION
`Exception`	if the output has not been ended yet.

method write_implementationvirtual

Write the given byte to the output. This is called by write().

DEFINITION

virtual void write_implementation

(

uint8_t datum

);

PARAMETER	DESCRIPTION
`datum`	The byte to write.

THROWS	DESCRIPTION
`std::runtime_error`	if an error occurs while writing the byte.