noise::NoiseGenerator Class Reference

Abstract base class for noise generators. More...

#include "noise_generators.h"

Inheritance diagram for noise::NoiseGenerator:

Public Member Functions
	NoiseGenerator ()=default
virtual	~NoiseGenerator ()=default
	NoiseGenerator (const NoiseGenerator &)=delete
NoiseGenerator &	operator= (const NoiseGenerator &)=delete
	NoiseGenerator (NoiseGenerator &&)=delete
NoiseGenerator &	operator= (NoiseGenerator &&)=delete
virtual RealType	getSample ()=0
	Pure virtual method to generate a noise sample.

Detailed Description

Abstract base class for noise generators.

Definition at line 30 of file noise_generators.h.

Constructor & Destructor Documentation

NoiseGenerator() [1/3]

noise::NoiseGenerator::NoiseGenerator ( )

default

~NoiseGenerator()

virtual noise::NoiseGenerator::~NoiseGenerator ( )

virtualdefault

NoiseGenerator() [2/3]

noise::NoiseGenerator::NoiseGenerator ( const NoiseGenerator &  )

delete

NoiseGenerator() [3/3]

noise::NoiseGenerator::NoiseGenerator ( NoiseGenerator &&  )

delete

Member Function Documentation

getSample()

virtual RealType noise::NoiseGenerator::getSample ( )

pure virtual

Pure virtual method to generate a noise sample.

Returns

A noise sample of type RealType.

Implemented in noise::WgnGenerator, noise::GammaGenerator, noise::MultirateGenerator, and noise::ClockModelGenerator.

operator=() [1/2]

NoiseGenerator & noise::NoiseGenerator::operator= ( const NoiseGenerator &  )

delete

operator=() [2/2]

NoiseGenerator & noise::NoiseGenerator::operator= ( NoiseGenerator &&  )

delete

---

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

• packages/libfers/src/noise/noise_generators.h