sbn::V1730Configuration Struct Reference

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

#include <V1730Configuration.h>

Public Member Functions
unsigned int	preTriggerTicks () const
	Ticks in the waveform before the trigger. More...
unsigned int	postTriggerTicks () const
	Ticks in the waveform after the trigger. More...
float	bufferTime () const
	Duration of the waveform [us]. More...
float	preTriggerTime () const
	Time in the waveform before the trigger [us]. More...
float	postTriggerTime () const
	Time in the waveform after the trigger [us]. 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== (V1730Configuration const &other) const
	Comparison: all fields need to have the same values. More...
bool	operator!= (V1730Configuration const &other) const

Static Public Member Functions
static float	ticks2us (int ticks)
	Convert a number of ticks into a time interval in microseconds. More...

Public Attributes
std::string	boardName
	Name (mnemonic) of the board. More...
unsigned int	boardID = std::numeric_limits<unsigned int>::max()
	Numeric ID of the board (board_id). More...
unsigned int	fragmentID = std::numeric_limits<unsigned int>::max()
	DAQ fragment ID. More...
unsigned int	bufferLength = 0U
	Ticks in each buffer (recordLength). More...
float	postTriggerFrac = 0.0f
	Fraction of the waveform after the trigger signal (postPercent). More...
unsigned int	nChannels = 0U
	Number of channels (nChannels). More...
bool	useTimeTagForTimeStamp = false
	Whether fragment timestamp is synchronised with server NTP and with TTT. More...
std::vector < sbn::V1730channelConfiguration >	channels
	Configuration of each channel. More...

Static Public Attributes
static constexpr unsigned int	MaxDumpVerbosity = V1730channelConfiguration::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 board.

This is an informative class containing configuration of a V1730 board 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 V1730Configuration.h.

Member Function Documentation

float sbn::V1730Configuration::bufferTime ( ) const

inline

Duration of the waveform [us].

Definition at line 199 of file V1730Configuration.h.

  { return ticks2us(bufferLength); }

void sbn::V1730Configuration::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: name of the board, board and fragment ID, number of channels
• 1: waveform length and post-trigger fraction; also: information on each channel, one per line, as with V1730channelConfiguration::dump() with verbosity one level smaller than the value ofverbosityargument *2`: also setting of fragment timestamp

Definition at line 21 of file V1730Configuration.cxx.

       {
  
  do {
    // fake look for easy break: `goto` in disguise;
    // `break` will add a final `'\n'`, `return` will not.
    
    // 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 name: '" << boardName << "' (ID: " << boardID
      << "; fragment ID: " << fragmentID << "), "
      << nChannels << " configured channels"
      ;
    
    if (++level > verbosity) break;
    // --- verbosity: 1+ -------------------------------------------------------
    outnl()
      << "waveform: " << bufferLength << " ticks (" << bufferTime()
      << " us), post-trigger fraction: " << (postTriggerFrac*100.0)
      << "% (" << preTriggerTime() << " + " << postTriggerTime() << " us)"
      ;
    out << '\n';
    for (std::size_t iChannel = 0U; iChannel < nChannels; ++iChannel) {
      
      sbn::V1730channelConfiguration const& channel = channels[iChannel];
      
      out << indent << "[" << iChannel << "] ";
      channel.dump(out, indent + "  ", "", verbosity - 1U);
      
    } // for channels
    // ends on new line
    
    if (++level > verbosity) return;
    // --- verbosity: 2+ -------------------------------------------------------
    
    out << indent // absorb the newline from the previous level
      << "fragment timestamp "
      << (useTimeTagForTimeStamp? "follows": "does not follow")
      << " the Trigger Time Tag"
      ;
    
    if (++level > verbosity) break;
    // --- verbosity: 3+ -------------------------------------------------------
    
    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::V1730Configuration::dump()

void sbn::V1730Configuration::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 158 of file V1730Configuration.h.

    { dump(out, indent, indent); }

void sbn::V1730Configuration::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 170 of file V1730Configuration.h.

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

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

inline

Definition at line 104 of file V1730Configuration.h.

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

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

inline

Comparison: all fields need to have the same values.

Definition at line 215 of file V1730Configuration.h.

{
  
  if (boardName              != other.boardName             ) return false;
  if (boardID                != other.boardID               ) return false;
  if (fragmentID             != other.fragmentID            ) return false;
  if (bufferLength           != other.bufferLength          ) return false;
  if (postTriggerFrac        != other.postTriggerFrac       ) return false;
  if (useTimeTagForTimeStamp != other.useTimeTagForTimeStamp) return false;
  if (nChannels              != other.nChannels             ) return false;
  if (channels               != other.channels              ) return false;
  
  return true;
} // sbn::V1730Configuration::operator==()

unsigned int sbn::V1730Configuration::postTriggerTicks ( ) const

inline

Ticks in the waveform after the trigger.

Definition at line 194 of file V1730Configuration.h.

  { return static_cast<unsigned int>(postTriggerFrac * bufferLength); }

float sbn::V1730Configuration::postTriggerTime ( ) const

inline

Time in the waveform after the trigger [us].

Definition at line 209 of file V1730Configuration.h.

  { return ticks2us(postTriggerTicks()); }

unsigned int sbn::V1730Configuration::preTriggerTicks ( ) const

inline

Ticks in the waveform before the trigger.

Definition at line 189 of file V1730Configuration.h.

  { return static_cast<unsigned int>((1.0f - postTriggerFrac) * bufferLength); }

float sbn::V1730Configuration::preTriggerTime ( ) const

inline

Time in the waveform before the trigger [us].

Definition at line 204 of file V1730Configuration.h.

  { return ticks2us(preTriggerTicks()); }

static float sbn::V1730Configuration::ticks2us ( int  ticks )

inlinestatic

Convert a number of ticks into a time interval in microseconds.

Definition at line 180 of file V1730Configuration.h.

{ return ticks * 0.002f; }

Member Data Documentation

unsigned int sbn::V1730Configuration::boardID = std::numeric_limits<unsigned int>::max()

Numeric ID of the board (board_id).

Definition at line 55 of file V1730Configuration.h.

std::string sbn::V1730Configuration::boardName

Name (mnemonic) of the board.

Definition at line 52 of file V1730Configuration.h.

unsigned int sbn::V1730Configuration::bufferLength = 0U

Ticks in each buffer (recordLength).

Definition at line 61 of file V1730Configuration.h.

std::vector<sbn::V1730channelConfiguration> sbn::V1730Configuration::channels

Configuration of each channel.

Definition at line 73 of file V1730Configuration.h.

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

static

Default verbosity level for dump().

Definition at line 120 of file V1730Configuration.h.

unsigned int sbn::V1730Configuration::fragmentID = std::numeric_limits<unsigned int>::max()

DAQ fragment ID.

Definition at line 58 of file V1730Configuration.h.

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

static

Maximum supported verbosity level supported by dump().

Definition at line 117 of file V1730Configuration.h.

unsigned int sbn::V1730Configuration::nChannels = 0U

Number of channels (nChannels).

Definition at line 67 of file V1730Configuration.h.

float sbn::V1730Configuration::postTriggerFrac = 0.0f

Fraction of the waveform after the trigger signal (postPercent).

Definition at line 64 of file V1730Configuration.h.

bool sbn::V1730Configuration::useTimeTagForTimeStamp = false

Whether fragment timestamp is synchronised with server NTP and with TTT.

Definition at line 70 of file V1730Configuration.h.

---

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

• V1730Configuration.h
• V1730Configuration.cxx