XML parser for Marlin steering files. More...

#include <XMLParser.h>

Inheritance diagram for marlin::XMLParser:

Classes
class	LCTokenizer
	Helper class for XMLParser. More...

Public Member Functions
	XMLParser (const std::string &fileName, bool forCCheck=false)

virtual	~XMLParser ()

void	setCmdLineParameters (const CommandLineParametersMap &cmdlineparams)
	set command line parameters More...

void	parse ()
	Parse the input file. More...

std::shared_ptr< StringParameters >	getParameters (const std::string &sectionName) const
	Return the StringParameters for the section as read from the xml file. More...

void	write (const std::string &filen) const
	Write the parsed XML tree in an other file. More...

Public Member Functions inherited from marlin::IParser
virtual	~IParser ()

Protected Member Functions
void	parametersFromNode (TiXmlNode section, std::map< std::string, std::string > &constants, std::pair< unsigned, unsigned > typeCount=0)
	Extracts all parameters from the given node and adss them to the current StringParameters object. More...

const char *	getAttribute (TiXmlNode *node, const std::string &name)
	Return named attribute - throws ParseException if attribute doesn't exist. More...

void	replacegroups (TiXmlNode *section)
	Helper method - replaces all <group> tag with corresponding <processor> tags. More...

TiXmlNode *	findElement (TiXmlNode *node, const std::string &type, const std::string &attribute, const std::string &value)
	Helper method - finds child element of node with given type and attribute value. More...

void	processconditions (TiXmlNode *current, const std::string &conditions)
	Helper method - recursively moves processors from <if> tags to top level (<execute>) and adds corresponding conditions attribute. More...

void	processIncludeElements (TiXmlElement *element, const std::map< std::string, std::string > &constants)
	Helper method - recursively replace all with the corresponding file content. More...

void	processIncludeElement (TiXmlElement *element, const std::map< std::string, std::string > &constants, TiXmlDocument &document)

void	processConstants (TiXmlNode *node, std::map< std::string, std::string > &constants)

void	processConstant (TiXmlElement *element, std::map< std::string, std::string > &constants)

std::string &	performConstantReplacement (std::string &value, const std::map< std::string, std::string > &constants)

void	checkForNestedIncludes (const TiXmlNode *node)

Protected Attributes
StringParametersMap	_map {}

StringParameters *	_current

std::unique_ptr< TiXmlDocument >	_doc {}

std::string	_fileName

Private Member Functions
	XMLParser ()=delete

	XMLParser (const marlin::XMLParser &)=delete

XMLParser &	operator= (const marlin::XMLParser &)=delete

Private Attributes
bool	_forCCheck

CommandLineParametersMap	_cmdlineparams {}

Detailed Description

XML parser for Marlin steering files.

Marlin XML steering files have the following form (use Marlin -x > example.xml to generate a template steering file):

 <marlin>
  <execute>   [1]
     ...  // the processors and processor groups to be executed
  </execute>
  <global>    [1]
     ...  // global parameter section
  </global>
  <processor> [n]
     ...  // definition of the processor and its parameters
  </processor>
  <group> [m]   
     ...    // a group of processors
    <processor> [k]
     ...  // definition of the processor and its parameters
    </processor>
  </group> 
 </marlin>

where the numbers enclosed in "[]" denote how many elements of the given type are allowed or required, n,m,k = [0,1,2,...].

The <execute/> section defines the processors that are to be called in the order specified. The Processor::processEvent() method is only called if the relevant condition (<if condition="A"/>) is fullfilled. Conditions can be arbitrary logical expressions formed of [!,(,&&,||,),value], e.g.
( A && ( B || !C ) ) || ( !B && D ), where the keys A,B,C,D can be either procesor names (Processor::setReturnValue(bool val) ) or processor names followed by a string ( Processor::setReturnValue(const std::string &name, bool val) ).
In the following example the Pflow processor is only called for events where the EventSelection processor has returnd true and the TwoJetAnalysis is is then in turn only called for events identified as having tow jets by the Pflow processor

 <execute>
  <processor name="MyAIDAProcessor"/>
  <processor name="EventSelection"/>  
  <if condition="EventSelection">
    <processor name="Pflow"/>  
    <if condition="Pflow.TwoJet">
      <group name="TwoJetAnalysis"/>
    </if>
  </if>
  <processor name="MyLCIOOutputProcessor"/>  
 </execute>

The <global> section defines the global paramters:

 <global>
   <parameter name="LCIOInputFiles">dd_rec.slcio </parameter>
   <parameter name="LCIOInputFiles">../tt500_all_set1_12.slcio </parameter>
   <parameter name="MaxRecordNumber" value="5001" />  
   <parameter name="SupressCheck" value="false" />  
 </global>

Parameters can be either specified as the content of the <parameter/> tag or in the value-attribute of the tag !

The <processor name="..." type="..." > section defines the processor and its parameters, where name and type are required attibutes, e.g.

 <processor name="EventSelection" type="SelectionProcessor">
   <parameter name="EnergyCut" type="float">50.0</parameter>
 </processor>

Note: the parameter's type-attribute is optional.

Processor sections can be enclosed in a <group/> tag, where parameters defined outside any <processor/> tag are group parameters valid for all processors in the group, .e.g.

 <group>
   <parameter name="PtCut" value="0.03">
   <processor name="TrackFinding" type="TrackFinder"/>
   <processor name="TrackFitting" type="KalmanProcessor">
     <parameter name="UseDAF" value="true">
   <processor>
 </group>

Author: F. Gaede, DESY

Version

Id:: XMLParser.h,v 1.7 2007-07-18 12:43:09 engels Exp

Definition at line 106 of file XMLParser.h.

Constructor & Destructor Documentation

marlin::XMLParser::XMLParser	(	const std::string &	fileName,
		bool	forCCheck = `false`
	)

Definition at line 17 of file XMLParser.cc.

marlin::XMLParser::~XMLParser ( )

virtual

Definition at line 21 of file XMLParser.cc.

marlin::XMLParser::XMLParser ( )

privatedelete

marlin::XMLParser::XMLParser ( const marlin::XMLParser & )

privatedelete

Member Function Documentation

void marlin::XMLParser::checkForNestedIncludes ( const TiXmlNode * node )

protected

Definition at line 692 of file XMLParser.cc.

References TiXmlNode::FirstChildElement(), TiXmlNode::GetDocument(), TiXmlNode::NextSiblingElement(), std::stringstream::str(), and TiXmlNode::Value().

Referenced by processIncludeElement().

TiXmlNode * marlin::XMLParser::findElement	(	TiXmlNode *	node,
		const std::string &	type,
		const std::string &	attribute,
		const std::string &	value
	)

protected

Helper method - finds child element of node with given type and attribute value.

Definition at line 946 of file XMLParser.cc.

References TiXmlElement::Attribute(), TiXmlNode::IterateChildren(), and TiXmlNode::ToElement().

Referenced by replacegroups().

const char * marlin::XMLParser::getAttribute	(	TiXmlNode *	node,
		const std::string &	name
	)

protected

Return named attribute - throws ParseException if attribute doesn't exist.

Definition at line 315 of file XMLParser.cc.

References _fileName, TiXmlElement::Attribute(), std::string::c_str(), std::stringstream::str(), TiXmlNode::ToElement(), and TiXmlNode::Value().

Referenced by parametersFromNode(), parse(), processconditions(), and replacegroups().

std::shared_ptr< StringParameters > marlin::XMLParser::getParameters ( const std::string & sectionName ) const

virtual

Return the StringParameters for the section as read from the xml file.

Implements marlin::IParser.

Definition at line 511 of file XMLParser.cc.

References _map.

XMLParser& marlin::XMLParser::operator= ( const marlin::XMLParser & )

privatedelete

void marlin::XMLParser::parametersFromNode	(	TiXmlNode *	section,
		std::map< std::string, std::string > &	constants,
		std::pair< unsigned, unsigned > *	typeCount = `0`
	)

protected

Extracts all parameters from the given node and adss them to the current StringParameters object.

Definition at line 336 of file XMLParser.cc.

References _cmdlineparams, _current, marlin::StringParameters::add(), TiXmlElement::Attribute(), std::string::begin(), std::string::compare(), std::string::end(), std::map< K, T >::end(), std::endl(), std::string::erase(), std::map< K, T >::erase(), std::map< K, T >::find(), std::pair::first, TiXmlNode::FirstChild(), std::for_each(), getAttribute(), TiXmlNode::IterateChildren(), performConstantReplacement(), std::vector< T >::push_back(), std::pair::second, TiXmlElement::SetAttribute(), TiXmlNode::SetValue(), TiXmlNode::ToElement(), and TiXmlNode::Value().

Referenced by parse().

void marlin::XMLParser::parse ( )

virtual

Parse the input file.

Implements marlin::IParser.

Definition at line 24 of file XMLParser.cc.

References _cmdlineparams, _current, _doc, _fileName, _forCCheck, _map, marlin::StringParameters::add(), std::map< K, T >::begin(), std::vector< T >::begin(), std::set< K >::clear(), TiXmlNode::Clone(), std::vector< T >::end(), std::map< K, T >::end(), std::set< K >::end(), std::endl(), TiXmlDocument::ErrorCol(), TiXmlDocument::ErrorDesc(), TiXmlDocument::ErrorRow(), std::set< K >::find(), std::pair::first, TiXmlNode::FirstChild(), TiXmlNode::FirstChildElement(), getAttribute(), std::set< K >::insert(), TiXmlNode::InsertBeforeChild(), TiXmlNode::InsertEndChild(), TiXmlNode::IterateChildren(), TiXmlDocument::LoadFile(), TiXmlNode::NextSiblingElement(), parametersFromNode(), performConstantReplacement(), processconditions(), processConstants(), processIncludeElements(), std::vector< T >::push_back(), TiXmlNode::RemoveChild(), replacegroups(), TiXmlDocument::RootElement(), std::pair::second, std::map< K, T >::size(), std::string::size(), std::stringstream::str(), and TiXmlNode::Value().

std::string & marlin::XMLParser::performConstantReplacement	(	std::string &	value,
		const std::map< std::string, std::string > &	constants
	)

protected

Definition at line 864 of file XMLParser.cc.

References std::map< K, T >::end(), std::string::find(), std::map< K, T >::find(), std::string::find_first_of(), std::string::replace(), std::stringstream::str(), and std::string::substr().

Referenced by parametersFromNode(), parse(), processConstant(), and processIncludeElement().

void marlin::XMLParser::processconditions	(	TiXmlNode *	current,
		const std::string &	conditions
	)

protected

Helper method - recursively moves processors from <if> tags to top level (<execute>) and adds corresponding conditions attribute.

Definition at line 524 of file XMLParser.cc.

References TiXmlElement::Attribute(), TiXmlNode::Clone(), std::string::find(), getAttribute(), TiXmlNode::InsertBeforeChild(), TiXmlNode::IterateChildren(), TiXmlNode::Parent(), TiXmlNode::RemoveChild(), TiXmlElement::SetAttribute(), std::string::size(), TiXmlNode::ToElement(), and TiXmlNode::Value().

Referenced by parse().

void marlin::XMLParser::processConstant	(	TiXmlElement *	element,
		std::map< std::string, std::string > &	constants
	)

protected

Definition at line 774 of file XMLParser.cc.

References _cmdlineparams, TiXmlElement::Attribute(), std::string::compare(), std::map< K, T >::end(), std::endl(), std::string::erase(), std::map< K, T >::find(), TiXmlNode::FirstChild(), std::map< K, T >::insert(), performConstantReplacement(), TiXmlElement::SetAttribute(), TiXmlNode::SetValue(), std::stringstream::str(), and TiXmlNode::Value().

Referenced by processConstants().

void marlin::XMLParser::processConstants	(	TiXmlNode *	node,
		std::map< std::string, std::string > &	constants
	)

protected

Definition at line 709 of file XMLParser.cc.

References _cmdlineparams, std::map< K, T >::end(), std::map< K, T >::erase(), std::map< K, T >::find(), TiXmlNode::FirstChildElement(), TiXmlNode::InsertAfterChild(), TiXmlNode::NextSiblingElement(), processConstant(), processIncludeElement(), TiXmlNode::RemoveChild(), and TiXmlNode::Value().

Referenced by parse().

void marlin::XMLParser::processIncludeElement	(	TiXmlElement *	element,
		const std::map< std::string, std::string > &	constants,
		TiXmlDocument &	document
	)