GENIE tune ID. More...

#include <TuneId.h>

Collaboration diagram for genie::TuneId:

Public Member Functions
	TuneId (const string &id_str, bool failOnInvalid=true)

	TuneId (const TuneId &id)

	~TuneId ()

string	Name (void) const

string	Prefix (void) const

string	Year (void) const

string	ModelId (void) const

string	MajorModelId (void) const

string	MinorModelId (void) const

string	TunedParamSetId (void) const

string	FitDataSetId (void) const

bool	IsConfigured (void) const

bool	IsValidated (void) const

bool	IsCustom (void) const

bool	OnlyConfiguration () const

string	CMC (void) const

string	Tail (void) const

string	CMCDirectory (void) const

string	TuneDirectory (void) const

string	BaseDirectory (void) const

string	CustomSource (void) const

void	Build (const string &name="")

void	Decode (string id_str)

void	Copy (const TuneId &id)

bool	Compare (const TuneId &id) const

void	Print (ostream &stream) const

Private Member Functions
	TuneId ()

bool	CheckDirectory ()

Private Attributes
string	fName

string	fPrefix

string	fYear

string	fModelId

string	fMajorModelId

string	fMinorModelId

string	fTunedParamSetId

string	fFitDataSetId

string	fBaseDirectory

string	fCustomSource

bool	fIsConfigured

bool	fIsValidated

Friends
ostream &	operator<< (ostream &stream, const TuneId &id)

Detailed Description

GENIE tune ID.

Author: Marco Roda <Marco.Roda liverpool.ac.uk> University of Liverpool

Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool

Created:: April 19, 2018

License:: Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 37 of file TuneId.h.

Constructor & Destructor Documentation

TuneId::TuneId	(	const string &	id_str,
		bool	failOnInvalid = `true`
	)

Definition at line 52 of file TuneId.cxx.

References Build(), fIsConfigured, fIsValidated, and fName.

   : fName(genie::utils::str::TrimSpaces(id_str)) // remove any lead/trailing
   , fIsConfigured(false)
   , fIsValidated(false)
 {
   Build(fName);
   if ( failOnInvalid && ! fIsValidated ) {
     //    status & 0377 is returned to parent on exit() call e.g. [0:255]
     // SYSEXITS(3)       FreeBSD Library Functions Manual
     // According to style(9),  it is not a good practice to call exit(3) with
     // arbitrary values to indicate a failure condition when ending a program.
     // Instead, the pre-defined exit codes from sysexits should be used, so the
     // caller of the process can get a rough estimation about the failure class
     // without looking up the source code.
     // EX_USAGE (64)        The command was used incorrectly, e.g., with the
     //                      wrong number of arguments, a bad flag, a bad syntax
     //                      in a parameter, or whatever.
     // EX_UNAVAILABLE (69)  A service is unavailable.  This can occur if a sup­
     //                      port program or file does not exist.  This can also
     //                      be used as a catchall message when something you
     //                      wanted to do doesn't work, but you don't know why.
 
     //   use 64 when failed Decode name (i.e. ! fIsConfigured )
     //   use 69 when failed to find directory (i.e. ! fIsValidated )
     if ( fIsConfigured ) exit(69);
     else                 exit(64);
   }
 }

TuneId::TuneId ( const TuneId & id )

Definition at line 81 of file TuneId.cxx.

References CheckDirectory(), Copy(), LOG, Name(), and pWARN.

 {
   this->Copy(id);
 
   if ( ! CheckDirectory() ) {
     LOG("TuneId", pWARN) << "No valid subdirectory associated with " << Name() ;
   }
 }

genie::TuneId::~TuneId ( )

inline

Definition at line 43 of file TuneId.h.

43 {;}

genie::TuneId::TuneId ( )

inlineprivate

Definition at line 89 of file TuneId.h.

89 {;}

Member Function Documentation

string genie::TuneId::BaseDirectory ( void ) const

inline

Definition at line 76 of file TuneId.h.

References fBaseDirectory.

76 { return fBaseDirectory; }

genie::TuneId::fBaseDirectory

string fBaseDirectory

Definition: TuneId.h:103

void TuneId::Build ( const string & name = "" )

Definition at line 124 of file TuneId.cxx.

References CheckDirectory(), Decode(), fIsConfigured, fIsValidated, fName, LOG, Name(), pDEBUG, pFATAL, and pINFO.

Referenced by genie::RunOpt::BuildTune(), and TuneId().

                                        {
   LOG("TuneId",pDEBUG)<<"Building tune "<<name;
   if ( name.size() > 0 ) fName = name ;
 
   this -> Decode( fName );
   if ( ! fIsConfigured ) return; // no point going on
 
   if ( this -> CheckDirectory() ) {
     LOG("TuneId", pINFO) << Name() <<" Tune configured " ;
     fIsValidated = true;
   } else {
     LOG("TuneId", pFATAL) << "No valid tune directory associated with " << Name() ;
     fIsValidated = false;
   }
 }

bool TuneId::CheckDirectory ( )

private

Definition at line 205 of file TuneId.cxx.

References CMC(), genie::utils::system::DirectoryExists(), fBaseDirectory, fCustomSource, genie::utils::xml::GetXMLDefaultPath(), genie::utils::xml::GetXMLPathList(), LOG, Name(), OnlyConfiguration(), pDEBUG, pWARN, genie::utils::str::Split(), and TuneDirectory().

Referenced by Build(), and TuneId().

                             {
 
   std::string pathlist = utils::xml::GetXMLPathList(false) ;
   std::vector<std::string> paths = utils::str::Split(pathlist,":;,");
 
   string top_path = gSystem->ExpandPathName( paths[0].c_str() ) ;
   string def_path = gSystem->ExpandPathName( utils::xml::GetXMLDefaultPath().c_str() ) ;
 
   if ( top_path != def_path ) {
     fCustomSource = top_path ;
   }
 
   fBaseDirectory = "" ;
   LOG("TuneId",pDEBUG) << "Base dir validation " ;
 
   for ( size_t i=0; i< paths.size(); ++i ) {
     const char* tmppath = paths[i].c_str();
     std::string onepath = gSystem->ExpandPathName(tmppath);
     string test = onepath + "/" + CMC() ;
     LOG("TuneId", pDEBUG) << " Testing  " << test << " directory" ;
     if ( utils::system::DirectoryExists( test.c_str() ) ) {
       fBaseDirectory = onepath ;
       break ;
     }
   }
 
   if ( fBaseDirectory.size() == 0 ) {
     LOG("TuneId", pWARN) << " No " << CMC() << " subdirectory found in pathlist";
     return false ;
   }
 
   if ( ! OnlyConfiguration() ) {
     if ( ! utils::system::DirectoryExists( TuneDirectory().c_str() ) ) {
       LOG("TuneId", pWARN) << "No " << Name() << " subdirectory found in " << CMC() ;
       return false ;
     }
   }
 
   LOG("TuneId",pDEBUG) << fBaseDirectory ;
 
   return true ;
 }

string TuneId::CMC ( void ) const

Definition at line 90 of file TuneId.cxx.

References fPrefix, fYear, and ModelId().

Referenced by CheckDirectory(), and CMCDirectory().

                              {
 
   string cmc = fPrefix ;
   cmc += fYear ;
   cmc += "_" ;
   cmc += ModelId() ;
 
   return cmc ;
 }

string TuneId::CMCDirectory ( void ) const

Definition at line 107 of file TuneId.cxx.

References CMC(), dir, and fBaseDirectory.

Referenced by TuneDirectory().

                                       {
 
   string dir = fBaseDirectory ;
   dir += "/" + CMC() ;
 
   return dir ;
 
 }

bool TuneId::Compare ( const TuneId & id ) const

Definition at line 179 of file TuneId.cxx.

References Name().

Referenced by genie::operator!=(), and genie::operator==().

 {
   return (this->Name() == id.Name());
 }

void TuneId::Copy ( const TuneId & id )

Definition at line 165 of file TuneId.cxx.

References fFitDataSetId, fIsConfigured, fIsValidated, fMajorModelId, fMinorModelId, fName, fPrefix, fTunedParamSetId, and fYear.

Referenced by TuneId().

 {
   this->fName            = id.Name();
   this->fPrefix          = id.Prefix();
   this->fYear            = id.Year();
   this->fMajorModelId    = id.MajorModelId();
   this->fMinorModelId    = id.MinorModelId();
   this->fTunedParamSetId = id.TunedParamSetId();
   this->fFitDataSetId    = id.FitDataSetId();
 
   this->fIsConfigured    = id.IsConfigured();
   this->fIsValidated     = id.IsValidated();
 }

string genie::TuneId::CustomSource ( void ) const

inline

Definition at line 77 of file TuneId.h.

References fCustomSource.

Referenced by genie::NtpWriter::Initialize().

77 { return fCustomSource; }

genie::TuneId::fCustomSource

string fCustomSource

Definition: TuneId.h:104

void TuneId::Decode ( string id_str )

Definition at line 140 of file TuneId.cxx.

References fFitDataSetId, fIsConfigured, fMajorModelId, fMinorModelId, fPrefix, fTunedParamSetId, fYear, LOG, and pFATAL.

Referenced by Build().

 {
   static TPRegexp pattern("^([A-Za-z]+)(\\d{2})_(\\d{2})([a-z])_([a-z0-9]{2})_([a-z0-9]{3})$");
   // TPRegexp pattern("([A-Za-z]+)(\\d{2})_(\\d{2})([a-z])_(\\d{2})_(\\d{3})");
 
   TString tstr(id_str.c_str());
   TObjArray * matches = pattern.MatchS(tstr);
   if ( matches -> GetEntries() != 7) {
     LOG("TuneId", pFATAL) << "Bad tune pattern "<<id_str<<" - form is eg G18_01a_00_000";
     fIsConfigured = false;
     return;
   } else {
     fIsConfigured = true;
   }
 
   this -> fPrefix          = ((TObjString*)matches->At(1))->String().Data();
   this -> fYear            = ((TObjString*)matches->At(2))->String().Data();
   this -> fMajorModelId    = ((TObjString*)matches->At(3))->String().Data();
   this -> fMinorModelId    = ((TObjString*)matches->At(4))->String().Data();
   this -> fTunedParamSetId = ((TObjString*)matches->At(5))->String().Data();
   this -> fFitDataSetId    = ((TObjString*)matches->At(6))->String().Data();
 
   delete matches;
 }

string genie::TuneId::FitDataSetId ( void ) const

inline

Definition at line 53 of file TuneId.h.

References fFitDataSetId.

Referenced by Print().

53 { return fFitDataSetId; } // xxx

genie::TuneId::fFitDataSetId

string fFitDataSetId

Definition: TuneId.h:101

bool genie::TuneId::IsConfigured ( void ) const

inline

Definition at line 55 of file TuneId.h.

References fIsConfigured.

Referenced by Print().

55 { return fIsConfigured; }

genie::TuneId::fIsConfigured

bool fIsConfigured

Definition: TuneId.h:106

bool genie::TuneId::IsCustom ( void ) const

inline

Definition at line 62 of file TuneId.h.

References fCustomSource.

Referenced by genie::NtpWriter::Initialize(), and Print().

62 { return fCustomSource.size() > 0 ; }

genie::TuneId::fCustomSource

string fCustomSource

Definition: TuneId.h:104

bool genie::TuneId::IsValidated ( void ) const

inline

Definition at line 59 of file TuneId.h.

References fIsValidated.

Referenced by Print().

59 { return fIsValidated; }

genie::TuneId::fIsValidated

bool fIsValidated

Definition: TuneId.h:107

string genie::TuneId::MajorModelId ( void ) const

inline

Definition at line 50 of file TuneId.h.

References fMajorModelId.

Referenced by Print().

50 { return fMajorModelId; } // MM

genie::TuneId::fMajorModelId

string fMajorModelId

Definition: TuneId.h:98

string genie::TuneId::MinorModelId ( void ) const

inline

Definition at line 51 of file TuneId.h.

References fMinorModelId.

Referenced by Print().

51 { return fMinorModelId; } // v

genie::TuneId::fMinorModelId

string fMinorModelId

Definition: TuneId.h:99

string genie::TuneId::ModelId ( void ) const

inline

Definition at line 49 of file TuneId.h.

References fMajorModelId, and fMinorModelId.

Referenced by CMC().

49 { return fMajorModelId + fMinorModelId; } // MMv

genie::TuneId::fMajorModelId

string fMajorModelId

Definition: TuneId.h:98

genie::TuneId::fMinorModelId

string fMinorModelId

Definition: TuneId.h:99

string genie::TuneId::Name ( void ) const

inline

Definition at line 46 of file TuneId.h.

References fName.

Referenced by Build(), genie::RunOpt::BuildTune(), CheckDirectory(), Compare(), genie::HEDISStrucFunc::HEDISStrucFunc(), genie::NtpWriter::Initialize(), Print(), genie::RunOpt::SetTuneName(), TuneDirectory(), and TuneId().

46 { return fName; } // Gdd_MMv_PP_xxx

genie::TuneId::fName

string fName

Definition: TuneId.h:93

bool genie::TuneId::OnlyConfiguration ( ) const

inline

Definition at line 69 of file TuneId.h.

References TunedParamSetId().

Referenced by CheckDirectory(), and TuneDirectory().

69 { return (TunedParamSetId() == "00") ; }

genie::TuneId::TunedParamSetId

string TunedParamSetId(void) const

Definition: TuneId.h:52

string genie::TuneId::Prefix ( void ) const

inline

Definition at line 47 of file TuneId.h.

References fPrefix.

Referenced by Print().

47 { return fPrefix; } // G

genie::TuneId::fPrefix

string fPrefix

Definition: TuneId.h:95

void TuneId::Print ( ostream & stream ) const

Definition at line 184 of file TuneId.cxx.

References fBaseDirectory, fCustomSource, FitDataSetId(), IsConfigured(), IsCustom(), IsValidated(), MajorModelId(), MinorModelId(), Name(), Prefix(), TuneDirectory(), TunedParamSetId(), and Year().

 {
   std::string             status = "Standard";
   if ( IsCustom()       ) status = "Custom";
   if ( ! IsValidated()  ) status = "BadDirectory";
   if ( ! IsConfigured() ) status = "BadConfig";
   stream << status << " GENIE tune: " << this -> Name()  << std::endl;
   stream << " - Prefix ............... : " << this->Prefix()          << std::endl;
   stream << " - Year ................. : " << this->Year()            << std::endl;
   stream << " - Major model ID ....... : " << this->MajorModelId()    << std::endl;
   stream << " - Minor model ID ....... : " << this->MinorModelId()    << std::endl;
   stream << " - Tuned param set ID ... : " << this->TunedParamSetId() << std::endl;
   stream << " - Fit dataset ID ....... : " << this->FitDataSetId()    << std::endl;
   stream << " - Tune directory ....... : " << this->TuneDirectory()   << std::endl;
   stream << " - Base directory ....... : " << this->fBaseDirectory    << std::endl;
   if ( IsCustom() )
     stream << " - Custom directory ..... : " << this -> fCustomSource   << std::endl;
 
   stream << std::flush;
 }

string TuneId::Tail ( void ) const

Definition at line 100 of file TuneId.cxx.

References fFitDataSetId, and fTunedParamSetId.

                               {
 
   string tail = fTunedParamSetId ;
   tail += "_" + fFitDataSetId    ;
   return tail ;
 }

string TuneId::TuneDirectory ( void ) const

Definition at line 116 of file TuneId.cxx.

References CMCDirectory(), dir, Name(), and OnlyConfiguration().

Referenced by CheckDirectory(), genie::NtpWriter::Initialize(), and Print().

                                           {
 
   string dir = CMCDirectory() ;
   if ( ! OnlyConfiguration() ) dir += "/" + Name() ;
 
   return dir ;
 }

string genie::TuneId::TunedParamSetId ( void ) const

inline

Definition at line 52 of file TuneId.h.

References fTunedParamSetId.

Referenced by OnlyConfiguration(), and Print().

52 { return fTunedParamSetId; } // PP

genie::TuneId::fTunedParamSetId

string fTunedParamSetId

Definition: TuneId.h:100

string genie::TuneId::Year ( void ) const

inline

Definition at line 48 of file TuneId.h.

References fYear.

Referenced by Print().

48 { return fYear; } // dd

genie::TuneId::fYear

string fYear

Definition: TuneId.h:96

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	stream,
		const TuneId &	id
	)

friend

Definition at line 35 of file TuneId.cxx.

   {
     id.Print(stream);
     return stream;
   }

Member Data Documentation

string genie::TuneId::fBaseDirectory

private

Definition at line 103 of file TuneId.h.

Referenced by BaseDirectory(), CheckDirectory(), CMCDirectory(), and Print().

string genie::TuneId::fCustomSource

private

Definition at line 104 of file TuneId.h.

Referenced by CheckDirectory(), CustomSource(), IsCustom(), and Print().

string genie::TuneId::fFitDataSetId

private

Definition at line 101 of file TuneId.h.

Referenced by Copy(), Decode(), FitDataSetId(), and Tail().

bool genie::TuneId::fIsConfigured

private

Definition at line 106 of file TuneId.h.

Referenced by Build(), Copy(), Decode(), IsConfigured(), and TuneId().

bool genie::TuneId::fIsValidated

private

Definition at line 107 of file TuneId.h.

Referenced by Build(), Copy(), IsValidated(), and TuneId().

string genie::TuneId::fMajorModelId

private

Definition at line 98 of file TuneId.h.

Referenced by Copy(), Decode(), MajorModelId(), and ModelId().

string genie::TuneId::fMinorModelId

private

Definition at line 99 of file TuneId.h.

Referenced by Copy(), Decode(), MinorModelId(), and ModelId().

string genie::TuneId::fModelId

private

Definition at line 97 of file TuneId.h.

string genie::TuneId::fName

private

Definition at line 93 of file TuneId.h.

Referenced by Build(), Copy(), Name(), and TuneId().

string genie::TuneId::fPrefix

private

Definition at line 95 of file TuneId.h.

Referenced by CMC(), Copy(), Decode(), and Prefix().

string genie::TuneId::fTunedParamSetId

private

Definition at line 100 of file TuneId.h.

Referenced by Copy(), Decode(), Tail(), and TunedParamSetId().

string genie::TuneId::fYear

private

Definition at line 96 of file TuneId.h.

Referenced by CMC(), Copy(), Decode(), and Year().

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation