sbn::PMTconfiguration Struct Reference

Class containing configuration for PMT readout. More...

#include <PMTconfiguration.h>

Public Member Functions
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== (PMTconfiguration const &other) const
	Comparison: all fields need to have the same values. More...
bool	operator!= (PMTconfiguration const &other) const

Public Attributes
std::vector < sbn::V1730Configuration >	boards
	Configuration of all PMT readout boards. More...

Static Public Attributes
static constexpr unsigned int	MaxDumpVerbosity = V1730Configuration::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 PMT readout.

This is an informative class containing configuration of all V1730 boards 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 PMTconfiguration.h.

Member Function Documentation

void sbn::PMTconfiguration::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: only the number of boards in the configuration
• 1: information on each board, as in V1730Configuration::dump() with verbosity one level smaller than the value of verbosity argument

Definition at line 22 of file PMTconfiguration.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+ -------------------------------------------------------
    std::size_t const nReadoutBoards = boards.size();
    out << firstIndent
      << nReadoutBoards << " readout board configurations"
      ;
    
    if (++level > verbosity) break;
    // --- verbosity: 1+ -------------------------------------------------------
    out << ":"
      << "\n"; // since V1730Configuration::dump() ends line...
    for (std::size_t iBoard = 0U; iBoard != nReadoutBoards; ++iBoard) {
      
      sbn::V1730Configuration const& boardConfig
        = boards[iBoard];
      out << indent << "[B" << iBoard << "]: ";
      boardConfig.dump(out, indent + "  ", "", verbosity - 1U);
      
    } // for
    
    if (++level > verbosity) break;
    // --- verbosity: 2+ -------------------------------------------------------
    
    // nothing special here, but still counts
    
    if (++level > verbosity) break;
    // --- verbosity: 3+ -------------------------------------------------------
    
    // nothing special here, but still counts
    
    if (++level > verbosity) break;
    // --- verbosity: 4+ -------------------------------------------------------
    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::PMTconfiguration::dump()

void sbn::PMTconfiguration::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 111 of file PMTconfiguration.h.

    { dump(out, indent, indent); }

void sbn::PMTconfiguration::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 123 of file PMTconfiguration.h.

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

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

inline

Definition at line 60 of file PMTconfiguration.h.

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

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

inline

Comparison: all fields need to have the same values.

Definition at line 139 of file PMTconfiguration.h.

{
  
  if (boards != other.boards) return false;
  
  return true;
} // sbn::PMTconfiguration::operator==()

Member Data Documentation

std::vector<sbn::V1730Configuration> sbn::PMTconfiguration::boards

Configuration of all PMT readout boards.

Definition at line 52 of file PMTconfiguration.h.

constexpr unsigned int sbn::PMTconfiguration::DefaultDumpVerbosity = MaxDumpVerbosity

static

Default verbosity level for dump().

Definition at line 76 of file PMTconfiguration.h.

constexpr unsigned int sbn::PMTconfiguration::MaxDumpVerbosity = V1730Configuration::MaxDumpVerbosity + 1U

static

Maximum supported verbosity level supported by dump().

Definition at line 73 of file PMTconfiguration.h.

---

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

• PMTconfiguration.h
• PMTconfiguration.cxx