GNU Radio's SATNOGS Package
gr::satnogs::code::ccsds_rs_encoder Class Reference

#include <ccsds_rs_encoder.h>

Inheritance diagram for gr::satnogs::code::ccsds_rs_encoder:

Public Types

enum class  ecc : size_t { ecc8 = 8UL , ecc16 = 16UL }
 Error correction capabilities. More...
 
enum class  interleaving_depth : size_t {
  depth1 = 1 , depth2 = 2 , depth3 = 3 , depth4 = 4 ,
  depth5 = 5 , depth8 = 8
}
 Interleaving depth. More...
 

Public Member Functions

 ccsds_rs_encoder (ecc e, interleaving_depth depth)
 
double rate () override
 
int get_input_size () override
 
int get_output_size () override
 
const char * get_input_conversion () override
 
const char * get_output_conversion () override
 
bool set_frame_size (unsigned int frame_size) override
 
void generic_work (void *inbuffer, void *outbuffer) override
 

Static Public Member Functions

static fec::generic_encoder::sptr make (ecc e, interleaving_depth depth)
 

Member Enumeration Documentation

◆ ecc

enum class gr::satnogs::code::ccsds_rs_encoder::ecc : size_t
strong

Error correction capabilities.

Note
the parity overhead can be calculated as $ \p ecc \times 2 $
Enumerator
ecc8 
ecc16 

◆ interleaving_depth

Interleaving depth.

Enumerator
depth1 
depth2 
depth3 
depth4 
depth5 
depth8 

Constructor & Destructor Documentation

◆ ccsds_rs_encoder()

gr::satnogs::code::ccsds_rs_encoder::ccsds_rs_encoder ( ecc  e,
interleaving_depth  depth 
)

Member Function Documentation

◆ generic_work()

void gr::satnogs::code::ccsds_rs_encoder::generic_work ( void *  inbuffer,
void *  outbuffer 
)
override

◆ get_input_conversion()

const char * gr::satnogs::code::ccsds_rs_encoder::get_input_conversion ( )
override

Set up a conversion type required to setup the data properly for this encoder. The encoder itself will not implement the conversion and expects an external wrapper (e.g., fec.extended_encoder) to read this value and "do the right thing" to format the data.

The default behavior is 'none', which means no conversion is required. Whatever the get_input_item_size() value returns, the input is expected to conform directly to this. Generally, this means unpacked bytes.

If 'pack', the block expects the inputs to be packed bytes. The wrapper should implement a gr::blocks::pack_k_bits_bb(8) block for this.

The child class MAY implement this function. If not reimplemented, it returns "none".

◆ get_input_size()

int gr::satnogs::code::ccsds_rs_encoder::get_input_size ( )
override

Returns the input size in items that the encoder object uses to encode a full frame. Often, this number is the number of bits per frame if the input format is unpacked. If the block expects packed bytes, then this value should be the number of bytes (number of bits / 8) per input frame.

The child class MUST implement this function.

◆ get_output_conversion()

const char * gr::satnogs::code::ccsds_rs_encoder::get_output_conversion ( )
override

Set up a conversion type required to understand the output style of this encoder. Generally an encoder will produce unpacked bytes with a bit set in the LSB.

The default behavior is 'none', which means no conversion is required and the encoder produces unpacked bytes.

If 'packed_bits', the block produces packed bits and the wrapper should unpack these (using, for instance, gr::block::unpack_k_bits_bb(8)).

The child class MAY implement this function. If not reimplemented, it returns "none".

◆ get_output_size()

int gr::satnogs::code::ccsds_rs_encoder::get_output_size ( )
override

Returns the output size in items that the encoder object produces after encoding a full frame. Often, this number is the number of bits in the outputted frame if the input format is unpacked. If the block produces packed bytes, then this value should be the number of bytes (number of bits / 8) per frame produced. This value is generally something like R*get_input_size() for a 1/R rate code.

The child class MUST implement this function.

◆ make()

static fec::generic_encoder::sptr gr::satnogs::code::ccsds_rs_encoder::make ( ecc  e,
interleaving_depth  depth 
)
static

◆ rate()

double gr::satnogs::code::ccsds_rs_encoder::rate ( )
override

◆ set_frame_size()

bool gr::satnogs::code::ccsds_rs_encoder::set_frame_size ( unsigned int  frame_size)
override

Updates the size of the frame to encode.

The child class MUST implement this function and interpret how the frame_size information affects the block's behavior. It should also provide bounds checks.


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