class encoder_factory

Scope: kodo_slide

In header: #include <kodo_slide/encoder_factory.hpp>

Member functions (public)

  encoder_factory ()
encoder build ()
finite_field field () const
void initialize (encoder & codec)
void set_field (finite_field field)
void set_symbol_size (uint64_t symbol_size)
uint64_t symbol_size () const

Description

Factory for encoders. The factory is used to build and initialize encoders. If needed, e.g. for efficiency reasons, it is possible to re-initialize already built encoders in order to reuse them.

Member Function Description

encoder_factory ()

Constructor.

encoder build ()

Returns:
A new encoder.

finite_field field ()

Returns:
The finite field used.

void initialize (encoder & codec)

Parameter codec:
Initialize a encoder with the factory settings. After calling initialize the encoder will be ready for use.

void set_field (finite_field field)

Parameter field:
Set the finite field to use.

void set_symbol_size (uint64_t symbol_size)

Parameter symbol_size:
Sets the size of a symbol in bytes.

uint64_t symbol_size ()

Returns:
The current specified symbol size in bytes.