#include <SpecialtyWavelengthProbe.hpp>
Public Member Functions | |
double | wavelength () const |
Range | wavelengthRange () const override |
![]() | |
ProbeAfter | probeAfter () const |
![]() | |
string | itemName () const override |
int | iter () const |
string | probeName () const |
void | probePrimary (int iter) |
void | probeRun () |
void | probeSecondary (int iter) |
void | probeSetup () |
![]() | |
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 |
![]() | |
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 |
![]() | |
virtual WavelengthGrid * | materialWavelengthGrid () const |
![]() | |
virtual | ~WavelengthRangeInterface () |
virtual Range | wavelengthRange () const =0 |
Protected Member Functions | |
SpecialtyWavelengthProbe () | |
![]() | |
SpecialtyWhenProbe () | |
When | when () const override |
![]() | |
SpecialtyProbe () | |
![]() | |
Probe () | |
virtual void | initialize () |
virtual void | probe ()=0 |
virtual When | when () const |
![]() | |
SimulationItem () | |
virtual bool | offersInterface (const std::type_info &interfaceTypeInfo) const |
virtual void | setupSelfAfter () |
virtual void | setupSelfBefore () |
![]() | |
Item () | |
![]() | |
MaterialWavelengthRangeInterface () | |
![]() | |
WavelengthRangeInterface () | |
Private Types | |
using | BaseType = SpecialtyWhenProbe |
using | ItemType = SpecialtyWavelengthProbe |
Private Attributes | |
double | _wavelength |
Friends | |
class | ItemRegistry |
Additional Inherited Members | |
![]() | |
enum class | ProbeAfter : int { Setup , Run } |
![]() | |
enum class | When { Setup , Run , Primary , Secondary } |
SpecialtyWavelengthProbe is a base class for probes that require a configurable wavelength property. It implements the MaterialWavelengthRangeInterface to indicate that wavelength-dependent material properties may be required for the configured wavelength.
This class derives from the SpecialtyWhenProbe class because all subclasses happen to need the option for the user to decide whether the probe should be performed after setup or after the full simulation run.
|
inlineprotected |
Default constructor for abstract Item subclass SpecialtyWavelengthProbe : "a specialty wavelength probe" .
|
inline |
This function returns the value of the discoverable double property wavelength : "the wavelength at which to determine the optical depth" .
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 "0.55 micron" .
|
overridevirtual |
This function returns a wavelength range corresponding to the user-configured wavelength, indicating that wavelength-dependent material properties may be required for this wavelength.
Implements WavelengthRangeInterface.