BatchHandle

#include <sbio/core/iteration.hh>

template<typename StepIdxType>
class BatchHandle

Defined in src/lib/sbio/core/iteration.hh:136

A batch of steps handed out by a zipped iteration, whose data has already been fetched.

The handle converts to the [StepBatch](api-sbio-StepBatch.md#stepbatch). Data for any of the zipped BrokerGroups is resolved from the already filled buffers with get, without further IO.

As with [BrokerGroup::get_multi_data](api-sbio-BrokerGroup.md#get_multi_data), results are valid until the buffers are refetched, i.e. until the zipped iteration advances.

Template Parameters

StepIdxType The step index type of the data format.

Public Methods

Return	Name	Description
`SBIO_HD`	`BatchHandle` `inline`
`SBIO_HD`	`operator StepBatch< StepIdxType >` `const` `inline`
`SBIO_HDStepBatch`< StepIdxType >	`batch` `const` `inline`	The batch of steps [first, last).
`SBIO_HD` StepIdxType	`first` `const` `inline`
`SBIO_HD` StepIdxType	`last` `const` `inline`
`SBIO_HD` StepIdxType	`count` `const` `inline`
`SBIO_HDIOStatus`	`status` `const` `inline`	The IOStatus of fetching the batch for all zipped BrokerGroups.
`SBIO_HD` auto	`get` `const` `inline`	Get data for the batch from one of the zipped BrokerGroups, without IO.

BatchHandle

inline

inline SBIO_HD BatchHandle(StepBatch< StepIdxType > batch, IOStatus status)

Defined in src/lib/sbio/core/iteration.hh:138

operator StepBatch< StepIdxType >

const inline

inline SBIO_HD operator StepBatch< StepIdxType >() const

Defined in src/lib/sbio/core/iteration.hh:143

batch

const inline

inline SBIO_HDStepBatch< StepIdxType > batch() const

Defined in src/lib/sbio/core/iteration.hh:148

The batch of steps [first, last).

first

const inline

inline SBIO_HD StepIdxType first() const

Defined in src/lib/sbio/core/iteration.hh:149

last

const inline

inline SBIO_HD StepIdxType last() const

Defined in src/lib/sbio/core/iteration.hh:150

count

const inline

inline SBIO_HD StepIdxType count() const

Defined in src/lib/sbio/core/iteration.hh:151

status

const inline

inline SBIO_HDIOStatus status() const

Defined in src/lib/sbio/core/iteration.hh:156

The IOStatus of fetching the batch for all zipped BrokerGroups.

get

const inline

template<class Group, typename... Args> inline SBIO_HD auto get(const Group & group, Args &&... args) const

Defined in src/lib/sbio/core/iteration.hh:166

Get data for the batch from one of the zipped BrokerGroups, without IO.

Returns

The requested data (as from [BrokerGroup::get_multi_data](api-sbio-BrokerGroup.md#get_multi_data)).

Parameters

Parameter	Type	Description
`group`	`const Group &`	One of the BrokerGroups the iteration was zipped over.
`args`	`Args &&...`	The arguments for the group’s DataRequest constructor.

Private Attributes

Return	Name	Description
`StepBatch`< StepIdxType >	`m_batch`
`IOStatus`	`m_status`

m_batch

StepBatch< StepIdxType > m_batch

Type: StepBatch< StepIdxType >

Defined in src/lib/sbio/core/iteration.hh:173

m_status

IOStatus m_status

Type: IOStatus

Defined in src/lib/sbio/core/iteration.hh:174