#include <RangeWavelengthDistribution.hpp>

Inheritance diagram for RangeWavelengthDistribution:

[legend]

Public Member Functions
double	maxWavelength () const

double	minWavelength () const

Public Member Functions inherited from WavelengthDistribution
virtual double	generateWavelength () const =0

virtual double	probability (double wavelength) const =0

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
	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 ()

virtual void	setupSelfBefore ()

Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = WavelengthDistribution

using	ItemType = RangeWavelengthDistribution

Private Attributes
double	_maxWavelength

double	_minWavelength

Range	_range

Friends
class	ItemRegistry

Detailed Description

RangeWavelengthDistribution is an intermediate abstract class that serves as a base class for wavelength probability distributions that require the user to configure the intrinsic wavelength range. Usually this is because the underlying mathematical function (e.g. uniform, logarithmic) has no natural wavelength range of its own.

The range configured by the user for a RangeWavelengthDistribution object is intersected with the wavelength range of the associated source (obtained through the SourceWavelengthRangeInterface). As a result, the configured minimum and maximum wavelength values can usually be left to their default values (defining a very wide wavelength range).

Constructor & Destructor Documentation

◆ RangeWavelengthDistribution()

RangeWavelengthDistribution::RangeWavelengthDistribution ( )

inlineprotected

Default constructor for abstract Item subclass RangeWavelengthDistribution : "a wavelength probability distribution with a configured wavelength range" .

Member Function Documentation

◆ maxWavelength()

RangeWavelengthDistribution::maxWavelength ( ) const

inline

This function returns the value of the discoverable double property maxWavelength : "the longest wavelength of the wavelength probability distribution" .

This property represents a physical quantity of type "wavelength" .

The minimum value for this property is "1 pm" .

The maximum value for this property is "1 m" .

The default value for this property is given by the conditional value expression "1 m" .

◆ minWavelength()

RangeWavelengthDistribution::minWavelength ( ) const

inline

This function returns the value of the discoverable double property minWavelength : "the shortest wavelength of the wavelength probability distribution" .

This property represents a physical quantity of type "wavelength" .

The minimum value for this property is "1 pm" .

The maximum value for this property is "1 m" .

The default value for this property is given by the conditional value expression "1 pm" .

◆ range()

const Range & RangeWavelengthDistribution::range ( ) const

inlineprotected

This function returns the wavelength range of the wavelength distribution (i.e. the intersection of the external wavelength range and the configured intrinsic wavelength range) as a service to subclasses.

◆ setupSelfBefore()

void RangeWavelengthDistribution::setupSelfBefore ( )

overrideprotectedvirtual

This function determines and caches the wavelength range of the wavelength distribution (i.e. the intersection of the external wavelength range and the configured intrinsic wavelength range) for use by subclasses.

Reimplemented from SimulationItem.

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

RangeWavelengthDistribution.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends