RandomTraits
RandomTraits
Section titled “RandomTraits”#include <sbio/formats/random/random_traits.hh>struct RandomTraitsDefined in src/lib/sbio/formats/random/random_traits.hh:75
Inherits:
BaseTraits
Public Static Attributes
Section titled “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 |
DataAccessPtnCount static constexpr |
|
constexpr std::size_t |
NumStepKinds static constexpr |
HeaderSize
Section titled “HeaderSize”static constexpr
constexpr hd_std::size_t HeaderSize { sizeof(randfmt::Header) }Defined in src/lib/sbio/formats/random/random_traits.hh:78
MaxRank
Section titled “MaxRank”static constexpr
constexpr hd_std::uint16_t MaxRank { 5 }Defined in src/lib/sbio/formats/random/random_traits.hh:79
MaxNameSize
Section titled “MaxNameSize”static constexpr
constexpr hd_std::uint16_t MaxNameSize { 64 }Defined in src/lib/sbio/formats/random/random_traits.hh:80
ExhaustedSentinel
Section titled “ExhaustedSentinel”static constexpr
constexpr StepIdxType ExhaustedSentinel { static_cast<StepIdxType>(-1) }Type: constexpr StepIdxType
Defined in src/lib/sbio/formats/random/random_traits.hh:84
PartitioningStrategy
Section titled “PartitioningStrategy”static constexpr
constexpr StreamPartitioningStrategy PartitioningStrategy { StreamPartitioningStrategy::SubDivide }Type: constexpr StreamPartitioningStrategy
Defined in src/lib/sbio/formats/random/random_traits.hh:86
DataAccessPtnCount
Section titled “DataAccessPtnCount”static constexpr
constexpr hd_std::size_t DataAccessPtnCount { 1 }Defined in src/lib/sbio/formats/random/random_traits.hh:98
NumStepKinds
Section titled “NumStepKinds”static constexpr
constexpr std::size_t NumStepKinds { 2 }Defined in src/lib/sbio/formats/random/random_traits.hh:105
Public Static Methods
Section titled “Public Static Methods”| Return | Name | Description |
|---|---|---|
SBIO_HDAllocationRequest< RandomTraits > |
get_allocation_request static inline |
|
SBIO_HDIOStatus |
discover_metadata static inline |
|
SBIO_HD constexpr StepKind |
kind_for_ptn static inline constexpr |
|
SBIO_HD hd_std::optional< StepKind > |
kind_for_step static inline |
|
SBIO_HD hd_std::size_t |
locate_bytes static inline |
|
SBIO_HD hd_std::size_t |
unit_size static inline |
|
SBIO_HDByteRegion |
locate_step static inline |
|
SBIO_HDDataResult |
get_data_in_buffer static inline |
|
SBIO_HDDataResult |
resolve_data static inline |
|
SBIO_HD std::size_t |
get_payload_size static inline |
get_allocation_request
Section titled “get_allocation_request”static inline
static inline SBIO_HDAllocationRequest< RandomTraits > get_allocation_request(GenericStreamConfig< RandomTraits > & cfg)Defined in src/lib/sbio/formats/random/random_traits.hh:148
discover_metadata
Section titled “discover_metadata”static inline
template<IOTraits IO, class StorageViewT> static inline SBIO_HDIOStatus discover_metadata(Stream< IO, RandomTraits > * streams, StorageViewT & storage, MetadataInventory< RandomTraits > & inv)Defined in src/lib/sbio/formats/random/random_traits.hh:168
kind_for_ptn
Section titled “kind_for_ptn”static inline constexpr
constexpr static inline SBIO_HD constexpr StepKind kind_for_ptn(DataAccessPtn ptn)Defined in src/lib/sbio/formats/random/random_traits.hh:221
kind_for_step
Section titled “kind_for_step”static inline
static inline SBIO_HD hd_std::optional< StepKind > kind_for_step(const DataUnit * blk)Defined in src/lib/sbio/formats/random/random_traits.hh:225
locate_bytes
Section titled “locate_bytes”static inline
static inline SBIO_HD hd_std::size_t locate_bytes(const DataUnit * blk)Defined in src/lib/sbio/formats/random/random_traits.hh:238
unit_size
Section titled “unit_size”static inline
static inline SBIO_HD hd_std::size_t unit_size(const DataUnit * blk)Defined in src/lib/sbio/formats/random/random_traits.hh:247
locate_step
Section titled “locate_step”static inline
static inline SBIO_HDByteRegion locate_step(const DataUnit * blk, StepKind kind, hd_std::uint32_t scanned_stream, hd_std::uint64_t scan_offset)Defined in src/lib/sbio/formats/random/random_traits.hh:251
get_data_in_buffer
Section titled “get_data_in_buffer”static inline
template<class StorageViewT> static inline SBIO_HDDataResult get_data_in_buffer(StorageViewT & storage, const MetadataInventory< RandomTraits > & inv, const DataRequest & req, PayloadOffsetCache & cache, DataAccessPtn ptn, std::size_t batch_idx = 0)Defined in src/lib/sbio/formats/random/random_traits.hh:259
resolve_data
Section titled “resolve_data”static inline
static inline SBIO_HDDataResult resolve_data(void * buffer, const MetadataInventory< RandomTraits > & inv, const DataRequest & req, PayloadOffsetCache & cache)Defined in src/lib/sbio/formats/random/random_traits.hh:280
get_payload_size
Section titled “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:373
Public Types
Section titled “Public Types”| Name | Description |
|---|---|
DataAccessPtn |
|
StepKind |
|
IndexingMode |
|
DefaultLocator |
|
DataUnit |
|
StepIdxType |
|
StreamTypes |
|
BrokerBufferRequirements |
|
RequestSchema |
|
DataRequest |
|
GroupKeys |
DataAccessPtn
Section titled “DataAccessPtn”enum DataAccessPtnDefined in src/lib/sbio/formats/random/random_traits.hh:95
| Value | Description |
|---|---|
Default |
StepKind
Section titled “StepKind”enum StepKindDefined in src/lib/sbio/formats/random/random_traits.hh:100
| Value | Description |
|---|---|
Default |
|
Other |
IndexingMode
Section titled “IndexingMode”enum IndexingModeDefined in src/lib/sbio/formats/random/random_traits.hh:107
| 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. |
DefaultLocator
Section titled “DefaultLocator”using DefaultLocator = CustomLambdaLocatorType: CustomLambdaLocator
Defined in src/lib/sbio/formats/random/random_traits.hh:76
DataUnit
Section titled “DataUnit”using DataUnit = randfmt::BlockType: randfmt::Block
Defined in src/lib/sbio/formats/random/random_traits.hh:82
StepIdxType
Section titled “StepIdxType”using StepIdxType = hd_std::size_tDefined in src/lib/sbio/formats/random/random_traits.hh:83
StreamTypes
Section titled “StreamTypes”using StreamTypes = StreamSet< DataStream >Type: StreamSet< DataStream >
Defined in src/lib/sbio/formats/random/random_traits.hh:93
BrokerBufferRequirements
Section titled “BrokerBufferRequirements”using BrokerBufferRequirements = RequirementsList< BufferDescriptor< roles::Metadata, 0, sizeof(randfmt::Block)>, BufferDescriptor< roles::Data, 0, sizeof(randfmt::Block)>, BufferDescriptor< roles::Index, index_ids::Steps >, BufferDescriptor< roles::Metadata, index_ids::Scratch > >Type: RequirementsList< BufferDescriptor< roles::Metadata, 0, sizeof(randfmt::Block)>, BufferDescriptor< roles::Data, 0, sizeof(randfmt::Block)>, BufferDescriptor< roles::Index, index_ids::Steps >, BufferDescriptor< roles::Metadata, index_ids::Scratch > >
Defined in src/lib/sbio/formats/random/random_traits.hh:129
RequestSchema
Section titled “RequestSchema”using RequestSchema = sbio::NamedKeys<>Type: sbio::NamedKeys<>
Defined in src/lib/sbio/formats/random/random_traits.hh:136
DataRequest
Section titled “DataRequest”using DataRequest = sbio::DataRequest< RequestSchema >Type: sbio::DataRequest< RequestSchema >
Defined in src/lib/sbio/formats/random/random_traits.hh:137
GroupKeys
Section titled “GroupKeys”using GroupKeys = sbio::NamedKeys<>Type: sbio::NamedKeys<>
Defined in src/lib/sbio/formats/random/random_traits.hh:139