Auxiliary classes and methods for database I/O. More...

Namespaces
	PBS

Classes
struct	getSelector
	Template definition for getting table specific selector. More...

struct	getSelector< T, JAllParams, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JCLBMap, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JDatalogNumbers, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JDetectors, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JPMTHVRunSettings, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JRunQuality, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JRuns, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JRunsetupParams, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JRunSummaryNumbers, true >
	Template specialisation for getting table specific selector. More...

struct	getSelector< T, JToAshort, true >
	Template specialisation for getting table specific selector. More...

struct	JAHRS

struct	JAllParams

struct	JCLBMap

class	JDatabaseObjectIterator
	Object iteration from database. More...

struct	JDatabaseObjectIterator< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JDatabaseObjectIterator class. More...

struct	JDatabaseObjectIterator< JTypeList< JHead_t, JTail_t > >
	Implementation of object iterator for multiple data types. More...

struct	JDatalog

struct	JDatalogNumbers

struct	JDate_t
	Auxiliary class for integration date. More...

class	JDB
	Auxiliary class for connection to data base. More...

struct	JDBReader
	Auxiliary class to read ROOT object from database. More...

struct	JDetectorIntegration
	Detector integration. More...

struct	JDetectors

struct	JDetectorsHelper
	Auxiliary class for mapping serial number and object identifier of detectors. More...

struct	JLocation_t
	Auxiliary data structure for location of product in detector. More...

struct	JNullResultSet
	Auxiliary class for invalid result set. More...

struct	JPBS
	Product breakdown structure (PBS). More...

struct	JPersons

struct	JPMTBestHVSettings

struct	JPMTHVRunSettings

struct	JPMTHVSettings

struct	JProductIntegration

struct	JProductIntegration_t
	Auxiliary class for product integration data. More...

struct	JProductRouter
	Auxiliary class to map UPI to location in detector. More...

struct	JProductTrace
	Auxiliary class to trace product. More...

struct	JQueries
	Auxiliary method to get list of table names. More...

struct	JRun_t
	Auxiliary class for detector/run comparisons. More...

struct	JRunQuality
	Auxiliary data structure for data quality. More...

struct	JRuns

struct	JRunsetupParams

struct	JRunsetups
	Auxiliary class for run setup evaluation. More...

struct	JRunSummaryNumbers

class	JSelector
	Auxiliary class for specifying selection of database data. More...

struct	JToAshort

struct	JUPI
	Universal product identifier (UPI). More...

struct	JVendorHV

Typedefs
typedef JTOOLS::JRange< JDate_t >	JPeriod_t
	Type definition of period. More...

Functions
const char *	getPrivateCookie ()
	Get private cookie. More...

const char *	getPublicCookie ()
	Get public cookie. More...

template<class T >
bool	operator>> (ResultSet &rs, T &object)
	Read ROOT object from result set. More...

template<class JElement_t , class JAllocator_t >
bool	operator>> (ResultSet &rs, std::vector< JElement_t, JAllocator_t > &buffer)
	Read vector of ROOT objects from result set. More...

template<class JTable_t >
const char *	getTable ()
	Get table name. More...

template<class JTable_t , class JType_t >
const char *	getColumn (JType_t JTable_t::*data_member)
	Get column name. More...

template<class JTable_t >
std::vector< std::string >	getColumns ()
	Get column names. More...

ResultSet &	getResultSet (const std::string &query)
	Get result set. More...

ResultSet &	getResultSet (const std::string &query, const std::vector< Selector > &selection)
	Get result set. More...

std::ostream &	operator<< (std::ostream &out, const JPeriod_t &object)
	Write period to output stream. More...

bool	operator>> (ResultSet &rs, JRunQuality &quality)
	Read data quality from result set. More...

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

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

const Selector::RelOp &	getOperand (const int index)
	Get operand. More...

template<class JTypelist_t >
const std::vector< std::string > &	getQueries ()
	Get list of possible queries. More...

Variables
static const char	PREFIX_COOKIE = '_'
	Cookie prefix. More...

static const std::string	SPECIAL_CHARACTERS = "!@#$%^&*()-+=[]{};:'\"\\\|,.<>/?"
	Special characters. More...

static const std::string	PREFIX_DATAFILTER = "DAQ_triggerParameters"
	This string is prepended to every parameter in the database output for the corresponding process. More...

static const std::string	PREFIX_ADF = "DAQ_ADF"

static const JDetectorsHelper &	getDetector = JDetectorsHelper::getInstance()
	Function object for mapping serial number and object identifier of detectors. More...

static const Selector::RelOp *const	OPERAND []
	Available operands. More...

static const int	NUMBER_OF_OPERANDS = sizeof(OPERAND) / sizeof(OPERAND[0])
	Number of available operands. More...

Detailed Description

Auxiliary classes and methods for database I/O.

Author: mdejong

Typedef Documentation

◆ JPeriod_t

typedef JTOOLS::JRange<JDate_t> JDATABASE::JPeriod_t

Type definition of period.

Definition at line 159 of file JDetectorIntegration.hh.

Function Documentation

◆ getPrivateCookie()

const char* JDATABASE::getPrivateCookie ( )

inline

Get private cookie.

Returns: cookie

Definition at line 46 of file JDB.hh.

   {
     const char* home = getenv("HOME");
  
     return MAKE_CSTRING((home != NULL ? home : ".") << "/" << ".km3netdb_cookie");
   }

◆ getPublicCookie()

const char* JDATABASE::getPublicCookie ( )

inline

Get public cookie.

Returns: cookie

Definition at line 59 of file JDB.hh.

   {
     return getenv("DBCOOKIE");
   }

◆ operator>>() [1/3]

template<class T >

bool JDATABASE::operator>>	(	ResultSet &	rs,
		T &	object
	)

inline

Read ROOT object from result set.

Parameters

rs	result set
object	object

Returns: true if read; else false

Definition at line 295 of file JDB.hh.

   {
     static JDBReader<T> reader;
  
     if (rs.Next()) {
  
       object = reader(rs);
  
       return true;
     }
  
     return false;
   }

◆ operator>>() [2/3]

template<class JElement_t , class JAllocator_t >

bool JDATABASE::operator>>	(	ResultSet &	rs,
		std::vector< JElement_t, JAllocator_t > &	buffer
	)

inline

Read vector of ROOT objects from result set.

Parameters

rs	result set
buffer

Returns: true if read; else false

Definition at line 318 of file JDB.hh.

   {
     for (JElement_t object; rs >> object; ) {
       buffer.push_back(object);
     }
  
     return true;
   }

◆ getTable()

template<class JTable_t >

const char* JDATABASE::getTable ( )

inline

Get table name.

Returns: table name

Definition at line 334 of file JDB.hh.

   {
     return JTable_t::getName();
   }

◆ getColumn()

template<class JTable_t , class JType_t >

const char* JDATABASE::getColumn ( JType_t JTable_t::* data_member )

inline

Get column name.

Parameters

data_member data member

Returns: column name

Definition at line 347 of file JDB.hh.

   {
     JTable_t* pc = NULL;
     TClass*   rc = dynamic_cast<TClass*>(TDictionary::GetDictionary(typeid(JTable_t)));
  
     if (rc != NULL) {
  
       TIterator* i = rc->GetListOfDataMembers()->MakeIterator();
  
       for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
  
         if (p->GetOffset() == (char*) &(pc->*data_member) - (char*) pc) {
           return p->GetName();
         }
       }
     }
  
     return NULL;
   }

◆ getColumns()

template<class JTable_t >

std::vector<std::string> JDATABASE::getColumns ( )

inline

Get column names.

Returns: column names

Definition at line 374 of file JDB.hh.

   {
     using namespace JPP;
  
     std::vector<std::string> buffer;
  
     TClass*   rc = dynamic_cast<TClass*>(TDictionary::GetDictionary(typeid(JTable_t)));
  
     if (rc != NULL) {
  
       TIterator* i = rc->GetListOfDataMembers()->MakeIterator();
  
       for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
         if (JRootClass::is_class(*p)) {
           buffer.push_back(p->GetName());
         }
       }
     }
  
     return buffer;
   }

◆ getResultSet() [1/2]

ResultSet& JDATABASE::getResultSet ( const std::string & query )

inline

Get result set.

Parameters

query query / table name

Returns: result set

Definition at line 403 of file JDB.hh.

   {
     return JDB::get()->StreamDS(query.c_str(), std::vector<Selector>());
   }

◆ getResultSet() [2/2]

ResultSet& JDATABASE::getResultSet	(	const std::string &	query,
		const std::vector< Selector > &	selection
	)

inline

Get result set.

Parameters

query	query / table name
selection	selection

Returns: result set

Definition at line 416 of file JDB.hh.

   {
     return JDB::get()->StreamDS(query.c_str(), selection);
   }

◆ operator<<()

std::ostream& JDATABASE::operator<<	(	std::ostream &	out,
		const JPeriod_t &	object
	)

inline

Write period to output stream.

Parameters

out	output stream
object	period

Returns: output stream

Definition at line 169 of file JDetectorIntegration.hh.

   {
     return out << "(" << object.getLowerLimit() << "," << object.getUpperLimit() << ")";
   }

◆ operator>>() [3/3]

bool JDATABASE::operator>>	(	ResultSet &	rs,
		JRunQuality &	quality
	)

Read data quality from result set.

Parameters

rs	result set
quality	quality

Returns: true if read; else false

Definition at line 59 of file JRunQuality.cc.

   {
     using namespace std;
     using namespace JPP;
  
     quality.run = -1;
  
     for (JRunSummaryNumbers parameters; ; ) {
  
       bool has_next = false;
  
       try {
         has_next = (rs >> parameters);
       }
       catch(const exception& error) {
         has_next = false;
       }
  
       if (parameters.RUN != quality.run || !has_next) {
         
         if        (quality.run != -1) {
  
           return true;
  
         } else if (!has_next) {
  
           rs.Close();
           
           return false;
         }
  
         quality          =  JRunQuality();
         quality.GIT      =  parameters.SOURCE_NAME;
         quality.detector =  getDetector(parameters.DETID);
         quality.run      =  parameters.RUN;
       }
  
       quality.put(parameters.PARAMETER_NAME, parameters.DATA_VALUE);
     }
   }

◆ operator<() [1/2]

bool JDATABASE::operator<	(	const JRunQuality &	first,
		const JRunQuality &	second
	)

inline

Less-than operator.

Parameters

first	first run quaility
second	second run quaility

Returns: true if first run quality less than second; else false

Definition at line 149 of file JRunQuality.hh.

   {
     if (first.detector == second.detector)
       return first.run      < second.run;
     else
       return first.detector < second.detector;
   }

◆ operator<() [2/2]

bool JDATABASE::operator<	(	const JRuns &	first,
		const JRuns &	second
	)

inline

Less-than operator.

Parameters

first	first run
second	second run

Returns: true if first run less than second; else false

Definition at line 56 of file JRuns.hh.

   {
     if (first.DETID == second.DETID)
       return first.RUN   < second.RUN;
     else
       return first.DETID < second.DETID;
   }

◆ getOperand()

const Selector::RelOp& JDATABASE::getOperand ( const int index )

inline

Get operand.

Parameters

index index

Returns: operand

Definition at line 55 of file JDB/JSelector.hh.

   {
     if (index >= 0 && index <= NUMBER_OF_OPERANDS)
       return *OPERAND[index];
     else
       THROW(JIndexOutOfRange, "Invalid index " << index);
   }

◆ getQueries()

template<class JTypelist_t >

const std::vector<std::string>& JDATABASE::getQueries ( )

inline

Get list of possible queries.

Returns: list of possible queries

Definition at line 238 of file JDB/JSupport.hh.

   { 
     static const JQueries<JTypelist_t> buffer;
  
     return buffer;
   }

Variable Documentation

◆ PREFIX_COOKIE

const char JDATABASE::PREFIX_COOKIE = '_'

static

Cookie prefix.

Definition at line 68 of file JDB.hh.

◆ SPECIAL_CHARACTERS

const std::string JDATABASE::SPECIAL_CHARACTERS = "!@#$%^&*()-+=[]{};:'\"\\|,.<>/?"

static

Special characters.

Definition at line 74 of file JDB.hh.

◆ PREFIX_DATAFILTER

const std::string JDATABASE::PREFIX_DATAFILTER = "DAQ_triggerParameters"

static

This string is prepended to every parameter in the database output for the corresponding process.

Definition at line 80 of file JDB.hh.

◆ PREFIX_ADF

const std::string JDATABASE::PREFIX_ADF = "DAQ_ADF"

static

Definition at line 81 of file JDB.hh.

◆ getDetector

const JDetectorsHelper& JDATABASE::getDetector = JDetectorsHelper::getInstance()

static

Function object for mapping serial number and object identifier of detectors.

Definition at line 131 of file JDBToolkit.hh.

◆ OPERAND

const Selector::RelOp* const JDATABASE::OPERAND[]

static

Initial value:

= 
    {
      &Selector::RelOp::Equal,
      &Selector::RelOp::Different,
      &Selector::RelOp::Less,
      &Selector::RelOp::LessEqual,
      &Selector::RelOp::Greater,
      &Selector::RelOp::GreaterEqual
    }

Available operands.

Definition at line 32 of file JDB/JSelector.hh.

◆ NUMBER_OF_OPERANDS

const int JDATABASE::NUMBER_OF_OPERANDS = sizeof(OPERAND) / sizeof(OPERAND[0])

static

Number of available operands.

Definition at line 46 of file JDB/JSelector.hh.

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ JPeriod_t

Function Documentation

◆ getPrivateCookie()

◆ getPublicCookie()

◆ operator>>() [1/3]

◆ operator>>() [2/3]

◆ getTable()

◆ getColumn()

◆ getColumns()

◆ getResultSet() [1/2]

◆ getResultSet() [2/2]

◆ operator<<()

◆ operator>>() [3/3]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ getOperand()

◆ getQueries()

Variable Documentation

◆ PREFIX_COOKIE

◆ SPECIAL_CHARACTERS

◆ PREFIX_DATAFILTER

◆ PREFIX_ADF

◆ getDetector

◆ OPERAND

◆ NUMBER_OF_OPERANDS