ParticleWeightingAxis Class Reference

Class for handling LookUp tables. More...

#include <ParticleWeightingAxis.h>

Collaboration diagram for ParticleWeightingAxis:

Public Member Functions
	ParticleWeightingAxis ()
	Constructor.
std::string	getName ()
	Returns name of an axis.
void	setName (const std::string &name)
	Sets name of an axis. More...
int	addBin (ParticleWeightingBinLimits *bin)
	Check if bin exists and creates it if not. More...
int	findBin (ParticleWeightingBinLimits *bin)
	Returns id of bin with given bin limits Returns out-of-range binID if can't find. More...
int	findBin (double value)
	Returns id of bin containig value. More...
void	printAxis ()
	Prints axis information to the B2INFO stream.

Private Member Functions
bool	isOverlappingBin (ParticleWeightingBinLimits *bin)
	Return TRUE if bin exisits or overlaps with existing. More...

Private Attributes
BinMap	m_unnamedAxis
	Named axis with bins.
std::string	m_axisName
	Axis name.
const int	m_outOfRangeBinID = -1
	ID of out-of-range bin.

Detailed Description

Class for handling LookUp tables.

Definition at line 36 of file ParticleWeightingAxis.h.

Member Function Documentation

addBin()

int addBin

(

ParticleWeightingBinLimits *

bin

)

Check if bin exists and creates it if not.

Returns bin ID Issues fatal error in case of ovarlaping bins.

Parameters

bin	bin limits

Returns

key ID

Definition at line 48 of file ParticleWeightingAxis.cc.

{
  int existing_id = this->findBin(bin);
  if (existing_id != m_outOfRangeBinID) {
    return existing_id;
  }
  if (this->isOverlappingBin(bin)) {
    B2FATAL("Attepting to add overlapping or existing bin");
  } else {
    int id = m_unnamedAxis.size() + 1;
    m_unnamedAxis.insert(std::make_pair(id, bin));
    return id;
  }
}

findBin() [1/2]

int findBin

(

double

value

)

Returns id of bin containig value.

Parameters

value

value

Returns

key ID

Definition at line 75 of file ParticleWeightingAxis.cc.

findBin() [2/2]

int findBin

(

ParticleWeightingBinLimits *

bin

)

Returns id of bin with given bin limits Returns out-of-range binID if can't find.

Parameters

bin	bin limits

Returns

key ID

Definition at line 64 of file ParticleWeightingAxis.cc.

isOverlappingBin()

bool isOverlappingBin ( ParticleWeightingBinLimits *  bin )

private

Return TRUE if bin exisits or overlaps with existing.

Parameters

bin	- tested bin

Returns

is this bin overlatpping with existing bins or not

Checkin gif lower border is within some bin existing binning: | | new binning: | |

Checking if upper border is within some bin existing binning: | | new binning: | |

Checking if new bin covers exiting bin completely existing binning: | | new binning: | |

Definition at line 16 of file ParticleWeightingAxis.cc.

setName()

void setName ( const std::string &  name )

inline

Sets name of an axis.

Parameters

name

axis name

Definition at line 67 of file ParticleWeightingAxis.h.

---

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

• analysis/dbobjects/include/ParticleWeightingAxis.h
• analysis/dbobjects/src/ParticleWeightingAxis.cc