icarus::trigger::TriggerGateIndex< GateObject > Class Template Reference

Associates each optical detector channel to a gate. More...

#include <SlidingWindowCombinerAlg.h>

Public Types
using	TriggerGate_t = GateObject
	Type of gate the index lists. More...

Public Member Functions
	TriggerGateIndex (std::size_t expectedChannels=0U)
	TriggerGateIndex (std::vector< TriggerGate_t > const &gates)
	Initializes the index from all the gates in the specified collection. More...
void	add (TriggerGate_t const &gate)
unsigned int	nChannels () const
	Returns the total number of registered channels. More...
TriggerGate_t const *	find (raw::Channel_t const channel) const
	Returns the gate corresponding to the specified channel. More...
TriggerGate_t const &	operator[] (raw::Channel_t const channel) const

Private Member Functions
bool	expandToHold (std::size_t chIndex)

Static Private Member Functions
static std::size_t	channelIndex (raw::Channel_t channel)
	Converts a channel number into an index. More...

Private Attributes
std::vector< TriggerGate_t const * >	fGates
	Index of gates by channel number (the same gate may appear many times). More...

Detailed Description

template<typename GateObject>
class icarus::trigger::TriggerGateIndex< GateObject >

Associates each optical detector channel to a gate.

Definition at line 37 of file SlidingWindowCombinerAlg.h.

Member Typedef Documentation

template<typename GateObject >

using icarus::trigger::TriggerGateIndex< GateObject >::TriggerGate_t = GateObject

Type of gate the index lists.

Definition at line 330 of file TriggerDataUtils.h.

Constructor & Destructor Documentation

template<typename GateObject >

icarus::trigger::TriggerGateIndex< GateObject >::TriggerGateIndex

(

std::size_t

expectedChannels = 0U

)

Constructs an empty index expecting to be filled by expectedChannels registered channels.

Definition at line 663 of file TriggerDataUtils.h.

{
  if (expectedChannels > 0) fGates.reserve(expectedChannels);
} // icarus::trigger::TriggerGateIndex::TriggerGateIndex(size_t)

template<typename GateObject >

icarus::trigger::TriggerGateIndex< GateObject >::TriggerGateIndex

(

std::vector< TriggerGate_t > const &

gates

)

Initializes the index from all the gates in the specified collection.

Definition at line 671 of file TriggerDataUtils.h.

{
  for (TriggerGate_t const& gate: gates) add(gate);
} // icarus::trigger::TriggerGateIndex::TriggerGateIndex(gates)

Member Function Documentation

template<typename GateObject >

void icarus::trigger::TriggerGateIndex< GateObject >::add

(

TriggerGate_t const &

gate

)

Adds a new gate to the index.

Exceptions

cet::exception

("TriggerGateIndex") if it conflicts with a gate already added

Definition at line 680 of file TriggerDataUtils.h.

{

  for (raw::Channel_t const channel: gate.channels()) {
    auto const chIndex = static_cast<std::size_t>(channel);

    if (expandToHold(chIndex) || !fGates[chIndex]) {
      fGates[chIndex] = &gate;
    }
    else if (fGates[chIndex] != &gate) {
      throw cet::exception("TriggerGateIndex") << "TriggerGateIndex::add(): "
        << "A gate was already present for channel " << channel << ".\n";
    }

  } // for

} // icarus::trigger::TriggerGateIndex::add()

template<typename GateObject >

std::size_t icarus::trigger::TriggerGateIndex< GateObject >::channelIndex ( raw::Channel_t  channel )

staticprivate

Converts a channel number into an index.

Definition at line 743 of file TriggerDataUtils.h.

  { return static_cast<std::size_t>(channel); }

template<typename GateObject >

bool icarus::trigger::TriggerGateIndex< GateObject >::expandToHold ( std::size_t  chIndex )

private

Extends internal map with nullptr to hold at least chIndex.

Returns

whether an extension was performed

Definition at line 729 of file TriggerDataUtils.h.

{

  if (chIndex < fGates.size()) return false;

  fGates.resize(chIndex + 1U, nullptr);
  return true;

} // icarus::trigger::TriggerGateIndex::expandToHold()

template<typename GateObject >

auto icarus::trigger::TriggerGateIndex< GateObject >::find

(

raw::Channel_t const

channel

)

const

Returns the gate corresponding to the specified channel.

Definition at line 708 of file TriggerDataUtils.h.

{
  auto const chIndex = channelIndex(channel);
  return (chIndex < nChannels())? fGates[chIndex]: nullptr;
} // icarus::trigger::TriggerGateIndex::find()

template<typename GateObject >

unsigned int icarus::trigger::TriggerGateIndex< GateObject >::nChannels

(

)

const

Returns the total number of registered channels.

Definition at line 701 of file TriggerDataUtils.h.

  { return static_cast<unsigned int>(fGates.size()); }

template<typename GateObject >

auto icarus::trigger::TriggerGateIndex< GateObject >::operator[]

(

raw::Channel_t const

channel

)

const

Returns the gate corresponding to the specified channel.

Exceptions

std::out_of_range

if the channel is not registered

Definition at line 718 of file TriggerDataUtils.h.

{
  auto const gate = find(channel);
  if (gate) return *gate;
  throw std::out_of_range(std::to_string(channel));
} // icarus::trigger::TriggerGateIndex::operator[]()

Member Data Documentation

template<typename GateObject >

std::vector<TriggerGate_t const*> icarus::trigger::TriggerGateIndex< GateObject >::fGates

private

Index of gates by channel number (the same gate may appear many times).

Definition at line 357 of file TriggerDataUtils.h.

---

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

• SlidingWindowCombinerAlg.h
• TriggerDataUtils.h