run_index_t Class Reference

Detailed Description

Specifies a runfile according to run number and file index ,.

Each experimental 'run' may produce 1 or more files. The conditions and settings of the experiment are assumed to be the same during the entire length of the run.

Each 'run' is assigned a number. Each file of the 'run' is assigned an index.

To fully specify a runfile requires both run number and index: run_index_t. In the case where only 1 file is associated with each run, the index is optional.

Declaring a run_index_t can be done like:

int run, index;
run_index_t A{run,index};
run_index_t B{run, std::nullopt}; => no index defined
run_index_t C{run, -1} => no index defined

Definition at line 33 of file run_index.h.

#include <run_index.h>

Inheritance diagram for run_index_t:

Public Member Functions
	run_index_t ()=default
	run_index_t (const run_index_t &)=default
	run_index_t (const TString &rs)
	run_index_t (int run, std::optional< int > index)
	run_index_t (run_index_t &&)=default
TString	as_string () const
void	clear ()
bool	has_index () const
int	index (int no_index=-1) const
TString	index_string () const
run_index_t &	operator= (const run_index_t &)=default
run_index_t &	operator= (run_index_t &&)=default
int	run () const
void	set (const TString &rs)
void	set_index (int i)
void	set_run (int r)

Friends
bool	operator< (const run_index_t &A, const run_index_t &B)
std::ostream &	operator<< (std::ostream &out, const run_index_t &rndx)
bool	operator== (const run_index_t &A, const run_index_t &B)

Constructor & Destructor Documentation

run_index_t() [1/5]

run_index_t::run_index_t ( int  run, std::optional< int >  index  )

inline

Definition at line 35 of file run_index.h.

run_index_t() [2/5]

run_index_t::run_index_t ( )

default

run_index_t() [3/5]

run_index_t::run_index_t ( const run_index_t &  )

default

run_index_t() [4/5]

run_index_t::run_index_t ( run_index_t &&  )

default

run_index_t() [5/5]

run_index_t::run_index_t ( const TString &  rs )

inline

Definition at line 46 of file run_index.h.

Member Function Documentation

as_string()

TString run_index_t::as_string ( ) const

inline

Definition at line 94 of file run_index.h.

clear()

void run_index_t::clear ( )

inline

Definition at line 75 of file run_index.h.

has_index()

bool run_index_t::has_index ( ) const

inline

Definition at line 61 of file run_index.h.

index()

int run_index_t::index ( int  no_index = -1 ) const

inline

Definition at line 57 of file run_index.h.

index_string()

TString run_index_t::index_string ( ) const

inline

Definition at line 101 of file run_index.h.

operator=() [1/2]

run_index_t& run_index_t::operator= ( const run_index_t &  )

default

operator=() [2/2]

run_index_t& run_index_t::operator= ( run_index_t &&  )

default

run()

int run_index_t::run ( ) const

inline

Definition at line 52 of file run_index.h.

set()

void run_index_t::set ( const TString &  rs )

inline

Definition at line 81 of file run_index.h.

set_index()

void run_index_t::set_index ( int  i )

inline

Definition at line 69 of file run_index.h.

set_run()

void run_index_t::set_run ( int  r )

inline

Definition at line 65 of file run_index.h.

Friends And Related Function Documentation

operator<

bool operator< ( const run_index_t &  A, const run_index_t &  B  )

friend

Definition at line 118 of file run_index.h.

operator<<

std::ostream& operator<< ( std::ostream &  out, const run_index_t &  rndx  )

friend

Definition at line 106 of file run_index.h.

operator==

bool operator== ( const run_index_t &  A, const run_index_t &  B  )

friend

Definition at line 127 of file run_index.h.