SpecialtyWhenProbe Class Reference

#include <SpecialtyWhenProbe.hpp>

Inheritance diagram for SpecialtyWhenProbe:

Public Types
enum class	ProbeAfter : int { Setup , Run }

Public Member Functions
ProbeAfter	probeAfter () const
Public Member Functions inherited from Probe
string	itemName () const override
int	iter () const
string	probeName () const
void	probePrimary (int iter)
void	probeRun ()
void	probeSecondary (int iter)
void	probeSetup ()
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
	SpecialtyWhenProbe ()
When	when () const override
Protected Member Functions inherited from SpecialtyProbe
	SpecialtyProbe ()
Protected Member Functions inherited from Probe
	Probe ()
virtual void	initialize ()
virtual void	probe ()=0
virtual When	when () const
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 = SpecialtyProbe
using	ItemType = SpecialtyWhenProbe

Private Attributes
ProbeAfter	_probeAfter

Friends
class	ItemRegistry

Additional Inherited Members
Protected Types inherited from Probe
enum class	When { Setup , Run , Primary , Secondary }

Detailed Description

SpecialtyWhenProbe is a base class for specialty probes that allow the user to decide whether the probe should be performed after setup or after the full simulation run.

Properties of sub-types of this type are listed in user interfaces somewhere in between the properties of this type.

Member Enumeration Documentation

ProbeAfter

enum class SpecialtyWhenProbe::ProbeAfter : int

strong

The enumeration type indicating when probing occurs.

Setup : "after setup" .

Run : "after the complete simulation run" .

Constructor & Destructor Documentation

SpecialtyWhenProbe()

SpecialtyWhenProbe::SpecialtyWhenProbe ( )

inlineprotected

Default constructor for abstract Item subclass SpecialtyWhenProbe : "a specialty when probe" .

Member Function Documentation

probeAfter()

SpecialtyWhenProbe::probeAfter ( ) const

inline

This function returns the value of the discoverable ProbeAfter enumeration property probeAfter : "perform the probe after" .

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

This property is displayed only if the Boolean expression "DynamicState" evaluates to true after replacing the names by true or false depending on their presence.

when()

When SpecialtyWhenProbe::when ( ) const

overrideprotectedvirtual

This function returns an enumeration indicating when probing for this probe should be performed corresponding to the configured value of the probeAfter property.

Reimplemented from Probe.

---

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

• SpecialtyWhenProbe.hpp