daq::details::BoardSetup_t::ChannelSetup_t Struct Reference

Special settings for one channel on the board. More...

#include <PMTDecoderUtils.h>

Public Member Functions
bool	hasChannel () const
	Returns if this channel is associated to a off-line channel number. More...
bool	mustSkip () const
	Whether this channel is requested to be skipped. More...
bool	mustSave () const
	Whether this channel is requested to be saved. More...
bool	isDefault () const
	Returns whether this is the default configuration. More...

Static Public Member Functions
static bool	isChannel (raw::Channel_t channel)
	Returns if channel is a valid channel ID. More...

Public Attributes
raw::Channel_t	channelID = sbn::V1730channelConfiguration::NoChannelID
	Associated off-line (LArSoft) channel ID. More...
std::optional< bool >	forcedSkip
	Whether the channel should be forcedly ignored or acquired. More...
bool	onGlobalOnly = false
	Save the channel only when including the global trigger time. More...
std::uint16_t	minSpan = 0
	Minimum acceptable waveform span. More...
std::string	category
	Category of this channel (will become instance name). More...

Detailed Description

Special settings for one channel on the board.

Definition at line 51 of file PMTDecoderUtils.h.

Member Function Documentation

bool daq::details::BoardSetup_t::ChannelSetup_t::hasChannel ( ) const

inline

Returns if this channel is associated to a off-line channel number.

Definition at line 68 of file PMTDecoderUtils.h.

{ return isChannel(channelID); }

static bool daq::details::BoardSetup_t::ChannelSetup_t::isChannel ( raw::Channel_t  channel )

inlinestatic

Returns if channel is a valid channel ID.

Definition at line 86 of file PMTDecoderUtils.h.

        { return channel != sbn::V1730channelConfiguration::NoChannelID; }

bool daq::details::BoardSetup_t::ChannelSetup_t::isDefault ( ) const

inline

Returns whether this is the default configuration.

Definition at line 77 of file PMTDecoderUtils.h.

        {
          // C++20: equality operator might be automatically generated
          // return *this == ChannelSetup_t{}; 
          return !hasChannel()
            && !forcedSkip && !onGlobalOnly && category.empty();
        }

bool daq::details::BoardSetup_t::ChannelSetup_t::mustSave ( ) const

inline

Whether this channel is requested to be saved.

Definition at line 74 of file PMTDecoderUtils.h.

{ return !forcedSkip.value_or(true); }

bool daq::details::BoardSetup_t::ChannelSetup_t::mustSkip ( ) const

inline

Whether this channel is requested to be skipped.

Definition at line 71 of file PMTDecoderUtils.h.

{ return forcedSkip.value_or(false); }

Member Data Documentation

std::string daq::details::BoardSetup_t::ChannelSetup_t::category

Category of this channel (will become instance name).

Definition at line 65 of file PMTDecoderUtils.h.

raw::Channel_t daq::details::BoardSetup_t::ChannelSetup_t::channelID = sbn::V1730channelConfiguration::NoChannelID

Associated off-line (LArSoft) channel ID.

Definition at line 54 of file PMTDecoderUtils.h.

std::optional<bool> daq::details::BoardSetup_t::ChannelSetup_t::forcedSkip

Whether the channel should be forcedly ignored or acquired.

Definition at line 57 of file PMTDecoderUtils.h.

std::uint16_t daq::details::BoardSetup_t::ChannelSetup_t::minSpan = 0

Minimum acceptable waveform span.

Definition at line 62 of file PMTDecoderUtils.h.

bool daq::details::BoardSetup_t::ChannelSetup_t::onGlobalOnly = false

Save the channel only when including the global trigger time.

Definition at line 60 of file PMTDecoderUtils.h.

---

The documentation for this struct was generated from the following file:

• PMTDecoderUtils.h