Capture header and ECON-D header data for one sample (L1A) More...

#include <ECONDEventInfo.h>

Public Types
enum	Corruption { BAD_HEADER_MARKER = 0 , BAD_LENGTH = 1 , BAD_HEADER_CRC = 2 , BAD_CRC32 = 3 , BAD_PAYLOAD = 4 , TRUNCATED = 5 }
	Bits of the corruption mask. More...

Public Member Functions
void	setCaptureHeader (int econ_id, int i_sample, bool is_soi, int length)
	Set the capture header data.

void	setHeader (int payload_length, int flags, int ht, int ebo, int bx, int l1a, int orbit, int reset_request)
	Set the ECON-D event header data.

void	setCorruption (int mask)
	set the corruption mask

void	addLink (const ECONDLinkInfo &link)
	add the data from the next link

int	getEconID () const
	ECON ID from the capture header.

int	getSampleIndex () const
	sample index from the capture header

bool	isSOI () const
	sample of interest flag from the capture header

int	getCaptureLength () const
	ECON-D packet length from the capture header.

int	getPayloadLength () const
	payload length from the ECON-D header

bool	isPassthrough () const
	P flag, pass through mode.

bool	isExpected () const
	E flag, HGCROC event header/trailer expected.

bool	isMatch () const
	M flag, E/B/O match with the L1A FIFO.

bool	isTruncated () const
	T flag, truncated.

bool	hasSubpacketError () const
	S flag, sub-packet error.

int	getHT () const
	2-bit H/T status

int	getEBO () const
	2-bit E/B/O status

int	getBX () const
	bunch crossing

int	getL1A () const
	6-bit L1A number

int	getOrbit () const
	3-bit orbit number

int	getResetRequest () const
	2-bit reset request

int	getCorruption () const
	corruption mask, bits from Corruption

bool	isCorrupt (Corruption c) const
	check a single corruption bit

bool	isCorrupt () const
	any corruption bit is set

const std::vector< ECONDLinkInfo > &	getLinks () const
	link data in order of transmission

Private Member Functions
	ClassDef (ECONDSampleInfo, 1)

Private Attributes
int	econ_id_ {-1}
	ECON ID.

int	i_sample_ {-1}
	sample index

bool	is_soi_ {false}
	sample of interest flag

int	capture_length_ {0}
	ECON-D packet length from capture header.

int	payload_length_ {0}
	payload length from ECON-D header

int	flags_ {0}
	packed P, E, M, T, S flags

int	ht_ {0}
	H/T status.

int	ebo_ {0}
	E/B/O status.

int	bx_ {0}
	bunch crossing

int	l1a_ {0}
	L1A number.

int	orbit_ {0}
	orbit number

int	reset_request_ {0}
	reset request

int	corruption_ {0}
	corruption mask

std::vector< ECONDLinkInfo >	links_
	link data

Friends
std::ostream &	operator<< (std::ostream &o, const ECONDSampleInfo &s)

Detailed Description

Capture header and ECON-D header data for one sample (L1A)

Definition at line 81 of file ECONDEventInfo.h.

Member Enumeration Documentation

◆ Corruption

enum ldmx::ECONDSampleInfo::Corruption

Bits of the corruption mask.

Same order as packing::ECONDEventPacket::Corruption

Definition at line 88 of file ECONDEventInfo.h.

                  {
    BAD_HEADER_MARKER = 0,
    BAD_LENGTH = 1,
    BAD_HEADER_CRC = 2,
    BAD_CRC32 = 3,
    BAD_PAYLOAD = 4,
    TRUNCATED = 5
  };

Member Function Documentation

◆ addLink()

void ldmx::ECONDSampleInfo::addLink ( const ECONDLinkInfo & link )

inline

add the data from the next link

Definition at line 137 of file ECONDEventInfo.h.

137{ links_.push_back(link); }

ldmx::ECONDSampleInfo::links_

std::vector< ECONDLinkInfo > links_

link data

Definition ECONDEventInfo.h:210

References links_.

Referenced by packing::ECONDDecoder::produce().

◆ getBX()

int ldmx::ECONDSampleInfo::getBX ( ) const

inline

bunch crossing

Definition at line 164 of file ECONDEventInfo.h.

164{ return bx_; }

ldmx::ECONDSampleInfo::bx_

int bx_

bunch crossing

Definition ECONDEventInfo.h:200

References bx_.

◆ getCaptureLength()

int ldmx::ECONDSampleInfo::getCaptureLength ( ) const

inline

ECON-D packet length from the capture header.

Definition at line 146 of file ECONDEventInfo.h.

146{ return capture_length_; }

ldmx::ECONDSampleInfo::capture_length_

int capture_length_

ECON-D packet length from capture header.

Definition ECONDEventInfo.h:190

References capture_length_.

◆ getCorruption()

int ldmx::ECONDSampleInfo::getCorruption ( ) const

inline

corruption mask, bits from Corruption

Definition at line 172 of file ECONDEventInfo.h.

172{ return corruption_; }

ldmx::ECONDSampleInfo::corruption_

int corruption_

corruption mask

Definition ECONDEventInfo.h:208

References corruption_.

◆ getEBO()

int ldmx::ECONDSampleInfo::getEBO ( ) const

inline

2-bit E/B/O status

Definition at line 162 of file ECONDEventInfo.h.

162{ return ebo_; }

ldmx::ECONDSampleInfo::ebo_

int ebo_

E/B/O status.

Definition ECONDEventInfo.h:198

References ebo_.

◆ getEconID()

int ldmx::ECONDSampleInfo::getEconID ( ) const

inline

ECON ID from the capture header.

Definition at line 140 of file ECONDEventInfo.h.

140{ return econ_id_; }

ldmx::ECONDSampleInfo::econ_id_

int econ_id_

ECON ID.

Definition ECONDEventInfo.h:184

References econ_id_.

◆ getHT()

int ldmx::ECONDSampleInfo::getHT ( ) const

inline

2-bit H/T status

Definition at line 160 of file ECONDEventInfo.h.

160{ return ht_; }

ldmx::ECONDSampleInfo::ht_

int ht_

H/T status.

Definition ECONDEventInfo.h:196

References ht_.

◆ getL1A()

int ldmx::ECONDSampleInfo::getL1A ( ) const

inline

6-bit L1A number

Definition at line 166 of file ECONDEventInfo.h.

166{ return l1a_; }

ldmx::ECONDSampleInfo::l1a_

int l1a_

L1A number.

Definition ECONDEventInfo.h:202

References l1a_.

◆ getLinks()

const std::vector< ECONDLinkInfo > & ldmx::ECONDSampleInfo::getLinks ( ) const

inline

link data in order of transmission

Definition at line 178 of file ECONDEventInfo.h.

178{ return links_; }

References links_.

◆ getOrbit()

int ldmx::ECONDSampleInfo::getOrbit ( ) const

inline

3-bit orbit number

Definition at line 168 of file ECONDEventInfo.h.

168{ return orbit_; }

ldmx::ECONDSampleInfo::orbit_

int orbit_

orbit number

Definition ECONDEventInfo.h:204

References orbit_.

◆ getPayloadLength()

int ldmx::ECONDSampleInfo::getPayloadLength ( ) const

inline

payload length from the ECON-D header

Definition at line 148 of file ECONDEventInfo.h.

148{ return payload_length_; }

ldmx::ECONDSampleInfo::payload_length_

int payload_length_

payload length from ECON-D header

Definition ECONDEventInfo.h:192

References payload_length_.

◆ getResetRequest()

int ldmx::ECONDSampleInfo::getResetRequest ( ) const

inline

2-bit reset request

Definition at line 170 of file ECONDEventInfo.h.

170{ return reset_request_; }

ldmx::ECONDSampleInfo::reset_request_

int reset_request_

reset request

Definition ECONDEventInfo.h:206

References reset_request_.

◆ getSampleIndex()

int ldmx::ECONDSampleInfo::getSampleIndex ( ) const

inline

sample index from the capture header

Definition at line 142 of file ECONDEventInfo.h.

142{ return i_sample_; }

ldmx::ECONDSampleInfo::i_sample_

int i_sample_

sample index

Definition ECONDEventInfo.h:186

References i_sample_.

◆ hasSubpacketError()

bool ldmx::ECONDSampleInfo::hasSubpacketError ( ) const

inline

S flag, sub-packet error.

Definition at line 158 of file ECONDEventInfo.h.

158{ return (flags_ >> 4) & 0b1; }

ldmx::ECONDSampleInfo::flags_

int flags_

packed P, E, M, T, S flags

Definition ECONDEventInfo.h:194

References flags_.

◆ isCorrupt() [1/2]

bool ldmx::ECONDSampleInfo::isCorrupt ( ) const

inline

any corruption bit is set

Definition at line 176 of file ECONDEventInfo.h.

176{ return corruption_ != 0; }

References corruption_.

◆ isCorrupt() [2/2]

bool ldmx::ECONDSampleInfo::isCorrupt ( Corruption c ) const

inline

check a single corruption bit

Definition at line 174 of file ECONDEventInfo.h.

174{ return (corruption_ >> c) & 0b1; }

References corruption_.

◆ isExpected()

bool ldmx::ECONDSampleInfo::isExpected ( ) const

inline

E flag, HGCROC event header/trailer expected.

Definition at line 152 of file ECONDEventInfo.h.

152{ return (flags_ >> 1) & 0b1; }

References flags_.

◆ isMatch()

bool ldmx::ECONDSampleInfo::isMatch ( ) const

inline

M flag, E/B/O match with the L1A FIFO.

Definition at line 154 of file ECONDEventInfo.h.

154{ return (flags_ >> 2) & 0b1; }

References flags_.

◆ isPassthrough()

bool ldmx::ECONDSampleInfo::isPassthrough ( ) const

inline

P flag, pass through mode.

Definition at line 150 of file ECONDEventInfo.h.

150{ return flags_ & 0b1; }

References flags_.

◆ isSOI()

bool ldmx::ECONDSampleInfo::isSOI ( ) const

inline

sample of interest flag from the capture header

Definition at line 144 of file ECONDEventInfo.h.

144{ return is_soi_; }

ldmx::ECONDSampleInfo::is_soi_

bool is_soi_

sample of interest flag

Definition ECONDEventInfo.h:188

References is_soi_.

◆ isTruncated()

bool ldmx::ECONDSampleInfo::isTruncated ( ) const

inline

T flag, truncated.

Definition at line 156 of file ECONDEventInfo.h.

156{ return (flags_ >> 3) & 0b1; }

References flags_.

◆ setCaptureHeader()

void ldmx::ECONDSampleInfo::setCaptureHeader	(	int	econ_id,
		int	i_sample,
		bool	is_soi,
		int	length )

inline

Set the capture header data.

Parameters

[in]	econ_id	ECON ID
[in]	i_sample	sample index within the event
[in]	is_soi	sample of interest flag
[in]	length	ECON-D packet length in 32b words

Definition at line 108 of file ECONDEventInfo.h.

                                                                            {
    econ_id_ = econ_id;
    i_sample_ = i_sample;
    is_soi_ = is_soi;
    capture_length_ = length;
  }

References capture_length_, econ_id_, i_sample_, and is_soi_.

Referenced by packing::ECONDDecoder::produce().

◆ setCorruption()

void ldmx::ECONDSampleInfo::setCorruption ( int mask )

inline

set the corruption mask

Definition at line 134 of file ECONDEventInfo.h.

134{ corruption_ = mask; }

References corruption_.

Referenced by packing::ECONDDecoder::produce().

◆ setHeader()

void ldmx::ECONDSampleInfo::setHeader	(	int	payload_length,
		int	flags,
		int	ht,
		int	ebo,
		int	bx,
		int	l1a,
		int	orbit,
		int	reset_request )

inline

Set the ECON-D event header data.

The flags are packed as P (bit 0), E (1), M (2), T (3), S (4).

Definition at line 121 of file ECONDEventInfo.h.

                                                        {
    payload_length_ = payload_length;
    flags_ = flags;
    ht_ = ht;
    ebo_ = ebo;
    bx_ = bx;
    l1a_ = l1a;
    orbit_ = orbit;
    reset_request_ = reset_request;
  }

References bx_, ebo_, flags_, ht_, l1a_, orbit_, payload_length_, and reset_request_.

Referenced by packing::ECONDDecoder::produce().

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	o,
		const ECONDSampleInfo &	s )

friend

Definition at line 24 of file ECONDEventInfo.cxx.

                                                                {
  return o << "ECONDSampleInfo { econ: " << s.econ_id_
           << ", i_sample: " << s.i_sample_ << ", soi: " << s.is_soi_
           << ", length: " << s.payload_length_ << ", bx: " << s.bx_
           << ", l1a: " << s.l1a_ << ", orbit: " << s.orbit_
           << ", corruption: " << s.corruption_
           << ", n_links: " << s.links_.size() << " }";
}

Member Data Documentation

◆ bx_

int ldmx::ECONDSampleInfo::bx_ {0}

private

bunch crossing

Definition at line 200 of file ECONDEventInfo.h.

200{0};

Referenced by getBX(), and setHeader().

◆ capture_length_

int ldmx::ECONDSampleInfo::capture_length_ {0}

private

ECON-D packet length from capture header.

Definition at line 190 of file ECONDEventInfo.h.

190{0};

Referenced by getCaptureLength(), and setCaptureHeader().

◆ corruption_

int ldmx::ECONDSampleInfo::corruption_ {0}

private

corruption mask

Definition at line 208 of file ECONDEventInfo.h.

208{0};

Referenced by getCorruption(), isCorrupt(), isCorrupt(), and setCorruption().

◆ ebo_

int ldmx::ECONDSampleInfo::ebo_ {0}

private

E/B/O status.

Definition at line 198 of file ECONDEventInfo.h.

198{0};

Referenced by getEBO(), and setHeader().

◆ econ_id_

int ldmx::ECONDSampleInfo::econ_id_ {-1}

private

ECON ID.

Definition at line 184 of file ECONDEventInfo.h.

184{-1};

Referenced by getEconID(), and setCaptureHeader().

◆ flags_

int ldmx::ECONDSampleInfo::flags_ {0}

private

packed P, E, M, T, S flags

Definition at line 194 of file ECONDEventInfo.h.

194{0};

Referenced by hasSubpacketError(), isExpected(), isMatch(), isPassthrough(), isTruncated(), and setHeader().

◆ ht_

int ldmx::ECONDSampleInfo::ht_ {0}

private

H/T status.

Definition at line 196 of file ECONDEventInfo.h.

196{0};

Referenced by getHT(), and setHeader().

◆ i_sample_

int ldmx::ECONDSampleInfo::i_sample_ {-1}

private

sample index

Definition at line 186 of file ECONDEventInfo.h.

186{-1};

Referenced by getSampleIndex(), and setCaptureHeader().

◆ is_soi_

bool ldmx::ECONDSampleInfo::is_soi_ {false}

private

sample of interest flag

Definition at line 188 of file ECONDEventInfo.h.

188{false};

Referenced by isSOI(), and setCaptureHeader().

◆ l1a_

int ldmx::ECONDSampleInfo::l1a_ {0}

private

L1A number.

Definition at line 202 of file ECONDEventInfo.h.

202{0};

Referenced by getL1A(), and setHeader().

◆ links_

std::vector<ECONDLinkInfo> ldmx::ECONDSampleInfo::links_

private

link data

Definition at line 210 of file ECONDEventInfo.h.

Referenced by addLink(), and getLinks().

◆ orbit_

int ldmx::ECONDSampleInfo::orbit_ {0}

private

orbit number

Definition at line 204 of file ECONDEventInfo.h.

204{0};

Referenced by getOrbit(), and setHeader().

◆ payload_length_

int ldmx::ECONDSampleInfo::payload_length_ {0}

private

payload length from ECON-D header

Definition at line 192 of file ECONDEventInfo.h.

192{0};

Referenced by getPayloadLength(), and setHeader().

◆ reset_request_

int ldmx::ECONDSampleInfo::reset_request_ {0}

private

reset request

Definition at line 206 of file ECONDEventInfo.h.

206{0};

Referenced by getResetRequest(), and setHeader().

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

Recon/include/Recon/Event/ECONDEventInfo.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Corruption

Member Function Documentation

◆ addLink()

◆ getBX()

◆ getCaptureLength()

◆ getCorruption()

◆ getEBO()

◆ getEconID()

◆ getHT()

◆ getL1A()

◆ getLinks()

◆ getOrbit()

◆ getPayloadLength()

◆ getResetRequest()

◆ getSampleIndex()

◆ hasSubpacketError()

◆ isCorrupt() [1/2]

◆ isCorrupt() [2/2]

◆ isExpected()

◆ isMatch()

◆ isPassthrough()

◆ isSOI()

◆ isTruncated()

◆ setCaptureHeader()

◆ setCorruption()

◆ setHeader()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ bx_

◆ capture_length_

◆ corruption_

◆ ebo_

◆ econ_id_

◆ flags_

◆ ht_

◆ i_sample_

◆ is_soi_

◆ l1a_

◆ links_

◆ orbit_

◆ payload_length_

◆ reset_request_