simthlib::Encoder Class Reference

abstract base class More...

#include <encoder.h>

Inheritance diagram for simthlib::Encoder:

[legend]List of all members.

Public Member Functions
	Encoder (int deviceID, simth::DeviceSystemIntf *system, const simth::PropertyList &pl)
virtual	~Encoder ()
virtual void	updateInputLengths ()
virtual void	updateOutputLengths ()
virtual void	process ()
void	startOfSimulation ()
virtual int	getDataLength (int codedLength) const =0
virtual int	getCodeLength (int rawLength) const =0
virtual void	Encode (const simth::BitSeq &bits, simth::BitSeq *encBits) const =0
virtual void	print (std::ostream &os) const
Static Public Member Functions
static void	init (const std::string fileName, simth::Device **dev, simth::DeviceSystemIntf *sysPtr, int ID, const std::string &regionQualifier="")
Related Functions
(Note that these are not member functions.)
	propertylist_Encoder (not_a_function)

---

Detailed Description

abstract base class

Abstract base class which provides an interface for particularly derived coder classes.

---

Constructor & Destructor Documentation

simthlib::Encoder::Encoder (  int  deviceID, simth::DeviceSystemIntf *  system, const simth::PropertyList &  pl )

virtual simthlib::Encoder::~Encoder (   )  [inline, virtual]

---

Member Function Documentation

virtual void simthlib::Encoder::Encode (  const simth::BitSeq &  bits, simth::BitSeq *  encBits )  const [pure virtual]

Encodes the given bit sequence. Implemented in simthlib::ReedSolomonEncoder, simthlib::ConvEncoder, simthlib::PunctConvEncoder, and simthlib::DapskEncoder.

virtual int simthlib::Encoder::getCodeLength (  int  rawLength  )  const [pure virtual]

Returns the length of a coded bit sequence which is generated by the coder from a data sequence of the given length. If the data length does not fit (dataLength dataBitsPerStep() != 0) an FitErr exception is thrown, which should be caught in the scope calling the function. Parameters: rawLength  length of the data sequence Returns: allocated length of the coded sequence Implemented in simthlib::ReedSolomonEncoder, simthlib::ConvEncoder, simthlib::PunctConvEncoder, and simthlib::DapskEncoder.

virtual int simthlib::Encoder::getDataLength (  int  codedLength  )  const [pure virtual]

If the coded length does fit (codedLength codedBitsPerStep() == 0) the function the function returns the length of a data bit sequence which is encoded by the coder from a coded bit sequence of the given length. In general the function returns the maximal length of a data bit which encoded length is smaller or equal code_length. Parameters: codedLength  length of the coded sequence Returns: allocated length of the encoded data sequence Implemented in simthlib::ReedSolomonEncoder, simthlib::ConvEncoder, simthlib::PunctConvEncoder, and simthlib::DapskEncoder.

static void simthlib::Encoder::init (  const std::string  fileName, simth::Device **  dev, simth::DeviceSystemIntf *  sysPtr, int  ID, const std::string &  regionQualifier = "" )  [static]

virtual void simthlib::Encoder::print (  std::ostream &  os  )  const [virtual]

Reimplemented from simth::Device. Reimplemented in simthlib::ConvEncoder, and simthlib::DapskEncoder.

virtual void simthlib::Encoder::process (   )  [virtual]

Implements simth::Device.

void simthlib::Encoder::startOfSimulation (   )  [virtual]

Sets the input length. Reimplemented from simth::Device.

virtual void simthlib::Encoder::updateInputLengths (   )  [virtual]

Implements simth::Device. Reimplemented in simthlib::ReedSolomonEncoder.

virtual void simthlib::Encoder::updateOutputLengths (   )  [virtual]

Implements simth::Device. Reimplemented in simthlib::ReedSolomonEncoder.

---

Friends And Related Function Documentation

propertylist_Encoder (  not_a_function   )  [related]

These are the properties of class Encoder . This list is auto-generated from the XML-Devicelist of this device by means of an XSLT transformation script. Description of this device in the XML file: Base class for the usual encoder block in a simulation system. Note that this class also has the Properties of its base classes. The direct base class is simth::Device ; direct link to its propertylist should be propertylist_Device(). The list below usually includes the properties that have been inherited from the base classes; the properties which belong only to this class can be found at the end of this list. input_length <sequencelength>, default "" -- 1 properties in this class.

---