Class containing configuration for a V1730 channel. More...

#include <V1730channelConfiguration.h>

Public Member Functions
bool	hasChannelID () const
	Returns whether the channel ID is set. More...

short signed int	relativeThreshold () const
	Threshold relative to the baseline (ticks). More...

void	dump (std::ostream &out, std::string const &indent, std::string const &firstIndent, unsigned int verbosity=MaxDumpVerbosity) const
	Dumps the content of the configuration into `out` stream. More...

void	dump (std::ostream &out, std::string const &indent="") const
	Dumps the content of the configuration into `out` stream. More...

void	dump (std::ostream &out, unsigned int verbosity, std::string const &indent="") const
	Dumps the content of the configuration into `out` stream. More...


bool	operator== (V1730channelConfiguration const &other) const
	Comparison: all fields need to have the same values. More...

bool	operator!= (V1730channelConfiguration const &other) const

Public Attributes
short unsigned int	channelNo = std::numeric_limits<short unsigned int>::max()
	Number of the channel on the board (0-15). More...

raw::Channel_t	channelID = NoChannelID
	Offline channel ID. More...

short signed int	baseline = 0
	Baseline (`BaselineCh<N+1>`). More...

short signed int	threshold = 0
	Threshold (`triggerThreshold<N>`). More...

bool	enabled = false
	Channel is enabled (`enable`). More...

Static Public Attributes
static constexpr auto	NoChannelID = std::numeric_limits<raw::Channel_t>::max()
	Special value for unassigned channel ID. More...

static constexpr unsigned int	MaxDumpVerbosity = 1U
	Maximum supported verbosity level supported by `dump()`. More...

static constexpr unsigned int	DefaultDumpVerbosity = MaxDumpVerbosity
	Default verbosity level for `dump()`. More...

Detailed Description

Class containing configuration for a V1730 channel.

This is an informative class containing configuration of a V1730 channel extracted from some other source (typically, DAQ) made readily available to the users.

This class does not include any configuration extraction code.

The class is default-constructible only, and its content needs to be added element by element.

Definition at line 45 of file V1730channelConfiguration.h.

Member Function Documentation

void sbn::V1730channelConfiguration::dump	(	std::ostream &	out,
		std::string const &	indent,
		std::string const &	firstIndent,
		unsigned int	verbosity = `MaxDumpVerbosity`
	)		const

Dumps the content of the configuration into out stream.

Parameters

out	stream to dump the information into
indent	indentation string
firstIndent	special indentation string for the first line
verbosity	(default: `DefaultDumpVerbosity`) level of verbosity

The indentation string is prepended to each new line of the dump. The first line indentation string is prepended before the first line of the dump. The dump ends on a new empty line.

The amount of information printed depends on the verbosity level:

0: channel number and whether it is enabled or not (also off-line channel ID if available)
1: also baseline and threshold

Definition at line 21 of file V1730channelConfiguration.cxx.

        {
   
   do { // fake look for easy break: `goto` in disguise
     
     // start a new line with indentation:
     auto const outnl
       = [&out,&indent]() -> std::ostream& { return out << '\n' << indent; };
     
     unsigned int level = 0U;
     
     // --- verbosity: 0+ -------------------------------------------------------
     out << firstIndent
       << "board channel #" << channelNo
       << " (" << (enabled? "enabled": "disabled") << ")"
       ;
     if (hasChannelID()) out << ", offline ID: " << channelID;
     
     if (++level > verbosity) break;
     // --- verbosity: 1+ -------------------------------------------------------
     out << ", baseline: " << baseline << ", threshold: " << threshold
       << " (delta=" << relativeThreshold() << ")"
       ;
     
     if (++level > verbosity) break;
     // --- verbosity: 2+ -------------------------------------------------------
     
     assert(level == MaxDumpVerbosity + 1U);
     
     // this is more debug information than anything else: verbosity was too high
     outnl() << "No more information available (reached level " << level << ").";
   
   } while(false);
   
   out << "\n";
   
 } // sbn::V1730channelConfiguration::dump()

void sbn::V1730channelConfiguration::dump	(	std::ostream &	out,
		std::string const &	indent = `""`
	)		const

inline

Dumps the content of the configuration into out stream.

Parameters

out	stream to dump the information into
indent	indentation level

See Also: dump(std::ostream&, std::string const&, std::string const&, unsigned int) const

Version of dump() with same first indentation level as the rest, and default verbosity.

Definition at line 138 of file V1730channelConfiguration.h.

139 { dump(out, indent, indent); }

sbn::V1730channelConfiguration::dump

void dump(std::ostream &out, std::string const &indent, std::string const &firstIndent, unsigned int verbosity=MaxDumpVerbosity) const

Dumps the content of the configuration into out stream.

Definition: V1730channelConfiguration.cxx:21

void sbn::V1730channelConfiguration::dump	(	std::ostream &	out,
		unsigned int	verbosity,
		std::string const &	indent = `""`
	)		const

inline

Dumps the content of the configuration into out stream.

Parameters

out	stream to dump the information into
indent	(default: none) indentation string

See Also: dump(std::ostream&, std::string const&, std::string const&, unsigned int) const

Version of dump() with the specified verbosity level and same first indentation level as the rest.

Definition at line 150 of file V1730channelConfiguration.h.

154 { dump(out, indent, indent, verbosity); }

sbn::V1730channelConfiguration::dump

void dump(std::ostream &out, std::string const &indent, std::string const &firstIndent, unsigned int verbosity=MaxDumpVerbosity) const

Dumps the content of the configuration into out stream.

Definition: V1730channelConfiguration.cxx:21

bool sbn::V1730channelConfiguration::hasChannelID ( ) const

inline

Returns whether the channel ID is set.

Definition at line 165 of file V1730channelConfiguration.h.

166 { return channelID != NoChannelID; }

sbn::V1730channelConfiguration::NoChannelID

static constexpr auto NoChannelID

Special value for unassigned channel ID.

Definition: V1730channelConfiguration.h:49

sbn::V1730channelConfiguration::channelID

raw::Channel_t channelID

Offline channel ID.

Definition: V1730channelConfiguration.h:59

bool sbn::V1730channelConfiguration::operator!= ( V1730channelConfiguration const & other ) const

inline

Definition at line 88 of file V1730channelConfiguration.h.

89 { return ! this->operator== (other); }

sbn::V1730channelConfiguration::operator==

bool operator==(V1730channelConfiguration const &other) const

Comparison: all fields need to have the same values.

Definition: V1730channelConfiguration.h:177

bool sbn::V1730channelConfiguration::operator== ( sbn::V1730channelConfiguration const & other ) const

inline

Comparison: all fields need to have the same values.

Definition at line 177 of file V1730channelConfiguration.h.

 {
   if (channelNo != other.channelNo) return false;
   if (channelID != other.channelID) return false;
   if (baseline  != other.baseline ) return false;
   if (threshold != other.threshold) return false;
   if (enabled   != other.enabled  ) return false;
   
   return true;
 } // sbn::V1730channelConfiguration::operator==()