Monte Carlo run header. More...

#include <JHead.hh>

Inheritance diagram for JAANET::JHead:

Public Member Functions
	JHead ()
	Default constructor. More...

	JHead (const Head &header)
	Copy constructor. More...

virtual	~JHead ()
	Virtual destructor. More...

const JHead &	getHeader () const
	Get header. More...

JHead &	getHeader ()
	Get header. More...

void	setHeader (const JHead &header)
	Set header. More...

template<class T >
const_iterator	pull (T JHead::*pd) const
	Pull given data member from Head. More...

template<class T >
iterator	pull (T JHead::*pd)
	Pull given data member from Head. More...

template<class T >
void	push (T JHead::*pd)
	Push given data member to Head. More...

template<class T >
void	erase (T JHead::*pd)
	Remove given data member from Head. More...

bool	match (const JHead &header, const bool option=true) const
	Test match of headers. More...

bool	less (const JHead &header) const
	Comparison of headers. More...

JHead &	add (const JHead &header)
	Addition of headers. More...

std::istream &	read (std::istream &in)
	Read header from input. More...

std::ostream &	write (std::ostream &out) const
	Write header to output. More...

std::ostream &	print (std::ostream &out) const
	Print header to output. More...

	ClassDef (JHead, 3)

Static Public Member Functions
static JLANG::JEquationParameters &	getEquationParameters ()
	Get equation parameters corresponding to Monte Carlo ASCII format, i.e: More...

static void	setEquationParameters (const JLANG::JEquationParameters &equation)
	Set equation parameters. More...

Static Public Attributes
static const std::string	GENHEN = "GENHEN"
	Generators. More...

static const std::string	GENIE = "GENIE"

static const std::string	GSEAGEN = "gSeaGen"

static const std::string	MUPAGE = "HEMAS-DPM"

static const std::string	JSIRENE = "JSirene"

static const std::string	KM3 = "KM3"

static const std::string	KM3SIM = "KM3Sim"

Static Private Member Functions
template<class T >
static bool	match (const T &first, const T &second)
	Test match. More...

template<class T >
static bool	match (const std::vector< T > &first, const std::vector< T > &second)
	Test one container is subset of other container or vice versa. More...

template<class T >
static bool	match (const JHead &first, const JHead &second, const bool option, T JHead::*pd)
	Test match of given data member of headers. More...

Friends
bool	operator== (const JHead &first, const JHead &second)
	Equal operator. More...

bool	operator< (const JHead &first, const JHead &second)
	Less than operator. More...

Detailed Description

Monte Carlo run header.

This class extends the Head class so that the data from specific tags can be promoted to concrete data types.

Note that for the copy of new JHead data (e.g. data not obtained via a previous JAANET::copy) to become effective, the key words in the corresponding map of the Head class should be set.
To this end, member method JHead::push can be used.

Definition at line 839 of file JHead.hh.

Constructor & Destructor Documentation

◆ JHead() [1/2]

JAANET::JHead::JHead ( )

inline

Default constructor.

Definition at line 857 of file JHead.hh.

858 {}

◆ JHead() [2/2]

JAANET::JHead::JHead ( const Head & header )

inline

Copy constructor.

Parameters

header header

Definition at line 866 of file JHead.hh.

     {
       copy(header, *this);
     }

◆ ~JHead()

virtual JAANET::JHead::~JHead ( )

inlinevirtual

Virtual destructor.

Definition at line 875 of file JHead.hh.

876 {}

Member Function Documentation

◆ getHeader() [1/2]

const JHead& JAANET::JHead::getHeader ( ) const

inline

Get header.

Returns: header

Definition at line 884 of file JHead.hh.

     {
       return static_cast<const JHead&>(*this);
     }

◆ getHeader() [2/2]

JHead& JAANET::JHead::getHeader ( )

inline

Get header.

Returns: header

Definition at line 895 of file JHead.hh.

     {
       return static_cast<JHead&>(*this);
     }

◆ setHeader()

void JAANET::JHead::setHeader ( const JHead & header )

inline

Set header.

Parameters

header header

Definition at line 906 of file JHead.hh.

     {
       static_cast<JHead&>(*this) = header;
     }

◆ pull() [1/2]

template<class T >

const_iterator JAANET::JHead::pull ( T JHead::* pd ) const

inline

Pull given data member from Head.

Parameters

pd	pointer to data member

Returns: iterator of Head

Definition at line 919 of file JHead.hh.

     {
       return this->find(JROOT::getDataMember(pd)->GetName());
     }

◆ pull() [2/2]

template<class T >

iterator JAANET::JHead::pull ( T JHead::* pd )

inline

Pull given data member from Head.

Parameters

pd	pointer to data member

Returns: iterator of Head

Definition at line 932 of file JHead.hh.

     {
       return this->find(JROOT::getDataMember(pd)->GetName());
     }

◆ push()

template<class T >

void JAANET::JHead::push ( T JHead::* pd )

inline

Push given data member to Head.

Parameters

pd	pointer to data member

Definition at line 944 of file JHead.hh.

     {
       (*this)[JROOT::getDataMember(pd)->GetName()] = "";
     }

◆ erase()

template<class T >

void JAANET::JHead::erase ( T JHead::* pd )

inline

Remove given data member from Head.

Parameters

pd	pointer to data member

Definition at line 956 of file JHead.hh.

     {
       iterator p = this->pull(pd);
  
       if (p != this->end()) {
  
         this->*pd = T();
  
         static_cast<Head*>(this)->erase(p);
       }
     }

◆ match() [1/4]

bool JAANET::JHead::match	(	const JHead &	header,
		const bool	option = `true`
	)		const

inline

Test match of headers.

Note that if option is set to false, the match applies only to data which have a corresponding entry in the underlying map of the given header.

Parameters

header	second header
option	option

Returns: true if matches; else false

Definition at line 979 of file JHead.hh.

     {
       return (match(*this, header, option, &JHead::cut_primary)       &&
               match(*this, header, option, &JHead::cut_seamuon)       &&
               match(*this, header, option, &JHead::cut_in)            &&
               match(*this, header, option, &JHead::cut_nu)            &&
               match(*this, header, option, &JHead::physics)           &&
               match(*this, header, option, &JHead::simul)             &&
               match(*this, header, option, &JHead::spectrum)          &&
               match(*this, header, option, &JHead::can)               &&
               match(*this, header, option, &JHead::fixedcan)          &&
               match(*this, header, option, &JHead::genvol)            &&
               match(*this, header, option, &JHead::coord_origin)      &&
               match(*this, header, option, &JHead::norma)             &&
               match(*this, header, option, &JHead::livetime)          &&
               match(*this, header, option, &JHead::seabottom)         &&
               match(*this, header, option, &JHead::primary)           &&
               match(*this, header, option, &JHead::DAQ));
     }

◆ less()

bool JAANET::JHead::less ( const JHead & header ) const

inline

Comparison of headers.

Parameters

header header

Returns: true if this header less than given header; else false

Definition at line 1006 of file JHead.hh.

     {
       if      (primary.less(header.primary))
         return true;
       else if (header.primary.less(primary))
         return false;
       else
         return cut_primary.less(header.cut_primary);
     }

◆ add()

JHead& JAANET::JHead::add ( const JHead & header )

inline

Addition of headers.

Parameters

header header

Returns: this header

Definition at line 1023 of file JHead.hh.

     {
       if (match(header)) {
  
         genvol  .add(header.genvol);
         norma   .add(header.norma);
         livetime.add(header.livetime);
         DAQ     .add(header.DAQ);
  
       } else {
  
         THROW(JException, "JHead::add() headers do not match.");
       }
  
       return *this;
     }

◆ getEquationParameters()

static JLANG::JEquationParameters& JAANET::JHead::getEquationParameters ( )

inlinestatic

Get equation parameters corresponding to Monte Carlo ASCII format, i.e:

   <key>: <value> [<value>]*
   <key>: <value> [<value>]*

Returns: equation parameters

Definition at line 1106 of file JHead.hh.

     {
       static JLANG::JEquationParameters parameters(":", "\n", "", "");
       
       return parameters;
     }

◆ setEquationParameters()

static void JAANET::JHead::setEquationParameters ( const JLANG::JEquationParameters & equation )

inlinestatic

Set equation parameters.

Parameters

equation equation parameters

Definition at line 1119 of file JHead.hh.

     {
       getEquationParameters() = equation;
     }

◆ read()

std::istream & JAANET::JHead::read ( std::istream & in )

Read header from input.

Parameters

in	input stream

Returns: input stream

Definition at line 41 of file JHead.cc.

   {
     using namespace std;
     using namespace JPP;
  
     JStringStream is(in);
  
     if (getFileStatus(is.str().c_str())) {
       is.load();
     }
  
     JRootReader reader(is, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
  
     JRootReadableClass cls(*this);
     
     for (JEquation equation; reader >> equation && equation.getKey() != end_event::Class_Name(); ) {
  
       JRedirectString redirect(reader, equation.getValue());
  
       const JRootReadableClass abc = cls.find(equation.getKey().c_str());
  
       if (abc.is_valid()) {
         reader.getObject(abc);
       }
  
       (*this)[equation.getKey()] = equation.getValue();
     }
  
     return in;
   }

◆ write()

std::ostream & JAANET::JHead::write ( std::ostream & out ) const

Write header to output.

Parameters

out	output stream
header	header

Returns: output stream

Parameters

out	output stream

Returns: output stream

Definition at line 79 of file JHead.cc.

   {
     using namespace std;
     using namespace JPP;
  
     JRootWriter writer(out, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
  
     JRootWritableClass cls(*this);
  
     TIterator* i = cls.getClass()->GetListOfDataMembers()->MakeIterator();
  
     for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
       if (!JRootClass::is_static(*p)) {
         if (this->find(p->GetName()) != this->end()                    ||
             cls.get(*p)              == JRootClass(&JHead::start_run)  ||
             cls.get(*p)              == JRootClass(&JHead::end_event)) {
           writer.put(p->GetName(), cls.get(*p), true);
         }
       }
     }
  
     return out << flush;
   }

◆ print()

std::ostream & JAANET::JHead::print ( std::ostream & out ) const

Print header to output.

Parameters

out	output stream

Returns: output stream

Definition at line 110 of file JHead.cc.

   {
     using namespace std;
     using namespace JPP;
  
     const JEquationParameters& parameters = JHead::getEquationParameters();
  
     JRootWriter writer(out, parameters, JAAnetDictionary::getInstance());
  
     JRootWritableClass cls(*this);
  
     TIterator* i = cls.getClass()->GetListOfDataMembers()->MakeIterator();
  
     pair<string, JRootWritableClass> end_event("", this->end_event);
  
     for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
       if (!JRootClass::is_static(*p)) {
         if (cls.get(*p) != JRootClass(&JHead::end_event)) 
           writer.put(p->GetName(), cls.get(*p), true);
         else
           end_event = make_pair(p->GetName(), cls.get(*p));
       }
     }
  
     for (JHead::const_iterator i = this->begin(); i != this->end(); ++i) {
       if (!cls.find(i->first.c_str()).is_valid()) {
         out << i->first << parameters.getDefaultSeparator() << parameters.getDefaultWhiteSpace() << i->second << parameters.getDefaultEndOfLine();
       }
     }
  
     writer.put(end_event.first, end_event.second, true);
  
     return out << flush;
   }

◆ ClassDef()

JAANET::JHead::ClassDef	(	JHead	,
		3
	)

◆ match() [2/4]

template<class T >

static bool JAANET::JHead::match	(	const T &	first,
		const T &	second
	)

inlinestaticprivate

Test match.

Parameters

first	first object
second	second object

Returns: true if matches; else false

Definition at line 1164 of file JHead.hh.

     {
       return first.match(second);
     }

◆ match() [3/4]

template<class T >

static bool JAANET::JHead::match	(	const std::vector< T > &	first,
		const std::vector< T > &	second
	)

inlinestaticprivate

Test one container is subset of other container or vice versa.

Parameters

first	first object
second	second object

Returns: true if first (second) is subset of second (first); else false

Definition at line 1179 of file JHead.hh.

     {
       size_t ns = 0;
       
       for (typename std::vector<T>::const_iterator ix = first.begin(); ix != first.end(); ++ix) {
         for (typename std::vector<T>::const_iterator iy = second.begin(); iy != second.end(); ++iy) {
           if (match(*ix, *iy)) {
             ++ns;
           }
         }
       }
       
       return ns == first.size() || ns == second.size();
     }

◆ match() [4/4]

template<class T >

static bool JAANET::JHead::match	(	const JHead &	first,
		const JHead &	second,
		const bool	option,
		T JHead::*	pd
	)

inlinestaticprivate

Test match of given data member of headers.

Note that if option is set to false, the match applies only to data which have a corresponding tag in the underlying map of the second header.

Parameters

first	first header
second	second header
option	option
pd	pointer to data member

Returns: true if matches; else false

Definition at line 1209 of file JHead.hh.

     {
       if (option || second.pull(pd) != second.end())
         return match(first.*pd, second.*pd);
       else
         return true;
     }

Friends And Related Function Documentation

◆ operator==

bool operator==	(	const JHead &	first,
		const JHead &	second
	)

friend

Equal operator.

Note that this operator uses the JHead::match method.

Parameters

first	first header
second	second header

Returns: true if two headers are equal; else false

Definition at line 1050 of file JHead.hh.

     {
       return first.match(second);
     }

◆ operator<

bool operator<	(	const JHead &	first,
		const JHead &	second
	)

friend

Less than operator.

Parameters

first	first header
second	second header

Returns: true if first header is less than second header; else false

Definition at line 1064 of file JHead.hh.

     {
       return first.less(second);
     }

Member Data Documentation

◆ GENHEN

const std::string JAANET::JHead::GENHEN = "GENHEN"

static

Generators.

Applications.

Definition at line 845 of file JHead.hh.

◆ GENIE

const std::string JAANET::JHead::GENIE = "GENIE"

static

Definition at line 846 of file JHead.hh.

◆ GSEAGEN

const std::string JAANET::JHead::GSEAGEN = "gSeaGen"

static

Definition at line 847 of file JHead.hh.

◆ MUPAGE

const std::string JAANET::JHead::MUPAGE = "HEMAS-DPM"

static

Definition at line 848 of file JHead.hh.

◆ JSIRENE

const std::string JAANET::JHead::JSIRENE = "JSirene"

static

Definition at line 849 of file JHead.hh.

◆ KM3

const std::string JAANET::JHead::KM3 = "KM3"

static

Definition at line 850 of file JHead.hh.

◆ KM3SIM

const std::string JAANET::JHead::KM3SIM = "KM3Sim"

static

Definition at line 851 of file JHead.hh.

◆ start_run

JAANET::start_run JAANET::JHead::start_run

Definition at line 1071 of file JHead.hh.

◆ XSecFile

JAANET::XSecFile JAANET::JHead::XSecFile

Definition at line 1072 of file JHead.hh.

◆ detector

JAANET::detector JAANET::JHead::detector

Definition at line 1073 of file JHead.hh.

◆ muon_desc_file

JAANET::muon_desc_file JAANET::JHead::muon_desc_file

Definition at line 1074 of file JHead.hh.

◆ target

JAANET::target JAANET::JHead::target

Definition at line 1075 of file JHead.hh.

◆ physics

std::vector<JAANET::physics> JAANET::JHead::physics

Definition at line 1076 of file JHead.hh.

◆ simul

std::vector<JAANET::simul> JAANET::JHead::simul

Definition at line 1077 of file JHead.hh.

◆ cut_primary

JAANET::cut_primary JAANET::JHead::cut_primary

Definition at line 1078 of file JHead.hh.

◆ cut_seamuon

JAANET::cut_seamuon JAANET::JHead::cut_seamuon

Definition at line 1079 of file JHead.hh.

◆ cut_in

JAANET::cut_in JAANET::JHead::cut_in

Definition at line 1080 of file JHead.hh.

◆ cut_nu

JAANET::cut_nu JAANET::JHead::cut_nu

Definition at line 1081 of file JHead.hh.

◆ spectrum

JAANET::spectrum JAANET::JHead::spectrum

Definition at line 1082 of file JHead.hh.

◆ can

JAANET::can JAANET::JHead::can

Definition at line 1083 of file JHead.hh.

◆ fixedcan

JAANET::fixedcan JAANET::JHead::fixedcan

Definition at line 1084 of file JHead.hh.

◆ genvol

JAANET::genvol JAANET::JHead::genvol

Definition at line 1085 of file JHead.hh.

◆ coord_origin

JAANET::coord_origin JAANET::JHead::coord_origin

Definition at line 1086 of file JHead.hh.

◆ genhencut

JAANET::genhencut JAANET::JHead::genhencut

Definition at line 1087 of file JHead.hh.

◆ norma

JAANET::norma JAANET::JHead::norma

Definition at line 1088 of file JHead.hh.

◆ livetime

JAANET::livetime JAANET::JHead::livetime

Definition at line 1089 of file JHead.hh.

◆ seabottom

JAANET::seabottom JAANET::JHead::seabottom

Definition at line 1090 of file JHead.hh.

◆ DAQ

JAANET::DAQ JAANET::JHead::DAQ

Definition at line 1091 of file JHead.hh.

◆ tgen

JAANET::tgen JAANET::JHead::tgen

Definition at line 1092 of file JHead.hh.

◆ primary

JAANET::primary JAANET::JHead::primary

Definition at line 1093 of file JHead.hh.

◆ end_event

JAANET::end_event JAANET::JHead::end_event

Definition at line 1094 of file JHead.hh.

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

Public Attributes
JAANET::start_run	start_run

JAANET::XSecFile	XSecFile

JAANET::detector	detector

JAANET::muon_desc_file	muon_desc_file

JAANET::target	target

std::vector< JAANET::physics >	physics

std::vector< JAANET::simul >	simul

JAANET::cut_primary	cut_primary

JAANET::cut_seamuon	cut_seamuon

JAANET::cut_in	cut_in

JAANET::cut_nu	cut_nu

JAANET::spectrum	spectrum

JAANET::can	can

JAANET::fixedcan	fixedcan

JAANET::genvol	genvol

JAANET::coord_origin	coord_origin

JAANET::genhencut	genhencut

JAANET::norma	norma

JAANET::livetime	livetime

JAANET::seabottom	seabottom

JAANET::DAQ	DAQ

JAANET::tgen	tgen

JAANET::primary	primary

JAANET::end_event	end_event

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JHead() [1/2]

◆ JHead() [2/2]

◆ ~JHead()

Member Function Documentation

◆ getHeader() [1/2]

◆ getHeader() [2/2]

◆ setHeader()

◆ pull() [1/2]

◆ pull() [2/2]

◆ push()

◆ erase()

◆ match() [1/4]

◆ less()

◆ add()

◆ getEquationParameters()

◆ setEquationParameters()

◆ read()

◆ write()

◆ print()

◆ ClassDef()

◆ match() [2/4]

◆ match() [3/4]

◆ match() [4/4]

Friends And Related Function Documentation

◆ operator==

◆ operator<

Member Data Documentation

◆ GENHEN

◆ GENIE

◆ GSEAGEN

◆ MUPAGE

◆ JSIRENE

◆ KM3

◆ KM3SIM

◆ start_run

◆ XSecFile

◆ detector

◆ muon_desc_file

◆ target

◆ physics

◆ simul

◆ cut_primary

◆ cut_seamuon

◆ cut_in

◆ cut_nu

◆ spectrum

◆ can

◆ fixedcan

◆ genvol

◆ coord_origin

◆ genhencut

◆ norma

◆ livetime

◆ seabottom

◆ DAQ

◆ tgen

◆ primary

◆ end_event