A class that describes the interval of experiments/runs for which an object in the database is valid. More...

#include <IntervalOfValidity.h>

Public Member Functions
	IntervalOfValidity ()
	Default constructor which will create an empty iov.

	IntervalOfValidity (int experimentLow, int runLow, int experimentHigh, int runHigh)
	Construct a new iov.

	~IntervalOfValidity ()=default
	Destructor.

bool	contains (const int experiment, const int run) const
	Function that checks whether the (experiment, run) is inside the validity interval.

bool	contains (const EventMetaData &event) const
	Function that checks whether the event is inside the validity interval.

bool	empty () const
	Function that checks whether the validity interval is empty.

bool	operator== (const IntervalOfValidity &other) const
	Check whether two intervals of validity are identical.

bool	operator!= (const IntervalOfValidity &other) const
	Check whether two intervals of validity are different.

bool	contains (const IntervalOfValidity &iov) const
	Function that checks the validity interval contains another interval of validity.

bool	overlaps (const IntervalOfValidity &iov) const
	Function that checks the validity interval overlaps with another interval of validity.

IntervalOfValidity	overlap (const IntervalOfValidity &iov) const
	Function that determines the overlap of the validity interval with another interval of validity.

bool	trimOverlap (IntervalOfValidity &iov, bool trimOlder=true)
	Remove the overlap between two intervals of validity by shortening one of them.

int	getExperimentLow () const
	Getter for lowest experiment number.

int	getRunLow () const
	Getter for lowest run number.

int	getExperimentHigh () const
	Getter for highest experiment number.

int	getRunHigh () const
	Getter for highest run number.

Static Public Member Functions
static IntervalOfValidity	always ()
	Function that returns an interval of validity that is always valid, c.f.

Private Member Functions
int	checkLowerBound (int experiment, int run) const
	Helper function to check whether a given experiment/run number is above or below the lower bound of the interval of validity.

int	checkUpperBound (int experiment, int run) const
	Helper function to check whether a given experiment/run number is above or below the upper bound of the interval of validity.

void	makeValid ()
	Helper function to set the interval to empty if the upper bound is below the lower one.

	ClassDefNV (IntervalOfValidity, 2)
	describes the interval of experiments/runs for which an object in the database is valid.

Private Attributes
int	m_experimentLow
	Lowest experiment number.

int	m_runLow
	Lowest run number.

int	m_experimentHigh
	Highest experiment number.

int	m_runHigh
	Highest run number.

Friends
std::istream &	operator>> (std::istream &input, IntervalOfValidity &iov)
	Input stream operator for reading IoV data from a text file.

std::ostream &	operator<< (std::ostream &output, const IntervalOfValidity &iov)
	Output stream operator for writing IoV data to a text file.

Detailed Description

A class that describes the interval of experiments/runs for which an object in the database is valid.

Definition at line 25 of file IntervalOfValidity.h.

Constructor & Destructor Documentation

◆ IntervalOfValidity() [1/2]

IntervalOfValidity ( )

inline

Default constructor which will create an empty iov.

Definition at line 28 of file IntervalOfValidity.h.

28: IntervalOfValidity(-1, -1, -1, -1) {}

◆ IntervalOfValidity() [2/2]

IntervalOfValidity	(	int	experimentLow,
		int	runLow,
		int	experimentHigh,
		int	runHigh )

Construct a new iov.

Parameters

experimentLow	lowest experiment number of the validity range, -1 means no bound
runLow	lowest run number in the experiment with number experimentLow of the validity range, -1 means no bound
experimentHigh	highest experiment number of the validity range, -1 means no bound
runHigh	highest run number in the experiment with number experimentHigh of the validity range, -1 means no bound

Definition at line 17 of file IntervalOfValidity.cc.

                                                    : m_experimentLow(experimentLow), m_runLow(runLow), m_experimentHigh(experimentHigh), m_runHigh(runHigh)
{
  // consistency checks
  if ((experimentLow < 0) && (runLow >= 0)) {
    B2ERROR("A run number of " << runLow << " is given for an undefined low experiment number. Setting run to undefined, too.");
    m_runLow = -1;
  }
  if ((experimentHigh < 0) && (runHigh >= 0)) {
    B2ERROR("A run number of " << runHigh << " is given for an undefined high experiment number. Setting run to undefined, too.");
    m_runHigh = -1;
  }
  if ((experimentLow >= 0) && (experimentHigh >= 0)) {
    if ((experimentLow > experimentHigh) || ((experimentLow == experimentHigh) && (runHigh >= 0) && (runLow > runHigh))) {
      B2ERROR("The given lower and higher experiment/run numbers of " << experimentLow << "/" << runLow << " and " << experimentHigh <<
              "/" << runHigh << ", respectively, are in the wrong order, Swapping them.");
      std::swap(m_experimentLow, m_experimentHigh);
      std::swap(m_runLow, m_runHigh);
    }
  }
}

Member Function Documentation

◆ always()

static IntervalOfValidity always ( )

inlinestatic

Function that returns an interval of validity that is always valid, c.f.

the default constructor which is never valid (a zero interval)

Returns: an interval of validity that is always valid

Definition at line 70 of file IntervalOfValidity.h.

70{return IntervalOfValidity(0, 0, -1, -1);};

◆ checkLowerBound()

int checkLowerBound	(	int	experiment,
		int	run ) const

private

Helper function to check whether a given experiment/run number is above or below the lower bound of the interval of validity.

Parameters

experiment	the experiment number
run	the run number

Returns: 0 if the given experiment/run number is equal to the lower bound, -1 if it is below the lower bound, 1 if it is above the lower bound.

Definition at line 40 of file IntervalOfValidity.cc.

{
  // check for empty interval
  if (empty()) return false;
 
  if ((m_experimentLow == experiment) && (m_runLow == run)) return 0;
  if (m_experimentLow < 0) return 1;
  if (experiment < m_experimentLow) return -1;
  if (experiment == m_experimentLow) {
    if (run < m_runLow) return -1;
  }
  return 1;
}

◆ checkUpperBound()

int checkUpperBound	(	int	experiment,
		int	run ) const

private

Helper function to check whether a given experiment/run number is above or below the upper bound of the interval of validity.

Parameters

experiment	the experiment number
run	the run number

Returns: 0 if the given experiment/run number is equal to the upper bound, -1 if it is below the upper bound, 1 if it is above the upper bound.

Definition at line 54 of file IntervalOfValidity.cc.

{
  // check for empty interval
  if (empty()) return false;
 
  if ((m_experimentHigh == experiment) && (m_runHigh == run)) return 0;
  if (m_experimentHigh < 0) return -1;
  if ((experiment < 0) || (experiment > m_experimentHigh)) return 1;
  if (experiment == m_experimentHigh) {
    if ((m_runHigh >= 0) && ((run > m_runHigh) || (run < 0))) return 1;
  }
  return -1;
}

◆ contains() [1/3]

bool contains ( const EventMetaData & event ) const

Function that checks whether the event is inside the validity interval.

Parameters

event event meta data to be checked, if the run number 0 it's checked whether the whole experiment is inside the validity interval

Returns: true if the given event is inside the validity interval.

Definition at line 90 of file IntervalOfValidity.cc.

{
  auto experiment = (int) event.getExperiment();
  auto run = (int) event.getRun();
  return contains(experiment, run);
}

◆ contains() [2/3]

bool contains	(	const int	experiment,
		const int	run ) const

Function that checks whether the (experiment, run) is inside the validity interval.

Parameters

experiment	experiment number to be checked
run	run number to be checked; if the run number 0 it's checked whether the whole experiment is inside the validity interval

Returns: true if the given (experiment, run) is inside the validity interval.

Definition at line 79 of file IntervalOfValidity.cc.

{
  // check for empty interval
  if (empty()) return false;
 
  // check lower bound
  if (checkLowerBound(experiment, run) < 0) return false;
  if (checkUpperBound(experiment, run) > 0) return false;
  return true;
}

◆ contains() [3/3]

bool contains ( const IntervalOfValidity & iov ) const

inline

Function that checks the validity interval contains another interval of validity.

Parameters

iov	the other validity interval

Returns: true if the given other interval of validity is inside the validity interval.

Definition at line 94 of file IntervalOfValidity.h.

94{return overlap(iov) == iov;};

◆ empty()

bool empty ( ) const

inline

Function that checks whether the validity interval is empty.

Returns: true if the validity interval is empty.

Definition at line 63 of file IntervalOfValidity.h.

63{return ((m_experimentLow < 0) && (m_experimentHigh < 0));};

◆ getExperimentHigh()

int getExperimentHigh ( ) const

inline

Getter for highest experiment number.

-1 means no bound (unless it is a special case described below).

If both m_experimentHigh and m_experimentLow are equal to -1, interval is empty (doesn't match any experiments/runs).

Definition at line 145 of file IntervalOfValidity.h.

    {
      return m_experimentHigh;
    }

◆ getExperimentLow()

int getExperimentLow ( ) const

inline

Getter for lowest experiment number.

-1 means no bound (unless it is a special case described below).

If both m_experimentHigh and m_experimentLow are equal to -1, interval is empty (doesn't match any experiments/runs).

Definition at line 125 of file IntervalOfValidity.h.

    {
      return m_experimentLow;
    }

◆ getRunHigh()

int getRunHigh ( ) const

inline

Getter for highest run number.

-1 means no bound.

Definition at line 153 of file IntervalOfValidity.h.

    {
      return m_runHigh;
    }

◆ getRunLow()

int getRunLow ( ) const

inline

Getter for lowest run number.

-1 means no bound.

Definition at line 133 of file IntervalOfValidity.h.

    {
      return m_runLow;
    }

◆ makeValid()

void makeValid ( )

private

Helper function to set the interval to empty if the upper bound is below the lower one.

Definition at line 68 of file IntervalOfValidity.cc.

{
  if (m_experimentLow < 0) m_runLow = -1;
  if (m_experimentHigh < 0) m_runHigh = -1;
  if ((m_experimentLow >= 0) && (m_experimentHigh >= 0)) {
    if ((m_experimentLow > m_experimentHigh) || ((m_experimentLow == m_experimentHigh) && (m_runHigh >= 0) && (m_runLow > m_runHigh))) {
      m_experimentLow = m_runLow = m_experimentHigh = m_runHigh = -1;
    }
  }
}

◆ operator!=()

bool operator!= ( const IntervalOfValidity & other ) const

inline

Check whether two intervals of validity are different.

Definition at line 84 of file IntervalOfValidity.h.

    {
      return !(*this == other);
    }

◆ operator==()

bool operator== ( const IntervalOfValidity & other ) const

inline

Check whether two intervals of validity are identical.

Definition at line 75 of file IntervalOfValidity.h.

    {
      return (m_experimentLow == other.m_experimentLow) && (m_runLow == other.m_runLow) &&
             (m_experimentHigh == other.m_experimentHigh) && (m_runHigh == other.m_runHigh);
    }

◆ overlap()

IntervalOfValidity overlap ( const IntervalOfValidity & iov ) const

Function that determines the overlap of the validity interval with another interval of validity.

Parameters

iov	the other validity interval

Returns: the interval that is common to both intervals of validity.

Definition at line 97 of file IntervalOfValidity.cc.

{
  if (empty() || iov.empty()) return IntervalOfValidity();
 
  IntervalOfValidity result(*this);
  if (checkLowerBound(iov.m_experimentLow, iov.m_runLow) > 0) {
    result.m_experimentLow = iov.m_experimentLow;
    result.m_runLow = iov.m_runLow;
  }
  if (checkUpperBound(iov.m_experimentHigh, iov.m_runHigh) < 0) {
    result.m_experimentHigh = iov.m_experimentHigh;
    result.m_runHigh = iov.m_runHigh;
  }
 
  result.makeValid();
  return result;
}

◆ overlaps()

bool overlaps ( const IntervalOfValidity & iov ) const

inline

Function that checks the validity interval overlaps with another interval of validity.

Parameters

iov	the other validity interval

Returns: true if both intervals of validity have a common range.

Definition at line 101 of file IntervalOfValidity.h.

101{return !overlap(iov).empty();};

◆ trimOverlap()

bool trimOverlap	(	IntervalOfValidity &	iov,
		bool	trimOlder = true )

Remove the overlap between two intervals of validity by shortening one of them.

This does not work if an interval would be cut into two.

Parameters

iov	the other validity interval
trimOlder	flag to determine which validity interval should be trimmed based on the comparison of the lower range bound

Returns: true if the overlap could be removed.

Definition at line 115 of file IntervalOfValidity.cc.

{
  if (!overlaps(iov)) return true;
 
  bool thisOlder = checkLowerBound(iov.m_experimentLow, iov.m_runLow) >= 0;
  IntervalOfValidity& older = (thisOlder) ? *this : iov;
  IntervalOfValidity& younger = (thisOlder) ? iov : *this;
 
  if (trimOlder) {
    // check for the case where trimming is not possible because the interval would be split
    if (older.checkUpperBound(younger.m_experimentHigh, younger.m_runHigh) < 0) return false;
 
    older.m_experimentHigh = younger.m_experimentLow;
    older.m_runHigh = younger.m_runLow - 1;
    if (older.m_runHigh < 0) {
      older.m_experimentHigh--;
      older.m_runHigh = -1;
    }
    older.makeValid();
  } else {
    younger.m_experimentLow = older.m_experimentHigh;
    younger.m_runLow = older.m_runHigh + 1;
    if (younger.m_runLow == 0) {
      younger.m_experimentLow++;
    }
    younger.makeValid();
  }
 
  return true;
}

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	output,
		const IntervalOfValidity &	iov )

friend

Output stream operator for writing IoV data to a text file.

Parameters

output	The output stream.
iov	The IntervalOfValidity object.

Definition at line 197 of file IntervalOfValidity.cc.

  {
    output << iov.m_experimentLow << "," << iov.m_runLow << "," << iov.m_experimentHigh << "," << iov.m_runHigh;
 
    return output;
  }

◆ operator>>

std::istream & operator>>	(	std::istream &	input,
		IntervalOfValidity &	iov )

friend

Input stream operator for reading IoV data from a text file.

Parameters

input	The input stream.
iov	The InervalOfValidity object.

Definition at line 153 of file IntervalOfValidity.cc.

  {
    iov = IntervalOfValidity();
    if (!input.good()) {
      throw std::runtime_error("cannot read from stream");
    }
 
    std::string str[4];
    int index = 0;
    while (input.good()) {
      auto c = input.peek();
      if (c == EOF) break;
      if (((c == ' ') || (c == '\n') || (c == '\t'))) {
        //ignore whitespace in the beginning
        if (index == 0 && str[0].empty()) {
          input.get();
          continue;
        }
        //and stop parsing otherwise
        break;
      }
      if (c == ',') {
        index++;
        if (index == 4) break;
      } else {
        str[index] += c;
      }
      input.get();
    }
    if (index != 3) {
      throw std::invalid_argument("IoV needs to be four values (firstExp,firstRun,finalExp,finalRun)");
    }
    try {
      iov.m_experimentLow = stoi(str[0]);
      iov.m_runLow = stoi(str[1]);
      iov.m_experimentHigh = stoi(str[2]);
      iov.m_runHigh = stoi(str[3]);
    } catch (std::invalid_argument& e) {
      throw std::invalid_argument("experiment and run numbers must be integers");
    }
 
    return input;
  }

Member Data Documentation

◆ m_experimentHigh

int m_experimentHigh

private

Highest experiment number.

-1 means no bound.

Definition at line 184 of file IntervalOfValidity.h.

◆ m_experimentLow

int m_experimentLow

private

Lowest experiment number.

-1 means no bound.

Definition at line 176 of file IntervalOfValidity.h.

◆ m_runHigh

int m_runHigh

private

Highest run number.

-1 means no bound.

Definition at line 188 of file IntervalOfValidity.h.

◆ m_runLow

int m_runLow

private

Lowest run number.

-1 means no bound.

Definition at line 180 of file IntervalOfValidity.h.

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

framework/database/include/IntervalOfValidity.h
framework/database/src/IntervalOfValidity.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ IntervalOfValidity() [1/2]

◆ IntervalOfValidity() [2/2]

Member Function Documentation

◆ always()

◆ checkLowerBound()

◆ checkUpperBound()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ empty()

◆ getExperimentHigh()

◆ getExperimentLow()

◆ getRunHigh()

◆ getRunLow()

◆ makeValid()

◆ operator!=()

◆ operator==()

◆ overlap()

◆ overlaps()

◆ trimOverlap()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_experimentHigh

◆ m_experimentLow

◆ m_runHigh

◆ m_runLow