genie::NtpMCTreeHeader Class Reference

MINOS-style Ntuple Class to hold an output MC Tree Header. More...

#include <NtpMCTreeHeader.h>

Inheritance diagram for genie::NtpMCTreeHeader:

Collaboration diagram for genie::NtpMCTreeHeader:

Public Member Functions
	NtpMCTreeHeader ()
	NtpMCTreeHeader (const NtpMCTreeHeader &hdr)
virtual	~NtpMCTreeHeader ()
void	Init (void)
void	Copy (const NtpMCTreeHeader &hdr)
void	PrintToStream (ostream &stream) const

Public Attributes
NtpMCFormat_t	format
	Event Record format (GENIE support multiple formats)
TObjString	cvstag
	GENIE CVS Tag (to keep track of GENIE's version)
NtpMCDTime	datime
	Date and Time that the event ntuple was generated.
Long_t	runnu
	MC Job run number.
Long_t	runseed
	Random seed used in the MC run.
TObjString	tune
	GENIE Tune Name.
TObjString	tuneDir
	directory from when tune config came
TObjString	customDirs
	any custom directories

Friends
ostream &	operator<< (ostream &stream, const NtpMCTreeHeader &hdr)

Detailed Description

MINOS-style Ntuple Class to hold an output MC Tree Header.

Author

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

Created:\n October 1, 2004

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org

Definition at line 37 of file NtpMCTreeHeader.h.

Constructor & Destructor Documentation

NtpMCTreeHeader() [1/2]

NtpMCTreeHeader::NtpMCTreeHeader

(

)

Definition at line 36 of file NtpMCTreeHeader.cxx.

                                 :
TNamed("header","GENIE output tree header")
{
  this->Init();
}

References Init().

Referenced by Copy(), NtpMCTreeHeader(), and operator<<.

NtpMCTreeHeader() [2/2]

NtpMCTreeHeader::NtpMCTreeHeader

(

const NtpMCTreeHeader &

hdr

)

Definition at line 42 of file NtpMCTreeHeader.cxx.

                                                            :
TNamed("header","GENIE output tree header")
{
  this->Copy(hdr);
}

References Copy(), and NtpMCTreeHeader().

~NtpMCTreeHeader()

NtpMCTreeHeader::~NtpMCTreeHeader ( )

virtual

Definition at line 48 of file NtpMCTreeHeader.cxx.

{
 
}

Member Function Documentation

Copy()

void NtpMCTreeHeader::Copy

(

const NtpMCTreeHeader &

hdr

)

Definition at line 72 of file NtpMCTreeHeader.cxx.

{
  this->format = hdr.format;
  this->cvstag.SetString(hdr.cvstag.GetString().Data());
  this->datime.Copy(hdr.datime);
  this->runnu  = hdr.runnu;
  this->runseed  = hdr.runseed;
  this->tune.SetString(hdr.tune.GetString().Data());
  this->tuneDir.SetString(hdr.tuneDir.GetString().Data());
  this->customDirs.SetString(hdr.customDirs.GetString().Data());
}

References customDirs, cvstag, datime, format, NtpMCTreeHeader(), runnu, runseed, tune, and tuneDir.

Referenced by NtpMCTreeHeader().

Init()

void NtpMCTreeHeader::Init

(

void

)

Definition at line 84 of file NtpMCTreeHeader.cxx.

{
  string version;
  string genie_path = gSystem->Getenv("GENIE");
  string filename   = genie_path + "/VERSION";
  bool vrs_file_found = ! (gSystem->AccessPathName(filename.c_str()));
  if (!vrs_file_found) {
   LOG("Ntp", pERROR)
       << "The GENIE version file [" << filename << "] is not accessible";
   version = "NO CVS version number was specified";
  } else {
    ifstream gvinp(filename.c_str(), ios::in);
    gvinp >> version;
    gvinp.close();
  }
 
  string tunename("unknown");
  string tuneDir("unknown");
  string customDirs("");
 
  this->format = kNFUndefined;
  this->cvstag.SetString(version.c_str());
  this->datime.Now();
  this->runnu   = 0;
  this->runseed = 0;
  this->tune.SetString(tunename.c_str());
  this->tuneDir.SetString(tuneDir.c_str());
  this->customDirs.SetString(customDirs.c_str());
}

References customDirs, cvstag, datime, format, genie::kNFUndefined, LOG, pERROR, runnu, runseed, tune, and tuneDir.

Referenced by NtpMCTreeHeader().

PrintToStream()

void NtpMCTreeHeader::PrintToStream

(

ostream &

stream

)

const

Definition at line 53 of file NtpMCTreeHeader.cxx.

{
  string sformat = NtpMCFormat::AsString(this->format);
  string scvstag = this->cvstag.GetString().Data();
  string stune       = this->tune.GetString().Data();
  string stuneDir    = this->tuneDir.GetString().Data();
  string scustomDirs = this->customDirs.GetString().Data();
 
  stream << "Tree Header Info:"                      << endl
         << "MC run number     -> " << this->runnu   << endl
         << "MC run seed       -> " << this->runseed << endl
         << "NtpRecord Format  -> " << sformat       << endl
         << "GENIE CVS Vrs Nu  -> " << scvstag       << endl
         << "GENIE tune name   -> " << stune         << endl
         << "tune directory    -> " << stuneDir      << endl
         << "custom directories-> " << scustomDirs   << endl
         << "File generated at -> " << this->datime  << endl;
}

References genie::NtpMCFormat::AsString(), customDirs, cvstag, datime, format, runnu, runseed, tune, and tuneDir.

Referenced by operator<<.

Friends And Related Symbol Documentation

operator<<

ostream & operator<< ( ostream & stream, const NtpMCTreeHeader & hdr )

friend

Definition at line 29 of file NtpMCTreeHeader.cxx.

  {
     hdr.PrintToStream(stream);
     return stream;
  }

References NtpMCTreeHeader(), and PrintToStream().

Member Data Documentation

customDirs

TObjString genie::NtpMCTreeHeader::customDirs

any custom directories

Definition at line 63 of file NtpMCTreeHeader.h.

Referenced by Copy(), Init(), and PrintToStream().

cvstag

TObjString genie::NtpMCTreeHeader::cvstag

GENIE CVS Tag (to keep track of GENIE's version)

Definition at line 57 of file NtpMCTreeHeader.h.

Referenced by ConvertToGTracker(), Copy(), Init(), and PrintToStream().

datime

NtpMCDTime genie::NtpMCTreeHeader::datime

Date and Time that the event ntuple was generated.

Definition at line 58 of file NtpMCTreeHeader.h.

Referenced by Copy(), Init(), and PrintToStream().

format

NtpMCFormat_t genie::NtpMCTreeHeader::format

Event Record format (GENIE support multiple formats)

Definition at line 56 of file NtpMCTreeHeader.h.

Referenced by Copy(), Init(), main(), and PrintToStream().

runnu

Long_t genie::NtpMCTreeHeader::runnu

MC Job run number.

Definition at line 59 of file NtpMCTreeHeader.h.

Referenced by ConvertToGHepMock(), Copy(), Init(), and PrintToStream().

runseed

Long_t genie::NtpMCTreeHeader::runseed

Random seed used in the MC run.

Definition at line 60 of file NtpMCTreeHeader.h.

Referenced by Copy(), Init(), and PrintToStream().

tune

TObjString genie::NtpMCTreeHeader::tune

GENIE Tune Name.

Definition at line 61 of file NtpMCTreeHeader.h.

Referenced by Copy(), Init(), and PrintToStream().

tuneDir

TObjString genie::NtpMCTreeHeader::tuneDir

directory from when tune config came

Definition at line 62 of file NtpMCTreeHeader.h.

Referenced by Copy(), Init(), and PrintToStream().

---

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

• NtpMCTreeHeader.h
• NtpMCTreeHeader.cxx