BEEP-8 Helper Lib 1.0.0
Loading...
Searching...
No Matches
Rle::CRleEncoder Class Reference

Class for encoding data using run-length encoding (RLE). More...

#include <rle.h>

Public Types

enum  EncodeResult { ENCODE_OK , ENCODE_ERR_INVALID_PIPE }
 Enum representing the result of the encoding process. More...
 

Public Member Functions

void SetIn (std::shared_ptr< Pipe::CPipe > pipe_in_)
 Sets the input pipe for the encoder.
 
void SetOut (std::shared_ptr< Pipe::CPipe > pipe_out_)
 Sets the output pipe for the encoder.
 
CRleEncoder::EncodeResult Encode ()
 Performs the RLE encoding process.
 

Detailed Description

Class for encoding data using run-length encoding (RLE).

This class reads data from an input pipe, performs RLE compression, and writes the compressed data to an output pipe.

Member Enumeration Documentation

◆ EncodeResult

Enum representing the result of the encoding process.

Enumerator
ENCODE_OK 

Encoding completed successfully.

ENCODE_ERR_INVALID_PIPE 

Invalid input or output pipe.

Member Function Documentation

◆ Encode()

CRleEncoder::EncodeResult Rle::CRleEncoder::Encode ( )

Performs the RLE encoding process.

Returns
Result of the encoding process.

◆ SetIn()

void Rle::CRleEncoder::SetIn ( std::shared_ptr< Pipe::CPipe > pipe_in_)

Sets the input pipe for the encoder.

Parameters
pipe_in_Shared pointer to the input pipe.

◆ SetOut()

void Rle::CRleEncoder::SetOut ( std::shared_ptr< Pipe::CPipe > pipe_out_)

Sets the output pipe for the encoder.

Parameters
pipe_out_Shared pointer to the output pipe.

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