hops::MHO_GaussianWhiteNoiseSignal Class Reference

#include <MHO_GaussianWhiteNoiseSignal.hh>

Inheritance diagram for hops::MHO_GaussianWhiteNoiseSignal:

Public Member Functions
	MHO_GaussianWhiteNoiseSignal ()
	~MHO_GaussianWhiteNoiseSignal ()
virtual void	Initialize () override
	Initializes random number generator and normal distribution for Gaussian white noise signal. More...
void	SetMean (double mean)
	Setter for mean. More...
void	SetRandomSeed (unsigned int seed)
	Setter for random seed. More...
void	SetStandardDeviation (double std_dev)
	Setter for standard deviation. More...
Public Member Functions inherited from hops::MHO_SimulatedSignalGenerator
	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	SetSamplingFrequency (double sample_freq)
	Setter for sampling frequency. More...

Protected Member Functions
virtual bool	GenerateSample (const double &, double &sample) const override
	Generates a sample from Gaussian white noise distribution. More...

Protected Attributes
std::normal_distribution< double > *	fDistribution
std::mt19937 *	fGenerator
double	fMean
std::mt19937::result_type	fSeed
double	fStandardDeviation
Protected Attributes inherited from hops::MHO_SimulatedSignalGenerator
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_GaussianWhiteNoiseSignal()

hops::MHO_GaussianWhiteNoiseSignal::MHO_GaussianWhiteNoiseSignal

(

)

~MHO_GaussianWhiteNoiseSignal()

hops::MHO_GaussianWhiteNoiseSignal::~MHO_GaussianWhiteNoiseSignal

(

)

Member Function Documentation

GenerateSample()

bool hops::MHO_GaussianWhiteNoiseSignal::GenerateSample ( const double &  , double &  sample  ) const

overrideprotectedvirtual

Generates a sample from Gaussian white noise distribution.

Parameters

!sample_time	Parameter description
sample	Output sampled value (reference).

Returns

True if sample generation is successful.

Note

This is a virtual function.

Implements hops::MHO_SimulatedSignalGenerator.

Initialize()

void hops::MHO_GaussianWhiteNoiseSignal::Initialize ( )

overridevirtual

Initializes random number generator and normal distribution for Gaussian white noise signal.

Note

This is a virtual function.

Implements hops::MHO_SimulatedSignalGenerator.

SetMean()

void hops::MHO_GaussianWhiteNoiseSignal::SetMean ( double  mean )

inline

Setter for mean.

Parameters

mean	New mean value to set

SetRandomSeed()

void hops::MHO_GaussianWhiteNoiseSignal::SetRandomSeed ( unsigned int  seed )

inline

Setter for random seed.

Parameters

seed	New seed value to initialize the random number generator.

SetStandardDeviation()

void hops::MHO_GaussianWhiteNoiseSignal::SetStandardDeviation ( double  std_dev )

inline

Setter for standard deviation.

Parameters

std_dev

Input standard deviation value.

Member Data Documentation

fDistribution

std::normal_distribution< double >* hops::MHO_GaussianWhiteNoiseSignal::fDistribution

protected

fGenerator

std::mt19937* hops::MHO_GaussianWhiteNoiseSignal::fGenerator

protected

fMean

double hops::MHO_GaussianWhiteNoiseSignal::fMean

protected

fSeed

std::mt19937::result_type hops::MHO_GaussianWhiteNoiseSignal::fSeed

protected

fStandardDeviation

double hops::MHO_GaussianWhiteNoiseSignal::fStandardDeviation

protected

---

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

• MHO_GaussianWhiteNoiseSignal.hh
• MHO_GaussianWhiteNoiseSignal.cc