#include <LoadDetectorsGroupingFile.h>

Public Member Functions
std::string	getDate ()

std::string	getDescription ()

std::map< int, std::vector< std::string > >	getGroupComponentsMap ()
	Data structures to store XML to Group/Detector conversion map. More...

std::map< int, std::vector< detid_t > >	getGroupDetectorsMap ()

std::map< int, std::string >	getGroupNamesMap ()

std::map< int, std::vector< int > >	getGroupSpectraMap ()

std::string	getInstrumentName ()

bool	isGivenDate ()

bool	isGivenDescription ()

bool	isGivenInstrumentName ()

	LoadGroupXMLFile ()

void	loadXMLFile (const std::string &xmlfilename)

void	setDefaultStartingGroupID (int startgroupid)

Private Member Functions
void	initializeXMLParser (const std::string &filename)
	Initialize XML parser. More...

void	parseXML ()
	Parse XML. More...

Static Private Member Functions
static std::string	getAttributeValueByName (Poco::XML::Node *pNode, const std::string &attributename, bool &found)
	Get attribute value from an XML node. More...

Private Attributes
std::string	m_date
	Date in ISO 8601 for which this grouping is relevant. More...

std::string	m_description
	Grouping description. Empty if not specified. More...

std::map< int, std::vector< std::string > >	m_groupComponentsMap
	Data structures to store XML to Group/Detector conversion map. More...

std::map< int, std::vector< detid_t > >	m_groupDetectorsMap

std::map< int, std::string >	m_groupNamesMap
	Map of group names. More...

std::map< int, std::vector< int > >	m_groupSpectraMap

std::string	m_instrumentName
	Instrument name. More...

Poco::AutoPtr< Poco::XML::Document >	m_pDoc
	XML document loaded. More...

int	m_startGroupID

bool	m_userGiveDate
	Whether date is given by user. More...

bool	m_userGiveDescription
	Whether description is given by user. More...

bool	m_userGiveInstrument
	User-define instrument name. More...

Detailed Description

Definition at line 97 of file LoadDetectorsGroupingFile.h.

Constructor & Destructor Documentation

◆ LoadGroupXMLFile()

Mantid::DataHandling::LoadGroupXMLFile::LoadGroupXMLFile ( )

Definition at line 377 of file LoadDetectorsGroupingFile.cpp.

Member Function Documentation

◆ getAttributeValueByName()

std::string Mantid::DataHandling::LoadGroupXMLFile::getAttributeValueByName	(	Poco::XML::Node *	pNode,
		const std::string &	attributename,
		bool &	found
	)

staticprivate

Get attribute value from an XML node.

Definition at line 566 of file LoadDetectorsGroupingFile.cpp.

References value.

Referenced by parseXML().

◆ getDate()

std::string Mantid::DataHandling::LoadGroupXMLFile::getDate ( )

inline

Definition at line 107 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ getDescription()

std::string Mantid::DataHandling::LoadGroupXMLFile::getDescription ( )

inline

Definition at line 110 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ getGroupComponentsMap()

std::map< int, std::vector< std::string > > Mantid::DataHandling::LoadGroupXMLFile::getGroupComponentsMap ( )

inline

Data structures to store XML to Group/Detector conversion map.

Definition at line 114 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ getGroupDetectorsMap()

std::map< int, std::vector< detid_t > > Mantid::DataHandling::LoadGroupXMLFile::getGroupDetectorsMap ( )

inline

Definition at line 115 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec(), and Mantid::DataHandling::GroupDetectors2::processXMLFile().

◆ getGroupNamesMap()

std::map< int, std::string > Mantid::DataHandling::LoadGroupXMLFile::getGroupNamesMap ( )

inline

Definition at line 118 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ getGroupSpectraMap()

std::map< int, std::vector< int > > Mantid::DataHandling::LoadGroupXMLFile::getGroupSpectraMap ( )

inline

Definition at line 116 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec(), and Mantid::DataHandling::GroupDetectors2::processXMLFile().

◆ getInstrumentName()

std::string Mantid::DataHandling::LoadGroupXMLFile::getInstrumentName ( )

inline

Definition at line 104 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ initializeXMLParser()

void Mantid::DataHandling::LoadGroupXMLFile::initializeXMLParser ( const std::string & filename )

private

Initialize XML parser.

Definition at line 391 of file LoadDetectorsGroupingFile.cpp.

References Mantid::Kernel::Strings::loadFile(), and m_pDoc.

Referenced by loadXMLFile().

◆ isGivenDate()

bool Mantid::DataHandling::LoadGroupXMLFile::isGivenDate ( )

inline

Definition at line 108 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ isGivenDescription()

bool Mantid::DataHandling::LoadGroupXMLFile::isGivenDescription ( )

inline

Definition at line 111 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ isGivenInstrumentName()

bool Mantid::DataHandling::LoadGroupXMLFile::isGivenInstrumentName ( )

inline

Definition at line 105 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec().

◆ loadXMLFile()

void Mantid::DataHandling::LoadGroupXMLFile::loadXMLFile ( const std::string & xmlfilename )

Definition at line 382 of file LoadDetectorsGroupingFile.cpp.

References initializeXMLParser(), and parseXML().

Referenced by Mantid::DataHandling::LoadDetectorsGroupingFile::exec(), and Mantid::DataHandling::GroupDetectors2::processXMLFile().

◆ parseXML()

void Mantid::DataHandling::LoadGroupXMLFile::parseXML ( )

private

Parse XML.

Definition at line 411 of file LoadDetectorsGroupingFile.cpp.

References getAttributeValueByName(), m_date, m_description, m_groupComponentsMap, m_groupDetectorsMap, m_groupNamesMap, m_groupSpectraMap, m_instrumentName, m_pDoc, m_startGroupID, m_userGiveDate, m_userGiveDescription, m_userGiveInstrument, Mantid::Kernel::Strings::parseRange(), and value.

Referenced by loadXMLFile().

◆ setDefaultStartingGroupID()

void Mantid::DataHandling::LoadGroupXMLFile::setDefaultStartingGroupID ( int startgroupid )

inline

Definition at line 102 of file LoadDetectorsGroupingFile.h.

Referenced by Mantid::DataHandling::GroupDetectors2::processXMLFile().

Member Data Documentation

◆ m_date

std::string Mantid::DataHandling::LoadGroupXMLFile::m_date

private

Date in ISO 8601 for which this grouping is relevant.

Definition at line 127 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_description

std::string Mantid::DataHandling::LoadGroupXMLFile::m_description

private

Grouping description. Empty if not specified.

Definition at line 132 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_groupComponentsMap

std::map<int, std::vector<std::string> > Mantid::DataHandling::LoadGroupXMLFile::m_groupComponentsMap

private

Data structures to store XML to Group/Detector conversion map.

Definition at line 139 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_groupDetectorsMap

std::map<int, std::vector<detid_t> > Mantid::DataHandling::LoadGroupXMLFile::m_groupDetectorsMap

private

Definition at line 140 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_groupNamesMap

std::map<int, std::string> Mantid::DataHandling::LoadGroupXMLFile::m_groupNamesMap

private

Map of group names.

Definition at line 145 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_groupSpectraMap

std::map<int, std::vector<int> > Mantid::DataHandling::LoadGroupXMLFile::m_groupSpectraMap

private

Definition at line 141 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_instrumentName

std::string Mantid::DataHandling::LoadGroupXMLFile::m_instrumentName

private

Instrument name.

Definition at line 122 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_pDoc

Poco::AutoPtr<Poco::XML::Document> Mantid::DataHandling::LoadGroupXMLFile::m_pDoc

private

XML document loaded.

Definition at line 137 of file LoadDetectorsGroupingFile.h.

Referenced by initializeXMLParser(), and parseXML().

◆ m_startGroupID

int Mantid::DataHandling::LoadGroupXMLFile::m_startGroupID

private

Definition at line 142 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_userGiveDate

bool Mantid::DataHandling::LoadGroupXMLFile::m_userGiveDate

private

Whether date is given by user.

Definition at line 129 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_userGiveDescription

bool Mantid::DataHandling::LoadGroupXMLFile::m_userGiveDescription

private

Whether description is given by user.

Definition at line 134 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

◆ m_userGiveInstrument

bool Mantid::DataHandling::LoadGroupXMLFile::m_userGiveInstrument

private

User-define instrument name.

Definition at line 124 of file LoadDetectorsGroupingFile.h.

Referenced by parseXML().

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

Framework/DataHandling/inc/MantidDataHandling/LoadDetectorsGroupingFile.h
Framework/DataHandling/src/LoadDetectorsGroupingFile.cpp

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LoadGroupXMLFile()

Member Function Documentation

◆ getAttributeValueByName()

◆ getDate()

◆ getDescription()

◆ getGroupComponentsMap()

◆ getGroupDetectorsMap()

◆ getGroupNamesMap()

◆ getGroupSpectraMap()

◆ getInstrumentName()

◆ initializeXMLParser()

◆ isGivenDate()

◆ isGivenDescription()

◆ isGivenInstrumentName()

◆ loadXMLFile()

◆ parseXML()

◆ setDefaultStartingGroupID()

Member Data Documentation

◆ m_date

◆ m_description

◆ m_groupComponentsMap

◆ m_groupDetectorsMap

◆ m_groupNamesMap

◆ m_groupSpectraMap

◆ m_instrumentName

◆ m_pDoc

◆ m_startGroupID

◆ m_userGiveDate

◆ m_userGiveDescription

◆ m_userGiveInstrument