Skip to content
XFELPP

SegmentRef

SegmentRef

Section titled “SegmentRef”
#include <sbio/core/topology.hh>
template<IsStreamBroker BrokerType>
struct SegmentRef

Defined in src/lib/sbio/core/topology.hh:60

Map a StreamBroker to a logical position within a BrokerGroup.

Public Attributes

Section titled “Public Attributes”
Return Name Description
BrokerType * broker The pointer to the StreamBroker where you find this logical segment.
EPolicy::template SegmentState< SegmentCursor< DataFormat > > cursor Tracking state handle for segment position within the StreamBroker’s streams.
hd_std::uint32_t format_segment_id The identifier provided by the actual data format specification.
hd_std::uint32_t logical_slot The logical order of the segment within a BrokerGroup.
DataAccessPtn access_ptn The format-specific access strategy used to access this logical segment.

broker

Section titled “broker”
BrokerType * broker { nullptr }

Defined in src/lib/sbio/core/topology.hh:79

The pointer to the StreamBroker where you find this logical segment.

cursor

Section titled “cursor”
EPolicy::template SegmentState< SegmentCursor< DataFormat > > cursor {}

Type: EPolicy::template SegmentState< SegmentCursor< DataFormat > >

Defined in src/lib/sbio/core/topology.hh:83

Tracking state handle for segment position within the StreamBroker’s streams.

format_segment_id

Section titled “format_segment_id”
hd_std::uint32_t format_segment_id { 0 }

Defined in src/lib/sbio/core/topology.hh:90

The identifier provided by the actual data format specification.

The format identifier does not necessarily equal the logical_slot. In some cases, the format may not even provide an identifier.

logical_slot

Section titled “logical_slot”
hd_std::uint32_t logical_slot { 0 }

Defined in src/lib/sbio/core/topology.hh:94

The logical order of the segment within a BrokerGroup.

access_ptn

Section titled “access_ptn”
DataAccessPtn access_ptn

Type: DataAccessPtn

Defined in src/lib/sbio/core/topology.hh:101

The format-specific access strategy used to access this logical segment.

Some formats expose multiple mechanisms to traverse data. The access pattern controls which mechanism to use.

Public Types

Section titled “Public Types”
Name Description
DataFormat The type of data being read.
EPolicy Current execution policy.
DataAccessPtn The type of the enumerator used to specify access patterns used for the format.

DataFormat

Section titled “DataFormat”
using DataFormat = typename BrokerType::DataFormat

Defined in src/lib/sbio/core/topology.hh:64

The type of data being read.

EPolicy

Section titled “EPolicy”
using EPolicy = typename BrokerType::ExecutionPolicy

Defined in src/lib/sbio/core/topology.hh:69

Current execution policy.

DataAccessPtn

Section titled “DataAccessPtn”
using DataAccessPtn = typename DataFormat::DataAccessPtn

Defined in src/lib/sbio/core/topology.hh:74

The type of the enumerator used to specify access patterns used for the format.