SimulationChain
 All Classes Functions Variables Pages
Public Member Functions | List of all members
IGenerator Interface Referenceabstract

#include <IGenerator.h>

Inheritance diagram for IGenerator:
Inheritance graph
[legend]

Public Member Functions

virtual double GenerateNext ()=0
 Used to generate next signal sample. More...
 
virtual void Reset ()=0
 Resets the generator to the enter state.
 
virtual void SetDelay (int)=0
 Sets the delay in samples.
 
virtual void LoadState (boost::property_tree::ptree::value_type const &)=0
 Sets generator parameters.
 
virtual void SaveState (boost::property_tree::ptree &) const =0
 Saves generator to given tree.
 
virtual GenType GetType () const =0
 Gets type of the generator.
 
virtual const std::string & GetName () const =0
 Gets name.
 
virtual void SetName (std::string &sName)=0
 Sets name.
 
virtual void SaveHistory ()=0
 Internally saves a current state in relation with the output signal generation.
 
virtual void LoadHistory ()=0
 Restores an internal state saved with SaveHistory() method.
 

Detailed Description

Intefrace to be inherited by generator subclasses.

To be used by generators in particular.
Main features:
  • generating samples,
  • saving and loading state - serialization,
  • saving and loading history, so generators can be used for prediction.

Member Function Documentation

virtual double IGenerator::GenerateNext ( )
pure virtual

Used to generate next signal sample.

Returns
Next generated sample of the output.

Implemented in CSineGen, CTriangleGen, CNoiseGen, CPulseGen, CSquareGen, and CStepGen.

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