RandomTraits

#include <sbio/formats/random/random_traits.hh>

struct RandomTraits

Defined in src/lib/sbio/formats/random/random_traits.hh:71

Inherits: BaseTraits

List of all members

Name	Kind	Owner
`HeaderSize`	`variable`	Declared here
`MaxRank`	`variable`	Declared here
`MaxNameSize`	`variable`	Declared here
`ExhaustedSentinel`	`variable`	Declared here
`PartitioningStrategy`	`variable`	Declared here
`RoleCount`	`variable`	Declared here
`DataAccessPtnCount`	`variable`	Declared here
`make_stream_brokers`	`function`	Declared here
`get_allocation_request`	`function`	Declared here
`max_batch_count`	`function`	Declared here
`open_streams`	`function`	Declared here
`discover_metadata`	`function`	Declared here
`index_stream`	`function`	Declared here
`sync_vars`	`function`	Declared here
`fetch_step`	`function`	Declared here
`fetch_multi_steps`	`function`	Declared here
`fetch_multi_steps_stride`	`function`	Declared here
`get_data_in_buffer`	`function`	Declared here
`capacity`	`function`	Declared here
`current_buffer`	`function`	Declared here
`resolve_data`	`function`	Declared here
`get_payload_size`	`function`	Declared here
`Roles`	`enum`	Declared here
`DataAccessPtn`	`enum`	Declared here
`IndexingMode`	`enum`	Declared here
`DataUnit`	`typedef`	Declared here
`StepIdxType`	`typedef`	Declared here
`BrokerBufferRequirements`	`typedef`	Declared here

Public Static Attributes

Return	Name	Description
`constexpr hd_std::size_t`	`HeaderSize` `static` `constexpr`
`constexpr hd_std::uint16_t`	`MaxRank` `static` `constexpr`
`constexpr hd_std::uint16_t`	`MaxNameSize` `static` `constexpr`
`constexpr StepIdxType`	`ExhaustedSentinel` `static` `constexpr`
`constexpr StreamPartitioningStrategy`	`PartitioningStrategy` `static` `constexpr`
`constexpr hd_std::size_t`	`RoleCount` `static` `constexpr`
`constexpr hd_std::size_t`	`DataAccessPtnCount` `static` `constexpr`

HeaderSize

static constexpr

constexpr hd_std::size_t HeaderSize { sizeof() }

Defined in src/lib/sbio/formats/random/random_traits.hh:72

MaxRank

static constexpr

constexpr hd_std::uint16_t MaxRank { 5 }

Defined in src/lib/sbio/formats/random/random_traits.hh:73

MaxNameSize

static constexpr

constexpr hd_std::uint16_t MaxNameSize { 64 }

Defined in src/lib/sbio/formats/random/random_traits.hh:74

ExhaustedSentinel

static constexpr

constexpr StepIdxType ExhaustedSentinel { static_cast<>(-1) }

Defined in src/lib/sbio/formats/random/random_traits.hh:78

PartitioningStrategy

static constexpr

constexpr StreamPartitioningStrategy PartitioningStrategy {

    }

Defined in src/lib/sbio/formats/random/random_traits.hh:80

RoleCount

static constexpr

constexpr hd_std::size_t RoleCount { 1 }

Defined in src/lib/sbio/formats/random/random_traits.hh:85

DataAccessPtnCount

static constexpr

constexpr hd_std::size_t DataAccessPtnCount { 1 }

Defined in src/lib/sbio/formats/random/random_traits.hh:89

Public Static Methods

Return	Name	Description
`bool`	`make_stream_brokers` `static` `inline`
`SBIO_HDAllocationRequest< RandomTraits >`	`get_allocation_request` `static` `inline`
`SBIO_HD std::size_t`	`max_batch_count` `static` `inline`
`SBIO_HDIOStatus`	`open_streams` `static` `inline`
`SBIO_HDIOStatus`	`discover_metadata` `static` `inline`
`SBIO_HDIOStatus`	`index_stream` `static` `inline`
`SBIO_HD auto`	`sync_vars` `static` `inline`
`SBIO_HDIOStatus`	`fetch_step` `static` `inline`
`SBIO_HDIOStatus`	`fetch_multi_steps` `static` `inline`
`SBIO_HDIOStatus`	`fetch_multi_steps_stride` `static` `inline`
`SBIO_HDDataResult`	`get_data_in_buffer` `static` `inline`
`SBIO_HD auto`	`capacity` `static` `inline`
`SBIO_HD auto`	`current_buffer` `static` `inline`
`SBIO_HDDataResult`	`resolve_data` `static` `inline`
`SBIO_HD std::size_t`	`get_payload_size` `static` `inline`

make_stream_brokers

static inline

template<typename DS> static inline bool make_stream_brokers(DS & ds, const DataSourceParameters & ds_params, StreamParameters & base_cfg)

Defined in src/lib/sbio/formats/random/random_traits.hh:122

get_allocation_request

static inline

static inline SBIO_HDAllocationRequest< RandomTraits > get_allocation_request(StreamParameters & cfg)

Defined in src/lib/sbio/formats/random/random_traits.hh:281

max_batch_count

static inline

static inline SBIO_HD std::size_t max_batch_count(StreamParameters & cfg)

Defined in src/lib/sbio/formats/random/random_traits.hh:297

open_streams

static inline

template<IOTraits IO> static inline SBIO_HDIOStatus open_streams(Stream< IO, RandomTraits > * streams, const StreamParameters & cfg)

Defined in src/lib/sbio/formats/random/random_traits.hh:302

discover_metadata

static inline

template<IOTraits IO, class StorageViewT> static inline SBIO_HDIOStatus discover_metadata(Stream< IO, RandomTraits > * streams, StorageViewT & storage, MetadataInventory & inv)

Defined in src/lib/sbio/formats/random/random_traits.hh:318

index_stream

static inline

template<IOTraits IO, class StorageViewT> static inline SBIO_HDIOStatus index_stream(Stream< IO, RandomTraits > * streams, StorageViewT & storage, DiscoveryState & stream_state, const StreamParameters & cfg)

Defined in src/lib/sbio/formats/random/random_traits.hh:367

sync_vars

static inline

static inline SBIO_HD auto sync_vars(DiscoveryState & state)

Defined in src/lib/sbio/formats/random/random_traits.hh:504

fetch_step

static inline

template<IOTraits IO, class StorageViewT> static inline SBIO_HDIOStatus fetch_step(Stream< IO, RandomTraits > * streams, StorageViewT & storage, DiscoveryState & stream_state, const StreamParameters & cfg, StepIdxType step_idx, DataAccessPtn ptn)

Defined in src/lib/sbio/formats/random/random_traits.hh:509

fetch_multi_steps

static inline

template<IOTraits IO, class StorageViewT> static inline SBIO_HDIOStatus fetch_multi_steps(Stream< IO, RandomTraits > * streams, StorageViewT & storage, DiscoveryState & stream_state, const StreamParameters & cfg, StepIdxType step_idx, StepIdxType count, DataAccessPtn ptn)

Defined in src/lib/sbio/formats/random/random_traits.hh:542

fetch_multi_steps_stride

static inline

template<IOTraits IO, class StorageViewT> static inline SBIO_HDIOStatus fetch_multi_steps_stride(Stream< IO, RandomTraits > * streams, StorageViewT & storage, DiscoveryState & stream_state, const StreamParameters & cfg, StepIdxType step_idx, StepIdxType count, StepIdxType stride, DataAccessPtn ptn)

Defined in src/lib/sbio/formats/random/random_traits.hh:603

get_data_in_buffer

static inline

template<class StorageViewT> static inline SBIO_HDDataResult get_data_in_buffer(StorageViewT & storage, const MetadataInventory & inv, const DataRequest & req, DataAccessPtn ptn, std::size_t batch_idx = 0)

Defined in src/lib/sbio/formats/random/random_traits.hh:616

capacity

static inline

template<class StorageViewT> static inline SBIO_HD auto capacity(const StorageViewT & storage, const DiscoveryState & state)

Defined in src/lib/sbio/formats/random/random_traits.hh:637

current_buffer

static inline

template<class StorageViewT> static inline SBIO_HD auto current_buffer(StorageViewT & storage, const DiscoveryState & state)

Defined in src/lib/sbio/formats/random/random_traits.hh:643

resolve_data

static inline

static inline SBIO_HDDataResult resolve_data(void * buffer, const MetadataInventory & inv, const DataRequest & req)

Defined in src/lib/sbio/formats/random/random_traits.hh:651

get_payload_size

static inline

static inline SBIO_HD std::size_t get_payload_size(void * buf)

Defined in src/lib/sbio/formats/random/random_traits.hh:736

Public Types

Name	Description
`Roles`
`DataAccessPtn`
`IndexingMode`
`DataUnit`
`StepIdxType`
`BrokerBufferRequirements`

Roles

enum Roles

Defined in src/lib/sbio/formats/random/random_traits.hh:84

Value	Description
`Data`

DataAccessPtn

enum DataAccessPtn

Defined in src/lib/sbio/formats/random/random_traits.hh:86

Value	Description
`Default`

IndexingMode

enum IndexingMode

Defined in src/lib/sbio/formats/random/random_traits.hh:91

Value	Description
`IndexAll`	When index_stream is called, all events will be indexed.
`IndexBatch`	When index_stream is called a batch is indexed. This allows reindexing later.
`NoIndex`	Offsets are not written, so indexing is disabled and data is traversed linearly.

DataUnit

using DataUnit = randfmt::Block

Defined in src/lib/sbio/formats/random/random_traits.hh:76

StepIdxType

using StepIdxType = hd_std::size_t

Defined in src/lib/sbio/formats/random/random_traits.hh:77

BrokerBufferRequirements

using BrokerBufferRequirements = TypeList< BufferDescriptor< MetadataRole, 0, sizeof(randfmt::Block)>, BufferDescriptor< DataRole, 0, sizeof(randfmt::Block)>, BufferDescriptor< IndexRole, 0, sizeof(EventOffset)> >

Defined in src/lib/sbio/formats/random/random_traits.hh:209