asg::AcceptInfo Class Reference

#include <AcceptInfo.h>

Collaboration diagram for asg::AcceptInfo:

Public Member Functions
	AcceptInfo (const char *name="AcceptInfo")
	Standard constructor.
const char *	getName () const
	Get the name of the class instance.
unsigned int	getNCuts () const
	Get the number of cuts defined.
const std::bitset< NBITS > &	getCutMask () const
	Get a bitmask for all cuts defined.
int	addCut (const std::string &cutName, const std::string &cutDescription)
	Add a cut; returning the cut position.
unsigned int	getCutPosition (std::string_view cutName) const
	Get the bit position of a cut.
const std::string &	getCutName (unsigned int cutPosition) const
	Get the name of a cut, based on the cut position (slow, avoid usage).
const std::string &	getCutDescription (const std::string &cutName) const
	Get the description of a cut, based on the cut name.
const std::string &	getCutDescription (unsigned int cutPosition) const
	Get the description of a cut, based on the cut position.
void	setCutDescription (const std::string &cutName, const std::string &cutDescription)
	Set the result of a cut, based on the cut name (safer).
void	setCutDescription (unsigned int cutPosition, const std::string &cutDescription)
	Get the result of a cut, based on the cut position (faster).

Static Public Attributes
static const unsigned int	NBITS =32
	The number of bits for cuts.

Private Attributes
std::string	m_name
	The name of the class instance.
std::map< std::string, std::pair< std::string, unsigned int >, std::less<> >	m_cutMap
	The map for mapping cut names to their description and position.
std::bitset< NBITS >	m_cutMask
	A bitmap that provides a mask that only leaves defined cuts.

Detailed Description

Definition at line 27 of file AcceptInfo.h.

Constructor & Destructor Documentation

AcceptInfo()

asg::AcceptInfo::AcceptInfo ( const char * name = "AcceptInfo" )

inline

Standard constructor.

Definition at line 35 of file AcceptInfo.h.

      : m_name(name),
        m_cutMap()
    {}

Member Function Documentation

addCut()

int asg::AcceptInfo::addCut ( const std::string & cutName, const std::string & cutDescription )

inline

Add a cut; returning the cut position.

Definition at line 53 of file AcceptInfo.h.

    {
      // Make sure that this new cuts doesn't exceed the number of bits available
      if ( m_cutMap.size() >= NBITS )
      {
        return -1;
      }
 
      // Add the cut to the map
      std::pair< std::string, unsigned int > cutPair = std::make_pair( cutDescription, m_cutMap.size() );
      m_cutMap.insert( std::make_pair( cutName, cutPair ) );
 
      // Return the position of the newly added cut in the bitmask
      int result = (m_cutMap.size() - 1);
      m_cutMask.set (result);
      return result;
    }

getCutDescription() [1/2]

const std::string & AcceptInfo::getCutDescription

(

const std::string &

cutName

)

const

Get the description of a cut, based on the cut name.

Definition at line 119 of file AcceptInfo.cxx.

{
  static const std::string emptyString;
  auto it = m_cutMap.find(cutName);
  return (it != m_cutMap.end()) ? (it->second).first : emptyString;
}

getCutDescription() [2/2]

const std::string & AcceptInfo::getCutDescription

(

unsigned int

cutPosition

)

const

Get the description of a cut, based on the cut position.

Definition at line 66 of file AcceptInfo.cxx.

{
  static const std::string emptyString;
 
  // Make sure that this cut doesn't exceed the number of defined cuts
  if ( cutPosition >= m_cutMap.size() )
    {
      return emptyString;
    }
 
  // iterate over the map and find the right position
  auto it    = m_cutMap.begin();
  auto itEnd = m_cutMap.end();
  for ( ; it != itEnd; ++it )
    {
      if ( (it->second).second == cutPosition )
        {
          return (it->second).first;
        }
    }
 
  return emptyString;
}

getCutMask()

const std::bitset< NBITS > & asg::AcceptInfo::getCutMask ( ) const

inline

Get a bitmask for all cuts defined.

Definition at line 49 of file AcceptInfo.h.

{ return m_cutMask; };

getCutName()

const std::string & AcceptInfo::getCutName

(

unsigned int

cutPosition

)

const

Get the name of a cut, based on the cut position (slow, avoid usage).

Definition at line 36 of file AcceptInfo.cxx.

{
  static const std::string emptyString;
 
  // Make sure that this cut doesn't exceed the number of defined cuts
  if ( cutPosition >= m_cutMap.size() )
    {
      return emptyString;
    }
 
  // iterate over the map and find the right position
  auto it    = m_cutMap.begin();
  auto itEnd = m_cutMap.end();
  for ( ; it != itEnd; ++it )
    {
      if ( (it->second).second == cutPosition )
        {
          return (it->first);
        }
    }
 
  return emptyString;
}

getCutPosition()

unsigned int asg::AcceptInfo::getCutPosition ( std::string_view cutName ) const

inline

Get the bit position of a cut.

Definition at line 73 of file AcceptInfo.h.

    {
      auto it = m_cutMap.find(cutName);
      return (it != m_cutMap.end()) ? (it->second).second : 999999;
    }

getName()

const char * asg::AcceptInfo::getName ( ) const

inline

Get the name of the class instance.

Definition at line 43 of file AcceptInfo.h.

{ return m_name.c_str(); };

getNCuts()

unsigned int asg::AcceptInfo::getNCuts ( ) const

inline

Get the number of cuts defined.

Definition at line 46 of file AcceptInfo.h.

{ return m_cutMap.size(); };

setCutDescription() [1/2]

void asg::AcceptInfo::setCutDescription ( const std::string & cutName, const std::string & cutDescription )

inline

Set the result of a cut, based on the cut name (safer).

Definition at line 92 of file AcceptInfo.h.

    {
      unsigned int cutPosition = getCutPosition(cutName);
      return setCutDescription( cutPosition, cutDescription );
    }

setCutDescription() [2/2]

void AcceptInfo::setCutDescription	(	unsigned int	cutPosition,
		const std::string &	cutDescription )

Get the result of a cut, based on the cut position (faster).

Definition at line 97 of file AcceptInfo.cxx.

{
  // iterate over the map and find the right position
  auto it    = m_cutMap.begin();
  auto itEnd = m_cutMap.end();
  for ( ; it != itEnd; ++it )
    {
      if ( (it->second).second == cutPosition )
        {
          ((it->second).first) = cutDescription;
          return;
        }
    }
 
  return;
}

Member Data Documentation

m_cutMap

std::map< std::string, std::pair< std::string, unsigned int > , std::less<> > asg::AcceptInfo::m_cutMap

private

The map for mapping cut names to their description and position.

Definition at line 109 of file AcceptInfo.h.

m_cutMask

std::bitset<NBITS> asg::AcceptInfo::m_cutMask

private

A bitmap that provides a mask that only leaves defined cuts.

Definition at line 112 of file AcceptInfo.h.

m_name

std::string asg::AcceptInfo::m_name

private

The name of the class instance.

Definition at line 106 of file AcceptInfo.h.

NBITS

const unsigned int asg::AcceptInfo::NBITS =32

static

The number of bits for cuts.

Definition at line 32 of file AcceptInfo.h.

---

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

• AcceptInfo.h
• AcceptInfo.cxx