#include <InstrumentSystem.hpp>

Inheritance diagram for InstrumentSystem:

Public Member Functions
WavelengthGrid *	defaultWavelengthGrid () const

void	flush ()

const vector< Instrument * > &	instruments () const

void	write ()

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

void	setupSelfAfter () 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 = SimulationItem

using	ItemType = InstrumentSystem

Private Attributes
WavelengthGrid *	_defaultWavelengthGrid

vector< Instrument * >	_instruments

Friends
class	ItemRegistry

Detailed Description

An InstrumentSystem instance keeps a list of zero or more instruments and an optional default wavelength grid that will be used by an instrument unless it specifies its own wavelength grid. The instruments can be of various nature and do not need to be located at the same observing position.

Constructor & Destructor Documentation

◆ InstrumentSystem()

InstrumentSystem::InstrumentSystem ( )

inlineprotected

Default constructor for concrete Item subclass InstrumentSystem : "an instrument system" .

Member Function Documentation

◆ defaultWavelengthGrid()

InstrumentSystem::defaultWavelengthGrid ( ) const

inline

This function returns the value of the discoverable item property defaultWavelengthGrid : "the default instrument wavelength grid" .

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

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

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

When a value is entered for this property, the names provided by the conditional value expression "defaultWavelengthGrid:DefaultInstrumentWavelengthGrid" are inserted into the name sets used for evaluating Boolean expressions.

◆ flush()

void InstrumentSystem::flush ( )

This function flushes any information buffered during photon packet detection for the complete instrument system. It calls the flush() function for each of the instruments.

◆ instruments()

InstrumentSystem::instruments ( ) const

inline

This function returns the value of the discoverable item list property instruments : "the instruments" .

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

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

◆ setupSelfAfter()

void InstrumentSystem::setupSelfAfter ( )

overrideprotectedvirtual

This function calls the determineSameObserverAsPreceding() function for all instruments in the instrument system except for the first one (because it doesn't have a preceding instrument).

Reimplemented from SimulationItem.

◆ write()

void InstrumentSystem::write ( )

This function writes the recorded data for the complete instrument system to a set of files. It calls the write() function for each of the instruments.

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

InstrumentSystem.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends