bes  Updated for version 3.20.10
dmrpp::SuperChunk Class Reference

A SuperChunk is a collection of contiguous Chunk objects along with optimized methods for data retrieval and inflation. More...

#include <SuperChunk.h>

Collaboration diagram for dmrpp::SuperChunk:
Collaboration graph

Public Member Functions

virtual bool add_chunk (std::shared_ptr< Chunk > candidate_chunk)
 Attempts to add a new Chunk to this SuperChunk. More...
 
virtual void dump (std::ostream &strm) const
 Writes the to_string() output to the stream strm. More...
 
virtual bool empty ()
 
std::vector< std::shared_ptr< Chunk > > get_chunks ()
 
std::shared_ptr< http::urlget_data_url ()
 
virtual unsigned long long get_offset ()
 
virtual unsigned long long get_size ()
 
virtual std::string id ()
 
virtual void process_child_chunks ()
 Reads the SuperChunk, inflates/deshuffles the subordinate chunks as required and copies the values into array. More...
 
virtual void process_child_chunks_unconstrained ()
 Reads the SuperChunk, inflates/deshuffles the subordinate chunks as required and copies the values into array. More...
 
virtual void read ()
 
virtual void read_unconstrained ()
 
virtual void retrieve_data ()
 Cause the SuperChunk and all of it's subordinate Chunks to be read. More...
 
 SuperChunk (const std::string sc_id, DmrppArray *parent=nullptr)
 
std::string to_string (bool verbose) const
 Makes a string representation of the SuperChunk. More...
 

Detailed Description

A SuperChunk is a collection of contiguous Chunk objects along with optimized methods for data retrieval and inflation.

Definition at line 47 of file SuperChunk.h.

Member Function Documentation

◆ add_chunk()

bool dmrpp::SuperChunk::add_chunk ( std::shared_ptr< Chunk candidate_chunk)
virtual

Attempts to add a new Chunk to this SuperChunk.

If the passed chunk has the same data url, and is it is contiguous with the current end if the SuperChunk the Chunk is added, otherwise it is skipped.

Parameters
candidate_chunkThe Chunk to add.
Returns
True when the chunk is added, false otherwise.

Definition at line 400 of file SuperChunk.cc.

◆ dump()

void dmrpp::SuperChunk::dump ( std::ostream &  strm) const
virtual

Writes the to_string() output to the stream strm.

Parameters
strm

Definition at line 640 of file SuperChunk.cc.

◆ process_child_chunks()

void dmrpp::SuperChunk::process_child_chunks ( )
virtual

Reads the SuperChunk, inflates/deshuffles the subordinate chunks as required and copies the values into array.

Parameters
target_arrayThe array into which to write the data.

Definition at line 540 of file SuperChunk.cc.

◆ process_child_chunks_unconstrained()

void dmrpp::SuperChunk::process_child_chunks_unconstrained ( )
virtual

Reads the SuperChunk, inflates/deshuffles the subordinate chunks as required and copies the values into array.

Parameters
target_arrayThe array into which to write the data.

Definition at line 578 of file SuperChunk.cc.

◆ retrieve_data()

void dmrpp::SuperChunk::retrieve_data ( )
virtual

Cause the SuperChunk and all of it's subordinate Chunks to be read.

Definition at line 503 of file SuperChunk.cc.

◆ to_string()

string dmrpp::SuperChunk::to_string ( bool  verbose = false) const

Makes a string representation of the SuperChunk.

Parameters
verboseIf set true then details of the subordinate Chunks will be included.
Returns
A string representation of the SuperChunk.

Definition at line 619 of file SuperChunk.cc.


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