MetadataInventory::FieldDescriptor
FieldDescriptor
Section titled “FieldDescriptor”#include <sbio/core/metadata.hh>struct FieldDescriptorDefined in src/lib/sbio/core/metadata.hh:276
The FieldDescriptor describes how to retrieve and interpret a field.
Public Attributes
Section titled “Public Attributes”| Return | Name | Description |
|---|---|---|
hd_std::uint32_t |
payload_offset |
The byte offset into a DataUnit to find the field. |
ncarray::DType |
dtype |
The datatype of the field’s data. |
hd_std::uint16_t |
rank |
The number of dimensions of the field’s data. |
hd_std::uint32_t |
shape |
The full shape of the field’s dimensions. |
hd_std::uint32_t |
field_version |
The version counter (if the descriptor changes) |
bool |
is_config |
If the descriptor is static at configuration. |
FormatMetadata |
format_meta |
If needed, any format-specific metadata for the field. |
payload_offset
Section titled “payload_offset”hd_std::uint32_t payload_offset { 0 }Defined in src/lib/sbio/core/metadata.hh:277
The byte offset into a DataUnit to find the field.
ncarray::DType dtypeDefined in src/lib/sbio/core/metadata.hh:278
The datatype of the field’s data.
hd_std::uint16_t rank { 0 }Defined in src/lib/sbio/core/metadata.hh:279
The number of dimensions of the field’s data.
hd_std::uint32_t shape[SBIO_MAX_NDIM]Defined in src/lib/sbio/core/metadata.hh:280
The full shape of the field’s dimensions.
field_version
Section titled “field_version”hd_std::uint32_t field_version { 0 }Defined in src/lib/sbio/core/metadata.hh:281
The version counter (if the descriptor changes)
is_config
Section titled “is_config”bool is_config { false }Defined in src/lib/sbio/core/metadata.hh:282
If the descriptor is static at configuration.
format_meta
Section titled “format_meta”FormatMetadata format_meta {}Type: FormatMetadata
Defined in src/lib/sbio/core/metadata.hh:285
If needed, any format-specific metadata for the field.