DuneChannelInfo Class Reference

#include <DuneChannelInfo.h>

Public Types
using	Channel = AdcChannel
using	Index = AdcIndex

Public Member Functions
void	clear ()
	DuneChannelInfo ()=default
	DuneChannelInfo (Index a_channel, Index a_fembID, Index a_fembChannel, Index a_channelStatus)
bool	isValid () const
bool	operator< (const DuneChannelInfo &rhs)
bool	operator== (const DuneChannelInfo &rhs) const
bool	operator!= (const DuneChannelInfo &rhs) const
std::string	channelString () const
std::string	fembString (Index wid=2, Index wch=3) const

Static Public Member Functions
static Index	badChannel ()
static Index	badIndex ()
static const DuneChannelInfo &	badChannelInfo ()

Public Attributes
Channel	channel =badChannel()
Index	fembID =badIndex()
Index	fembChannel =badIndex()
Index	channelStatus =badIndex()

Detailed Description

Definition at line 15 of file DuneChannelInfo.h.

Member Typedef Documentation

using DuneChannelInfo::Channel = AdcChannel

Definition at line 19 of file DuneChannelInfo.h.

using DuneChannelInfo::Index = AdcIndex

Definition at line 20 of file DuneChannelInfo.h.

Constructor & Destructor Documentation

DuneChannelInfo::DuneChannelInfo ( )

default

DuneChannelInfo::DuneChannelInfo ( Index  a_channel, Index  a_fembID, Index  a_fembChannel, Index  a_channelStatus  )

inline

Definition at line 46 of file DuneChannelInfo.h.

  : channel(a_channel), fembID(a_fembID), fembChannel(a_fembChannel),
    channelStatus(a_channelStatus) { }

Member Function Documentation

static Index DuneChannelInfo::badChannel ( )

inlinestatic

Definition at line 27 of file DuneChannelInfo.h.

{ return -1u; }

static const DuneChannelInfo& DuneChannelInfo::badChannelInfo ( )

inlinestatic

Definition at line 29 of file DuneChannelInfo.h.

                                                 {
    static DuneChannelInfo bci;
    return bci;
  }

static Index DuneChannelInfo::badIndex ( )

inlinestatic

Definition at line 28 of file DuneChannelInfo.h.

{ return -1u; }

std::string DuneChannelInfo::channelString ( ) const

inline

Definition at line 73 of file DuneChannelInfo.h.

                                  {
    std::ostringstream ssout;
    ssout << channel;
    return ssout.str();
  }

void DuneChannelInfo::clear ( )

inline

Definition at line 35 of file DuneChannelInfo.h.

               {
    channel = badChannel();
    fembID = badIndex();
    fembChannel = badIndex();
    channelStatus = badIndex();
  }

std::string DuneChannelInfo::fembString ( Index  wid = 2, Index  wch = 3  ) const

inline

Definition at line 83 of file DuneChannelInfo.h.

                                                         {
    std::string sid = std::to_string(fembID);
    while ( sid.size() < wid ) sid = "0" + sid;
    std::string sch = std::to_string(fembChannel);
    while ( sch.size() < wch ) sch = "0" + sch;
    return sid + "-" + sch;
  }

bool DuneChannelInfo::isValid ( ) const

inline

Definition at line 51 of file DuneChannelInfo.h.

{ return channel != badIndex(); }

bool DuneChannelInfo::operator!= ( const DuneChannelInfo &  rhs ) const

inline

Definition at line 68 of file DuneChannelInfo.h.

                                                    {
    return ! (*this == rhs);
  }

bool DuneChannelInfo::operator< ( const DuneChannelInfo &  rhs )

inline

Definition at line 54 of file DuneChannelInfo.h.

                                             {
    if ( channel < rhs.channel ) return true;
    return false;
  }

bool DuneChannelInfo::operator== ( const DuneChannelInfo &  rhs ) const

inline

Definition at line 60 of file DuneChannelInfo.h.

                                                    {
    if ( channel       != rhs.channel ) return false;
    if ( fembID        != rhs.fembID ) return false;
    if ( fembChannel   != rhs.fembChannel ) return false;
    if ( channelStatus != rhs.channelStatus ) return false;
    return true;
  }

Member Data Documentation

Channel DuneChannelInfo::channel =badChannel()

Definition at line 22 of file DuneChannelInfo.h.

Index DuneChannelInfo::channelStatus =badIndex()

Definition at line 25 of file DuneChannelInfo.h.

Index DuneChannelInfo::fembChannel =badIndex()

Definition at line 24 of file DuneChannelInfo.h.

Index DuneChannelInfo::fembID =badIndex()

Definition at line 23 of file DuneChannelInfo.h.

---

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

• dunecore/dunecore/DuneInterface/Data/DuneChannelInfo.h