Manager for SD description in XML "model" files. More...

#include <SModelsXMLManager.h>

Inheritance diagram for sdet::SModelsXMLManager:

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
Status	GetData (utl::TabulatedFunction &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const

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

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

template<typename T >
VManager::Status	InternalGetData (T &returnData, const string &componentProperty, const string &componentName, const IndexMap &componentIndex) const

bool	IsInitialized () const

void	SetName (const std::string &name)

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

virtual	~SModelsXMLManager ()

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 Types
typedef std::map< std::string, IndexMap >	IndexIndexMap

Private Member Functions
void	FillMaps ()

utl::Branch	FindBranch (const std::string &property, const std::string &modelType, const IndexMap &componentIndex) const

virtual Status	GenericGetData (Handle &returnData, const std::string &component, const std::string &property, const IndexMap &index) const

template<typename T >
Status	InternalGetData (T &returnData, const std::string &componentProperty, const std::string &componentName, const IndexMap &componentIndex) const

Private Attributes
IndexIndexMap	fAllStationsModelMap

std::map< std::string, IndexIndexMap >	fStationModelMap

Detailed Description

Manager for SD description in XML "model" files.

This manager reads XML files containing SD description information which is arranged into so-called models. Information in a "model" may apply to more than 1 station. Using model-based description reduces the amount of redundant information one has to type in and keeps XML files more manageable.

Author: T. Paul; D. Veberic

Date: 04 Feb 2003; 22 Jun 2005 DV update

Definition at line 37 of file SModelsXMLManager.h.

Member Typedef Documentation

typedef std::map<std::string, IndexMap> sdet::SModelsXMLManager::IndexIndexMap

private

Definition at line 103 of file SModelsXMLManager.h.

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

virtual sdet::SModelsXMLManager::~SModelsXMLManager ( )

inlinevirtual

Definition at line 40 of file SModelsXMLManager.h.

Member Function Documentation

template<typename T >

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

inlineprotectedinherited

Definition at line 347 of file VManager.h.

void SModelsXMLManager::FillMaps ( )

private

Definition at line 276 of file SModelsXMLManager.cc.

References utl::Branch::GetChild(), utl::Branch::GetFirstChild(), and utl::Branch::GetNextSibling().

Branch SModelsXMLManager::FindBranch	(	const std::string &	property,
		const std::string &	modelType,
		const IndexMap &	componentIndex
	)		const

private

Find Branch in DOM where the property data for model modelType for station stationId resides. At the moment, we only use the station index. In the future, if the models are also split up at the PMT level, it will be necessary to add another index to this method. This is not likely, though, since it would be a bit strange to put, for example, PMT's of three different manufacturers in the same tank.

Definition at line 108 of file SModelsXMLManager.cc.

References ERROR, det::if(), and INFO.

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.

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

privatevirtual

In the new interface, every manager has to implement only this method Since the reference to the return data is passed around with a void pointer, for easier identification of the wanted object typeIdName string is also passed around. In the manager code you can easily identifiy with what object the public templated GetData (above) was called with e.g.

if (returnData.Is<TPCInfo>()) {
  TPCInfo& tpcInfo = returnData.Get<TPCInfo>();
  ... fill tpcInfo ...
  return eFound;
} else
  return eNotFound;

Implements det::VManager.

Definition at line 349 of file SModelsXMLManager.cc.

References det::VManager::Handle::Get(), utl::Branch::Get(), and det::VManager::Handle::Is().

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

virtual

Data to be returned as a tabulated function must be specified with tags indicating the ordinate values, abscissa values, and (optionally) a scale factor for the abscissa values, with the nomenclature indicated in this example:

<myTabulatedData>
  <x> 1 2 3 </x>  <!-- ordinate values -->
  <y> 1 4 6 </y>  <!-- abscissa values -->
  <scaleY unit="meter"> 10 <scaleY> <!-- scale all abscissa values by 10 m -->
<myTabulatedData/>

Implements det::VManager.

Definition at line 53 of file SModelsXMLManager.cc.

References utl::Branch::GetChild(), utl::Branch::GetData(), and utl::TabulatedFunction::PushBack().

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

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 SModelsXMLManager::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 21 of file SModelsXMLManager.cc.

References fwk::CoordinateSystemRegistry::Init().

template<typename T >

VManager::Status sdet::SModelsXMLManager::InternalGetData	(	T &	returnData,
		const string &	componentProperty,
		const string &	componentName,
		const IndexMap &	componentIndex
	)		const

Definition at line 34 of file SModelsXMLManager.cc.

References utl::Branch::GetData().

template<typename T >

Status sdet::SModelsXMLManager::InternalGetData	(	T &	returnData,
		const std::string &	componentProperty,
		const std::string &	componentName,
		const IndexMap &	componentIndex
	)		const

private

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

componentProperty = "quantumEfficiency"
componentName = "PMT"
componentIndex["stationId"] = "57"
componentIndex["PMT"] = "3"

Definition at line 231 of file VManager.h.

References det::VManager::fReportingErrors.

Member Data Documentation

IndexIndexMap sdet::SModelsXMLManager::fAllStationsModelMap

private

Definition at line 106 of file SModelsXMLManager.h.

std::set<std::string> det::VManager::fAvailableComponents

protectedinherited

Definition at line 362 of file VManager.h.

Referenced by atm::AAerosolSQLManager::AAerosolSQLManager(), atm::ACloudSQLManager::ACloudSQLManager(), atm::ALidarSQLManager::ALidarSQLManager(), atm::ACloudSQLManager::GetDBResFundamental(), atm::ALidarSQLManager::GetDBResFundamental(), atm::AAerosolSQLManager::GetDBResFundamental(), atm::ALidarSQLManager::GetDBResVector(), and atm::AAerosolSQLManager::GetDBResVector().

utl::Branch det::VManager::fBranch

protectedinherited

Definition at line 360 of file VManager.h.

Referenced by det::XXMLManager< Info >::FindRoot(), det::XXMLManager< Info >::ConfigHandler< AllowMultiConfig, dummy >::for(), and det::XXMLManager< Info >::ConfigHandler< false, dummy >::Handle().

bool det::VManager::fIsInitialized = false

mutableprotectedinherited

Definition at line 354 of file VManager.h.

Referenced by det::VManager::IsInitialized().

bool det::VManager::fReportingErrors = false

protectedinherited

Definition at line 356 of file VManager.h.

Referenced by det::VManager::IsReportingErrors(), and det::VManager::SetReportingErrors().

std::map<std::string, IndexIndexMap> sdet::SModelsXMLManager::fStationModelMap

private

Definition at line 104 of file SModelsXMLManager.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation