hops::MHO_SimulatedSignalGenerator Class Reference

#include <MHO_SimulatedSignalGenerator.hh>

Inheritance diagram for hops::MHO_SimulatedSignalGenerator:

Public Member Functions
	MHO_SimulatedSignalGenerator ()
virtual	~MHO_SimulatedSignalGenerator ()
bool	GetSample (const double &sample_time, double &sample) const
	Getter for sample. More...
virtual double	GetSamplingFrequency () const
	Getter for sampling frequency. More...
virtual void	Initialize ()=0
	Function Initialize. More...
virtual void	SetSamplingFrequency (double sample_freq)
	Setter for sampling frequency. More...

Protected Member Functions
virtual bool	GenerateSample (const double &sample_time, double &sample) const =0
	Generates a sample based on given time and updates it. More...

Protected Attributes
double	fSamplingFrequency

Detailed Description

Date

Mon Dec 19 16:33:05 2022 -0500

Author

J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Constructor & Destructor Documentation

MHO_SimulatedSignalGenerator()

hops::MHO_SimulatedSignalGenerator::MHO_SimulatedSignalGenerator ( )

inline

~MHO_SimulatedSignalGenerator()

virtual hops::MHO_SimulatedSignalGenerator::~MHO_SimulatedSignalGenerator ( )

inlinevirtual

Member Function Documentation

GenerateSample()

virtual bool hops::MHO_SimulatedSignalGenerator::GenerateSample ( const double &  sample_time, double &  sample  ) const

protectedpure virtual

Generates a sample based on given time and updates it.

Parameters

sample_time	Input sampling time in seconds.
sample	(double&)

Returns

True if sample generation is successful, false otherwise.

Note

This is a virtual function.

Implemented in hops::MHO_SingleToneSignal, and hops::MHO_GaussianWhiteNoiseSignal.

GetSample()

bool hops::MHO_SimulatedSignalGenerator::GetSample ( const double &  sample_time, double &  sample  ) const

inline

Getter for sample.

Parameters

sample_time	Input time for which to retrieve the sample
sample	(double&)

Returns

True if successful, false otherwise

GetSamplingFrequency()

virtual double hops::MHO_SimulatedSignalGenerator::GetSamplingFrequency ( ) const

inlinevirtual

Getter for sampling frequency.

Returns

The current sampling frequency as a double.

Note

This is a virtual function.

Initialize()

virtual void hops::MHO_SimulatedSignalGenerator::Initialize ( )

pure virtual

Function Initialize.

Note

This is a virtual function.

Implemented in hops::MHO_GaussianWhiteNoiseSignal, and hops::MHO_SingleToneSignal.

SetSamplingFrequency()

virtual void hops::MHO_SimulatedSignalGenerator::SetSamplingFrequency ( double  sample_freq )

inlinevirtual

Setter for sampling frequency.

Parameters

sample_freq

Input sampling frequency in Hertz

Note

This is a virtual function.

Member Data Documentation

fSamplingFrequency

double hops::MHO_SimulatedSignalGenerator::fSamplingFrequency

protected

---

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

• MHO_SimulatedSignalGenerator.hh