HALDLS
haldls::vx::MADCSampleFromChip Class Reference

MADCSample from chip. More...

#include <event.h>

+ Collaboration diagram for haldls::vx::MADCSampleFromChip:

Classes

struct  Value
 Sample value. More...
 

Public Types

typedef halco::hicann_dls::vx::SourceMultiplexerOnReadoutSourceSelection Channel
 Channel selected on the active multiplexer for which this sample was acquired. More...
 

Public Member Functions

 MADCSampleFromChip ()=default
 Default constructor. More...
 
 MADCSampleFromChip (fisch::vx::MADCSampleFromChip const &data)
 Construct an MADC sample from the data representation. More...
 
 MADCSampleFromChip (Value const &value, Channel const &channel, FPGATime const &fpga_time, ChipTime const &chip_time)
 Construct MADC sample from chip via a value, FPGA and chip time information. More...
 
bool operator!= (MADCSampleFromChip const &other) const SYMBOL_VISIBLE
 
bool operator== (MADCSampleFromChip const &other) const SYMBOL_VISIBLE
 

Public Attributes

Channel channel
 Channel from which this sample was obtained. More...
 
ChipTime chip_time
 Chip time. More...
 
FPGATime fpga_time
 FPGA time. More...
 
Value value
 Sample value. More...
 

Friends

class cereal::access
 
struct detail::MADCSampleFromChipChecker
 
std::ostream & operator<< (std::ostream &os, MADCSampleFromChip const &sample) SYMBOL_VISIBLE
 

Detailed Description

MADCSample from chip.

It is comprised of the sample value, FPGA and chip time annotation.

Definition at line 254 of file event.h.

Member Typedef Documentation

◆ Channel

typedef halco::hicann_dls::vx::SourceMultiplexerOnReadoutSourceSelection haldls::vx::MADCSampleFromChip::Channel

Channel selected on the active multiplexer for which this sample was acquired.

Definition at line 265 of file event.h.

Constructor & Destructor Documentation

◆ MADCSampleFromChip() [1/3]

haldls::vx::MADCSampleFromChip::MADCSampleFromChip ( )
default

Default constructor.

◆ MADCSampleFromChip() [2/3]

haldls::vx::MADCSampleFromChip::MADCSampleFromChip ( Value const &  value,
Channel const &  channel,
FPGATime const &  fpga_time,
ChipTime const &  chip_time 
)
inline

Construct MADC sample from chip via a value, FPGA and chip time information.

Parameters
valuesample value to use
channelchannel from which the value was sampled
fpga_timeFPGATime to use
chip_timeChipTime to use

Definition at line 278 of file event.h.

◆ MADCSampleFromChip() [3/3]

haldls::vx::MADCSampleFromChip::MADCSampleFromChip ( fisch::vx::MADCSampleFromChip const &  data)
inline

Construct an MADC sample from the data representation.

Parameters
dataData to use

Definition at line 290 of file event.h.

Member Function Documentation

◆ operator!=()

bool haldls::vx::MADCSampleFromChip::operator!= ( MADCSampleFromChip const &  other) const

◆ operator==()

bool haldls::vx::MADCSampleFromChip::operator== ( MADCSampleFromChip const &  other) const

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access
friend

Definition at line 325 of file event.h.

◆ detail::MADCSampleFromChipChecker

friend struct detail::MADCSampleFromChipChecker
friend

Definition at line 330 of file event.h.

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
MADCSampleFromChip const &  sample 
)
friend

Member Data Documentation

◆ channel

Channel haldls::vx::MADCSampleFromChip::channel

Channel from which this sample was obtained.

Definition at line 305 of file event.h.

◆ chip_time

ChipTime haldls::vx::MADCSampleFromChip::chip_time

Chip time.

Definition at line 315 of file event.h.

◆ fpga_time

FPGATime haldls::vx::MADCSampleFromChip::fpga_time

FPGA time.

Definition at line 310 of file event.h.

◆ value

Value haldls::vx::MADCSampleFromChip::value

Sample value.

Definition at line 300 of file event.h.


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