openPMD-api
Public Member Functions | Public Attributes | List of all members
openPMD::WrittenChunkInfo Struct Reference

Represents the meta info around a chunk that has been written by some data producing application. More...

#include <ChunkInfo.hpp>

Inheritance diagram for openPMD::WrittenChunkInfo:
Inheritance graph
[legend]
Collaboration diagram for openPMD::WrittenChunkInfo:
Collaboration graph
[legend]

Public Member Functions

 WrittenChunkInfo (Offset, Extent, int sourceID)
 
 WrittenChunkInfo (Offset, Extent)
 
bool operator== (WrittenChunkInfo const &other) const
 
- Public Member Functions inherited from openPMD::ChunkInfo
 ChunkInfo (Offset, Extent)
 
bool operator== (ChunkInfo const &other) const
 

Public Attributes

unsigned int sourceID = 0
 ID of the data source containing the chunk.
 
- Public Attributes inherited from openPMD::ChunkInfo
Offset offset
 origin of the chunk
 
Extent extent
 size of the chunk
 

Detailed Description

Represents the meta info around a chunk that has been written by some data producing application.

Produced by BaseRecordComponent::availableChunk.

Carries along the usual chunk meta info also the ID for the data source from which the chunk is received. Examples for this include the writing MPI rank in streaming setups or the subfile containing the chunk. If not specified explicitly, the sourceID will be assumed to be 0. This information will vary between different backends and should be used for optimization purposes only.


The documentation for this struct was generated from the following files: