LDMX Software
Packing
include
Packing
RogueFrameHeader.h
1
#pragma once
2
#ifndef PACKING_ROGUEFRAMEHEADER_H
3
#define PACKING_ROGUEFRAMEHEADER_H
4
5
#include <cstdint>
6
#include <vector>
7
8
#include "Packing/Utility/Reader.h"
9
10
namespace
packing {
11
16
class
RogueFrameHeader
{
17
public
:
19
utility::Reader
&
read
(
utility::Reader
& r);
21
int
channel
()
const
{
return
channel_
; }
23
unsigned
int
size
()
const
{
return
size_
; }
25
uint16_t
flags
()
const
{
return
flags_
; }
27
uint8_t
error
()
const
{
return
error_
; }
29
uint8_t
trailer
()
const
{
return
trailer_
; }
31
bool
probablyYaml
()
const
{
return
trailer_
== 0x0a; }
32
33
private
:
42
uint32_t
size_
;
44
uint16_t
flags_
;
46
uint8_t
error_
;
48
uint8_t
channel_
;
58
uint8_t
trailer_
;
59
};
60
61
}
// namespace packing
62
63
#endif
packing::RogueFrameHeader
the header that the Rogue StreamWriter puts includes at the beginning of each frame.
Definition
RogueFrameHeader.h:16
packing::RogueFrameHeader::flags
uint16_t flags() const
get the flags included in the header
Definition
RogueFrameHeader.h:25
packing::RogueFrameHeader::size
unsigned int size() const
get the size of the frame not including this header
Definition
RogueFrameHeader.h:23
packing::RogueFrameHeader::size_
uint32_t size_
size of frame written by StreamWriter
Definition
RogueFrameHeader.h:42
packing::RogueFrameHeader::error
uint8_t error() const
get specifc error flags included in the header
Definition
RogueFrameHeader.h:27
packing::RogueFrameHeader::probablyYaml
bool probablyYaml() const
check if this frame is probably a yaml dump
Definition
RogueFrameHeader.h:31
packing::RogueFrameHeader::flags_
uint16_t flags_
extra flags written by StreamWriter
Definition
RogueFrameHeader.h:44
packing::RogueFrameHeader::channel_
uint8_t channel_
StreamWriter channel.
Definition
RogueFrameHeader.h:48
packing::RogueFrameHeader::trailer
uint8_t trailer() const
get the trailer byte for checking
Definition
RogueFrameHeader.h:29
packing::RogueFrameHeader::error_
uint8_t error_
error flags written by StreamWriter
Definition
RogueFrameHeader.h:46
packing::RogueFrameHeader::channel
int channel() const
get the channel this data was written to
Definition
RogueFrameHeader.h:21
packing::RogueFrameHeader::trailer_
uint8_t trailer_
last byte stored in frame
Definition
RogueFrameHeader.h:58
packing::RogueFrameHeader::read
utility::Reader & read(utility::Reader &r)
read the next rogue frame header into memory
Definition
RogueFrameHeader.cxx:5
packing::utility::Reader
Reading a raw data file.
Definition
Reader.h:20
Generated by
1.12.0