StepHandle

#include <sbio/core/iteration.hh>

template<typename StepIdxType>
class StepHandle

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

A step handed out by a zipped iteration, whose data has already been fetched.

The handle converts to the step index. Data for any of the zipped BrokerGroups is resolved from the already filled buffers with get, without further IO.

As with [BrokerGroup::get_data](api-sbio-BrokerGroup.md#get_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`	`StepHandle` `inline`
`SBIO_HD`	`operator StepIdxType` `const` `inline`
`SBIO_HD` StepIdxType	`step` `const` `inline`	The step index.
`SBIO_HDIOStatus`	`status` `const` `inline`	The IOStatus of fetching the step for all zipped BrokerGroups.
`SBIO_HD` auto	`get` `const` `inline`	Get data from one of the zipped BrokerGroups, without IO.

StepHandle

inline

inline SBIO_HD StepHandle(StepIdxType step, IOStatus status)

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

operator StepIdxType

const inline

inline SBIO_HD operator StepIdxType() const

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

step

const inline

inline SBIO_HD StepIdxType step() const

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

The step index.

status

const inline

inline SBIO_HDIOStatus status() const

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

The IOStatus of fetching the step 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:113

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

Returns

The requested data (as from [BrokerGroup::get_data](api-sbio-BrokerGroup.md#get_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
`StepIdxType`	`m_step`
`IOStatus`	`m_status`

m_step

StepIdxType m_step

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

m_status

IOStatus m_status

Type: IOStatus

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