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

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

#include <rle.h>

Public Types

enum  DecodeResult { DECODE_OK , DECODE_ERR_INVALID_SIGNATURE , DECODE_ERR_INVALID_PIPE , DECODE_ERR_INVALID_DATA }
 Enum representing the result of the decoding process. More...
 

Public Member Functions

void SetIn (std::shared_ptr< Pipe::CPipe > pipe_in_)
 Sets the input pipe for the decoder.
 
void SetOut (std::shared_ptr< Pipe::CPipe > pipe_out_)
 Sets the output pipe for the decoder.
 
CRleDecoder::DecodeResult Decode ()
 Performs the RLE decoding process.
 

Detailed Description

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

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

Member Enumeration Documentation

◆ DecodeResult

Enum representing the result of the decoding process.

Enumerator
DECODE_OK 

Decoding completed successfully.

DECODE_ERR_INVALID_SIGNATURE 

Invalid RLE signature.

DECODE_ERR_INVALID_PIPE 

Invalid input or output pipe.

DECODE_ERR_INVALID_DATA 

Invalid compressed data.

Member Function Documentation

◆ Decode()

CRleDecoder::DecodeResult Rle::CRleDecoder::Decode ( )

Performs the RLE decoding process.

Returns
Result of the decoding process.

◆ SetIn()

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

Sets the input pipe for the decoder.

Parameters
pipe_in_Shared pointer to the input pipe.

◆ SetOut()

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

Sets the output pipe for the decoder.

Parameters
pipe_out_Shared pointer to the output pipe.

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