LinWavelengthDistribution Class Reference

#include <LinWavelengthDistribution.hpp>

Inheritance diagram for LinWavelengthDistribution:

Public Member Functions
double	generateWavelength () const override
double	probability (double wavelength) const override
Public Member Functions inherited from RangeWavelengthDistribution
double	maxWavelength () const
double	minWavelength () const
Public Member Functions inherited from SimulationItem
template<class T>
T *	find (bool setup=true) const
template<class T>
T *	interface (int levels=-999999, bool setup=true) const
virtual string	itemName () const
void	setup ()
string	typeAndName () const
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef *property, Item *item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const

Protected Member Functions
	LinWavelengthDistribution ()
Protected Member Functions inherited from RangeWavelengthDistribution
	RangeWavelengthDistribution ()
const Range &	range () const
void	setupSelfBefore () override
Protected Member Functions inherited from WavelengthDistribution
	WavelengthDistribution ()
Random *	random () const
void	setupSelfBefore () override
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void	setupSelfAfter ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Friends
class	ItemRegistry

Detailed Description

A LinWavelengthDistribution object represents a (uniform) linear wavelength probability distribution in a wavelength range configured by the user.

Constructor & Destructor Documentation

LinWavelengthDistribution()

LinWavelengthDistribution::LinWavelengthDistribution ( )

inlineprotected

Default constructor for concrete Item subclass LinWavelengthDistribution: "a linear wavelength probability distribution".

Member Function Documentation

generateWavelength()

double LinWavelengthDistribution::generateWavelength ( ) const

overridevirtual

This function draws a random wavelength from the wavelength distribution.

Implements WavelengthDistribution.

probability()

double LinWavelengthDistribution::probability ( double wavelength ) const

overridevirtual

This function returns the probability of the distribution at the given wavelength.

Implements WavelengthDistribution.

---

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

• LinWavelengthDistribution.hpp