AFF3CT
A Fast Forward Error Correction Tool!
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
Module Class Reference

A Module is an abstract concept. Basically, all the objects used in a Simulation are a Module. More...

#include <Module.hpp>

Inheritance diagram for Module:
Channel_i< R > Coset_i< B, D > Coset_i< B, Q > CRC_i< B > Decoder_i< B, R > Encoder_i< B > Interleaver_i< T > Interleaver_i< int > Interleaver_i< short > Modulator_i< B, R, Q > Modulator_i< B, R, R > Monitor_i< B > Puncturer_i< B, Q > Quantizer_i< R, Q > SISO_i< R > Source_i< B >

Public Member Functions

 Module (const int n_frames=1, const std::string name="Module")
 Constructor. More...
 
virtual ~Module ()
 Destructor.
 
virtual void set_n_frames (const int n_frames)
 Set the number of frames. More...
 
virtual int get_n_frames () const
 Get the number of frames. More...
 
void rename (const std::string name)
 Rename the Module. More...
 

Protected Attributes

int n_frames
 
std::string name
 

Detailed Description

A Module is an abstract concept. Basically, all the objects used in a Simulation are a Module.

Constructor & Destructor Documentation

Module::Module ( const int  n_frames = 1,
const std::string  name = "Module" 
)
inline

Constructor.

Parameters
n_framesnumber of frames to process in this Module.
name: Module's name.

Member Function Documentation

virtual int Module::get_n_frames ( ) const
inlinevirtual

Get the number of frames.

Returns
the number of frames to process in this Module.

Reimplemented in Decoder_SISO< B, R >.

void Module::rename ( const std::string  name)
inline

Rename the Module.

Parameters
namethe new Module name.
virtual void Module::set_n_frames ( const int  n_frames)
inlinevirtual

Member Data Documentation

int Module::n_frames
protected

Number of frames to process in this Module

std::string Module::name
protected

Name of the Module.


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