SuperBlock

SuperBlock

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

struct SuperBlock

Defined in src/lib/sbio/formats/random/randfmt.hh:126

The payload of a SuperBlock.

This payload begins immediately following the Header. If the flags have been configured to include the sub-block offset table, those offsets will begin immediately following the _reserved field and can be accessed via the offsets function. If the sub-block offset table has not been used, then this function will be meaningless (or, more specifically, ends up pointing to the first sub-block, i.e. it’s Header).

List of all members

Name	Kind	Owner
sequence_num	variable	Declared here
num_blocks	variable	Declared here
user	variable	Declared here
_reserved	variable	Declared here
offsets	function	Declared here

Public Attributes

Return	Name	Description
hd_std::uint64_t	sequence_num	Sequence number - e.g., timestamp, or similar.
hd_std::uint8_t	num_blocks	Number of subequent blocks in super-block group.
hd_std::uint8_t	user	Field blank for arbitrary user use.
hd_std::uint16_t	_reserved	Reserved for future use.

---

sequence_num

hd_std::uint64_t sequence_num { 0 }

Defined in src/lib/sbio/formats/random/randfmt.hh:127

Sequence number - e.g., timestamp, or similar.

---

num_blocks

hd_std::uint8_t num_blocks { 0 }

Defined in src/lib/sbio/formats/random/randfmt.hh:128

Number of subequent blocks in super-block group.

---

user

hd_std::uint8_t user { 0 }

Defined in src/lib/sbio/formats/random/randfmt.hh:129

Field blank for arbitrary user use.

---

_reserved

hd_std::uint16_t _reserved { 0 }

Defined in src/lib/sbio/formats/random/randfmt.hh:130

Reserved for future use.

Public Methods

Return	Name	Description
SBIO_HD const hd_std::uint32_t *	offsets const inline	If bit-0 of flags is enabled, a sub-block offset table can be accessed.

---

offsets

const inline

inline SBIO_HD const hd_std::uint32_t * offsets() const

Defined in src/lib/sbio/formats/random/randfmt.hh:141

If bit-0 of flags is enabled, a sub-block offset table can be accessed.

The offset-table that is written contains jumps to each sub-block WITHIN the SuperBlock. This is independent of the file-wide IndexEntry which is a separate feature that can be toggled.

Returns

Pointer to the offset table. Only offsets if the flag was enabled.