Form Class Reference

#include <Form.hpp>

Inheritance diagram for Form:

Public Member Functions
virtual void	writeQuantity (const ProbeFormBridge *bridge) 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
	Form ()
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 = SimulationItem
using	ItemType = Form

Friends
class	ItemRegistry

Detailed Description

Form is the abstract base class for simulation item classes that describe how a given quantity should be probed. Refer to the ProbeFormBridge class for more information.

Constructor & Destructor Documentation

Form()

Form::Form ( )

inlineprotected

Default constructor for abstract Item subclass Form : "a probe form" .

Member Function Documentation

writeQuantity()

virtual void Form::writeQuantity ( const ProbeFormBridge *  bridge ) const

pure virtual

This function causes the form to output one or more files for the quantity being probed according to the information provided by the specified ProbeFormBridge instance. The function must be implemented by each subclass.

Implemented in AllSkyProjectionForm, AtPositionsForm, DefaultCutsForm, LinearCutForm, MeridionalCutForm, ParallelProjectionForm, PerCellForm, and PlanarCutsForm.

---

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

• Form.hpp