hops::MHO_SingleToneSignal Class Reference

#include <MHO_SingleToneSignal.hh>

Inheritance diagram for hops::MHO_SingleToneSignal:

Public Member Functions
	MHO_SingleToneSignal ()
	~MHO_SingleToneSignal ()
virtual void	Initialize ()
	Function Initialize. More...
void	SetPhaseOffset (double phase_offset)
	Setter for phase offset. More...
void	SetToneFrequency (double tone_freq)
	Setter for tone frequency. 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 using sine wave formula based on input time and frequency. More...

Protected Attributes
double	fPhaseOffset
double	fToneFrequency
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_SingleToneSignal()

hops::MHO_SingleToneSignal::MHO_SingleToneSignal

(

)

~MHO_SingleToneSignal()

hops::MHO_SingleToneSignal::~MHO_SingleToneSignal

(

)

Member Function Documentation

GenerateSample()

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

overrideprotectedvirtual

Generates a sample using sine wave formula based on input time and frequency.

Parameters

!sample_time	Parameter description
sample	(double&)

Returns

True indicating successful generation of the sample.

Note

This is a virtual function.

Parameters

sample_time

sample_time

Implements hops::MHO_SimulatedSignalGenerator.

Initialize()

virtual void hops::MHO_SingleToneSignal::Initialize ( )

inlinevirtual

Function Initialize.

Note

This is a virtual function.

Implements hops::MHO_SimulatedSignalGenerator.

SetPhaseOffset()

void hops::MHO_SingleToneSignal::SetPhaseOffset ( double  phase_offset )

inline

Setter for phase offset.

Parameters

phase_offset

New phase offset value to be applied

SetToneFrequency()

void hops::MHO_SingleToneSignal::SetToneFrequency ( double  tone_freq )

inline

Setter for tone frequency.

Parameters

tone_freq

Frequency value in Hertz

Member Data Documentation

fPhaseOffset

double hops::MHO_SingleToneSignal::fPhaseOffset

protected

fToneFrequency

double hops::MHO_SingleToneSignal::fToneFrequency

protected

---

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

• MHO_SingleToneSignal.hh
• MHO_SingleToneSignal.cc