Manager to return station positions for array defined in shower coordinates. More...

#include "sdet/SDenseStationListXMLManager.h"

Inheritance diagram for sdet::SDenseStationListXMLManager:

Classes
class	DenseStations

Public Types
typedef std::map< std::string, std::string >	IndexMap

enum	Status { eFound, eNotFound }
	Specifies success or (eventually) various possible failure modes. More...

Public Member Functions
virtual Status	GetData (double &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (int &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (bool &, const std::string &componentProperty, const std::string &componentName, const VManager::IndexMap &) const

virtual Status	GetData (std::string &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::vector< double > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::vector< int > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::vector< std::string > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::vector< bool > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::list< double > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::list< int > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::list< std::string > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::list< std::pair< int, int >> &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (utl::TabulatedFunction &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::map< int, utl::TabulatedFunction > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (utl::TabulatedFunctionComplexLgAmpPhase &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::map< std::string, double > &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const =0

virtual Status	GetData (std::vector< std::vector< int >> &, const std::string &componentProperty, const std::string &componentName, const VManager::IndexMap &) const

virtual Status	GetData (std::map< unsigned int, int > &, const std::string &componentProperty, const std::string &componentName, const VManager::IndexMap &) const

Status	GetData (Handle &returnData, const std::string &component, const std::string &property, const IndexMap &index=IndexMap()) const
	new data accessor More...

const std::string &	GetName () const

virtual void	Init (const std::string &configLink)
	Manager Initialization. configLink is the CentralConfig hook for the configuration file. More...

bool	IsInitialized () const

	SDenseStationListXMLManager ()=default

void	SetName (const std::string &name)

void	SetReportingErrors (const bool flag=true)
	Generic data accessors. More...

	VMANAGER_GETDATA_DECLARE (int)

	VMANAGER_GETDATA_DECLARE (double)

	VMANAGER_GETDATA_DECLARE (std::string)

	VMANAGER_GETDATA_DECLARE (std::vector< int >)

	VMANAGER_GETDATA_DECLARE (std::vector< bool >)

virtual	~SDenseStationListXMLManager ()=default

Static Public Member Functions
template<typename T >
static T	FindComponent (const std::string &componentName, const IndexMap &componentIndex)

template<typename T , typename U >
static T	FindComponent (const std::string &componentName, const U &defaultValue, const IndexMap &componentIndex)

static std::string	QueryInfoMessage (const Handle &returnData, const std::string &component)

static std::string	QueryInfoMessage (const Handle &returnData, const std::string &component, const std::string &property, const IndexMap &index)

static std::string	QueryInfoMessage (const std::string &componentProperty, const std::string &componentName)

static std::string	QueryInfoMessage (const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex)

Protected Member Functions
template<typename T >
void	AddAvailability (const std::string &component)

void	FindConfig (const std::string &configLink)
	Locate the configuration file in CentralConfig and make a Reader for it. More...

bool	IsReportingErrors () const

std::string	NotImplementedMessage (const std::string &type, const std::string &componentProperty, const std::string &componentName) const

Protected Attributes
std::set< std::string >	fAvailableComponents

utl::Branch	fBranch

bool	fIsInitialized = false

bool	fReportingErrors = false

Private Member Functions
void	GetFullStationList (std::vector< int > &returnData) const

bool	IsDense (const IndexMap &compIndex) const

Private Attributes
VMANAGER_GETDATA_HANDLE_DENIED std::set< int >	fDenseStationList

DenseStations	fDenseStations

std::string	fFirstComponentProperty

std::string	fFirstStationId

Detailed Description

Manager to return station positions for array defined in shower coordinates.

This manager reads a configuration file defining tank locations in the plane perpindicular to the shower axis, and projects them onto the ground. As an example, this allows one to define a ring of stations which will be located, say, 1000 meters from the core in the plane perpindicular to the shower axis (so-called "dense" array), and superimpose that dense array onto the actual array geometry.

Unlike earlier dense array generators implemented as modules, with this manager-based dense array generator, you can run as many showers per event as you like. The manager has access to the shower geometry, and so is able to produce the proper dense array geometry for each shower in the event.

For an example of running a simulated shower using a dense array, see DenseArraySimulation example in /path-to-offline-installation/share/auger-offline/doc/DenseArraySimulation.

For an example of generating a dense station list, see the GenerateDenseArrayNS::GenerateDenseArray tutorial.

Author: T. Paul; D. Veberic

Date: 10 Jan 2006; 12 Jan 2007 DV update

Definition at line 42 of file SDenseStationListXMLManager.h.

Member Typedef Documentation

typedef std::map<std::string, std::string> det::VManager::IndexMap

inherited

Definition at line 133 of file VManager.h.

Member Enumeration Documentation

enum det::VManager::Status

inherited

Specifies success or (eventually) various possible failure modes.

Various failure modes to be specified (for example, failure to connect to db, faiure to find db record, failure to find table name, etc

Enumerator
eFound
eNotFound

Definition at line 127 of file VManager.h.

Constructor & Destructor Documentation

sdet::SDenseStationListXMLManager::SDenseStationListXMLManager ( )

default

virtual sdet::SDenseStationListXMLManager::~SDenseStationListXMLManager ( )

virtualdefault

Member Function Documentation

template<typename T >

void det::VManager::AddAvailability ( const std::string & component )

inlineprotectedinherited

Definition at line 347 of file VManager.h.

template<typename T >

static T det::VManager::FindComponent	(	const std::string &	componentName,
		const IndexMap &	componentIndex
	)

inlinestaticinherited

Definition at line 307 of file VManager.h.

References ERROR.

template<typename T , typename U >

static T det::VManager::FindComponent	(	const std::string &	componentName,
		const U &	defaultValue,
		const IndexMap &	componentIndex
	)

inlinestaticinherited

Definition at line 322 of file VManager.h.

void det::VManager::FindConfig ( const std::string & configLink )

protectedinherited

Locate the configuration file in CentralConfig and make a Reader for it.

Definition at line 25 of file VManager.cc.

References ERROR, and WARNING.

virtual Status det::VManager::GetData	(	double &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, fdet::FdUpTimeFileManager, fdet::FdUpTimeSQLManager, and fwk::TestSQLManager.

Referenced by atm::AerosolDB::AerosolDB(), atm::MolecularZone::CacheLayers(), fdet::Telescope::CachePixelCloudData(), atm::VZone::CacheSlices(), atm::AerosolDB::CacheZones(), atm::LidarDB::CacheZones(), atm::MolecularDB::CacheZones(), cdet::CDetector::FetchStationGroups(), atm::GOESDB::GetAllCloudProbabilities(), rdet::AntennaType::GetAntennaData(), fdet::Camera::GetCameraChannelData(), fdet::Camera::GetCameraData(), fdet::Camera::GetCameraDataDiaphragm(), fdet::Camera::GetCameraPixelData(), fdet::Channel::GetChannelData(), rdet::Channel::GetChannelData(), atm::LidarZone::GetCloudData(), fdet::Corrector::GetCorrectorData(), rdet::RDetector::GetDetectorData(), fdet::Diaphragm::GetDiaphragmData(), fdet::Eye::GetEyeData(), fdet::FDetector::GetFDetectorData(), fdet::Filter::GetFilterData(), fdet::FDetector::GetFullEyeList(), rdet::RDetector::GetFullStationList(), cdet::CDetector::GetFullStationList(), atm::VZoneSlice::GetLambdaSliceData(), atm::MolecularLayer::GetLayerData(), fdet::Mirror::GetMirrorData(), fdet::MirrorSegment::GetMirrorSegmentData(), fdet::Pixel::GetPixelData(), fdet::Pixel::GetPixelDataDiaphragm(), cdet::Station::GetRPCData(), sdet::Scintillator::GetScintillatorData(), atm::VZoneSlice::GetSliceData(), rdet::RSimulationStationListManager::GetSourceType(), cdet::CDetector::GetStation(), rdet::Station::GetStationData(), cdet::Station::GetStationData(), fdet::Telescope::GetTelescopeData(), atm::GOESDB::HasData(), atm::LidarDB::LidarDB(), atm::LidarZone::LidarZone(), atm::MolecularDB::MolecularDB(), atm::MolecularZone::MolecularZone(), rdet::Station::SetListOfChannelIds(), and det::ComponentGroup< P, C, Creator, ManagerProvider >::Update().

virtual Status det::VManager::GetData	(	int &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, fdet::FdUpTimeFileManager, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	bool &	,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const VManager::IndexMap &
	)		const

inlinevirtualinherited

Definition at line 241 of file VManager.h.

virtual Status det::VManager::GetData	(	std::string &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::vector< double > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::vector< int > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::vector< std::string > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::vector< bool > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::list< double > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::list< int > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::list< std::string > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::list< std::pair< int, int >> &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

virtual Status det::VManager::GetData	(	utl::TabulatedFunction &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, sdet::SModelsXMLManager, cdet::CModelsXMLManager, cdet::COverrideXMLManager, fdet::FTelescopeListXMLManager, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::map< int, utl::TabulatedFunction > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	utl::TabulatedFunctionComplexLgAmpPhase &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::map< std::string, double > &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

pure virtualinherited

Implemented in det::ManagerRegister, and fwk::TestSQLManager.

virtual Status det::VManager::GetData	(	std::vector< std::vector< int >> &	,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const VManager::IndexMap &
	)		const

inlinevirtualinherited

Definition at line 255 of file VManager.h.

virtual Status det::VManager::GetData	(	std::map< unsigned int, int > &	,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const VManager::IndexMap &
	)		const

inlinevirtualinherited

Definition at line 256 of file VManager.h.

Status det::VManager::GetData	(	Handle &	returnData,
		const std::string &	component,
		const std::string &	property,
		const IndexMap &	index = `IndexMap()`
	)		const

inlineinherited

new data accessor

Any property of the detector is supposed to be accessible through this interface. Interface specifies the name of the property and the component to which it belongs, together with a map of (index name, index value) identifying the specific instance of the component. For example, to request the quantum efficiency of PMT 3 in station 57, one would have

component = "PMT"
property = "quantumEfficiency"
index["stationId"] = "57"
index["PMT"] = "3"

Definition at line 275 of file VManager.h.

References det::VManager::CheckedGetData().

void sdet::SDenseStationListXMLManager::GetFullStationList ( std::vector< int > & returnData ) const

private

Definition at line 275 of file SDenseStationListXMLManager.cc.

const std::string& det::VManager::GetName ( ) const

inlineinherited

Definition at line 330 of file VManager.h.

References det::VManager::fName.

Referenced by det::VManager::CheckedGetData(), det::ManagerRegister::GenericGetData(), det::ManagerRegister::GetManagerData(), and det::ManagerBuilderRegisterEntry::ManagerBuilderRegisterEntry().

void sdet::SDenseStationListXMLManager::Init ( const std::string & configLink )

virtual

Manager Initialization. configLink is the CentralConfig hook for the configuration file.

This method instructs the manager to initialize itself. In the case of a manager which fetches data from an XML file, configuration involves getting the link to the appropriate configuration file from the CentralConfig and parsing the file to create a DOM or some other representation of the data in memory. For a manager which uses a MySQL database, configuration involves getting the link to the appropriate configuration file from the CentralConfig, then using the instructions in that file to establish a connection to the relevant database.

Note that one might initially think it makes more sense to just initialize managers automatically in their constructors so that developers don't need to remember to explicitly invoke the Init() method. (In fact it worked like this in an earlier version.) The rationale for not having automatic configuration via the constructors is that the configuration can now be delayed until the time that the user specifically requests a particular manager, rather than doing it at the time that the Detector object constructs the Managers. For example, when the user declares his set of desired managers in the ManagerRegister configuration, only those particular Managers will get initialized (though all available Managers will be constructed!). Consider someone who wants to test only the Fluorescence portion of the detector. By requiring explicit invocation of Init() one avoids providing hooks to all the SD related configuration files and databases which aren't even going to be used. Though the SD Managers will be constructed, no attempt will be made to Initialize them until the user specifically requests them by, for example, specifying them in the configuration file for the appropriate ManagerRegister.

Reimplemented from det::VManager.

Definition at line 43 of file SDenseStationListXMLManager.cc.

References fwk::CoordinateSystemRegistry::Init(), and WARNING.

bool sdet::SDenseStationListXMLManager::IsDense ( const IndexMap & compIndex ) const

private

Definition at line 283 of file SDenseStationListXMLManager.cc.

bool det::VManager::IsInitialized ( ) const

inlineinherited

Definition at line 214 of file VManager.h.

References det::VManager::fIsInitialized.

Referenced by det::ManagerRegister::InterpretXML().

bool det::VManager::IsReportingErrors ( ) const

inlineprotectedinherited

Definition at line 338 of file VManager.h.

References det::VManager::fReportingErrors.

Referenced by det::VManager::CheckedGetData(), det::XXMLManager< Info >::FindModelBranch(), det::XXMLManager< Info >::GetDataInternal(), and det::if().

string det::VManager::NotImplementedMessage	(	const std::string &	type,
		const std::string &	componentProperty,
		const std::string &	componentName
	)		const

protectedinherited

Definition at line 47 of file VManager.cc.

string det::VManager::QueryInfoMessage	(	const Handle &	returnData,
		const std::string &	component
	)

staticinherited

Definition at line 108 of file VManager.cc.

References det::VManager::Handle::GetTypeIdName().

Referenced by det::VManager::CheckedGetData(), det::ManagerRegister::GenericGetData(), atm::AAerosolSQLManager::GetDBResFundamental(), atm::AAerosolSQLManager::GetDBResVector(), det::ManagerRegister::GetManagerData(), fdet::Pixel::GetPixelData(), fdet::Pixel::GetPixelDataDiaphragm(), and det::if().

string det::VManager::QueryInfoMessage	(	const Handle &	returnData,
		const std::string &	component,
		const std::string &	property,
		const IndexMap &	index
	)

staticinherited

Definition at line 119 of file VManager.cc.

static std::string det::VManager::QueryInfoMessage	(	const std::string &	componentProperty,
		const std::string &	componentName
	)

inlinestaticinherited

Definition at line 294 of file VManager.h.

string det::VManager::QueryInfoMessage	(	const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)

staticinherited

Definition at line 58 of file VManager.cc.

void det::VManager::SetName ( const std::string & name )

inlineinherited

Definition at line 332 of file VManager.h.

References det::VManager::fName.

Referenced by det::ManagerRegister::InterpretXML().

void det::VManager::SetReportingErrors ( const bool flag = true )

inlineinherited

Generic data accessors.

Any property of the detector is supposed to be accessible through this interface. Interface specifies the name of the property and the component to which it belongs, together with a map of (index name, index value) identifying the specific instance of the component. For example, to request the quantum efficiency of PMT 3 in station 57, one would have