mic::encoders::Encoder< inputDataType, SDRType > Class Template Reference

Abstract parent class for all encoders. More...

#include <Encoder.hpp>

Public Member Functions
	Encoder ()
	Constructor - empty. More...
virtual	~Encoder ()
virtual std::shared_ptr< SDRType >	encodeSample (const std::shared_ptr< inputDataType > &sample_)=0
	Method responsible for encoding input sample into SDR. More...
virtual std::shared_ptr < inputDataType >	decodeSample (const std::shared_ptr< SDRType > &sdr_)=0

Detailed Description

template<typename inputDataType, typename SDRType>
class mic::encoders::Encoder< inputDataType, SDRType >

Abstract parent class for all encoders.

Author

tkornuta

Template Parameters

inputDataType	Template parameter defining the input (sample) datatype.
SDRType	Template parameter defining the SDR type.

Definition at line 48 of file Encoder.hpp.

Constructor & Destructor Documentation

template<typename inputDataType, typename SDRType>

mic::encoders::Encoder< inputDataType, SDRType >::Encoder ( )

inline

Constructor - empty.

Definition at line 54 of file Encoder.hpp.

template<typename inputDataType, typename SDRType>

virtual mic::encoders::Encoder< inputDataType, SDRType >::~Encoder ( )

inlinevirtual

Virtual destructor - empty.

Definition at line 61 of file Encoder.hpp.

Member Function Documentation

template<typename inputDataType, typename SDRType>

virtual std::shared_ptr<inputDataType> mic::encoders::Encoder< inputDataType, SDRType >::decodeSample ( const std::shared_ptr< SDRType > &  sdr_ )

pure virtual

Method responsible for decoding of SDR back into original data type.

Parameters

[in]

sdr_

Shared pointer to SDR.

Returns

Shared pointer to decoded data.

template<typename inputDataType, typename SDRType>

virtual std::shared_ptr<SDRType> mic::encoders::Encoder< inputDataType, SDRType >::encodeSample ( const std::shared_ptr< inputDataType > &  sample_ )

pure virtual

Method responsible for encoding input sample into SDR.

Parameters

[in]

sample_

Shared pointer to sample data.

Returns

Shared pointer to encoded SDR.

Implemented in mic::encoders::UIntMatrixEncoder< T >, and mic::encoders::CharMatrixXfEncoder.

---

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

• src/encoders/Encoder.hpp