Developer documentation
Version 3.0.3-105-gd3941f44
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MR::ImageIO::GZ Class Reference

#include "image_io/gz.h"

Inheritance diagram for MR::ImageIO::GZ:
MR::ImageIO::Base

Public Member Functions

 GZ (GZ &&)=default
 
 GZ (const Header &header, size_t file_header_size, size_t file_tailer_size=0)
 
uint8_t * header ()
 
uint8_t * tailer ()
 
- Public Member Functions inherited from MR::ImageIO::Base
 Base (const Header &header)
 
 Base (Base &&) noexcept=default
 
 Base (const Base &)=delete
 
Base & operator= (const Base &)=delete
 
virtual ~Base ()
 
virtual bool is_file_backed () const
 
void open (const Header &header, size_t buffer_size=0)
 
void close (const Header &header)
 
bool is_image_new () const
 
bool is_image_readwrite () const
 
void set_readwrite (bool readwrite)
 
void set_image_is_new (bool image_is_new)
 
void set_readwrite_if_existing (bool readwrite)
 
uint8_t * segment (size_t n) const
 
size_t nsegments () const
 
size_t segment_size () const
 
void merge (const Base &B)
 

Protected Member Functions

virtual void load (const Header &, size_t)
 
virtual void unload (const Header &)
 
- Protected Member Functions inherited from MR::ImageIO::Base
void check () const
 
virtual void load (const Header &header, size_t buffer_size)=0
 
virtual void unload (const Header &header)=0
 

Protected Attributes

int64_t bytes_per_segment
 
size_t lead_in_size
 
size_t lead_out_size
 
std::unique_ptr< uint8_t[]> lead_in
 
std::unique_ptr< uint8_t[]> lead_out
 
- Protected Attributes inherited from MR::ImageIO::Base
size_t segsize
 
vector< std::unique_ptr< uint8_t[]> > addresses
 
bool is_new
 
bool writable
 

Additional Inherited Members

- Public Attributes inherited from MR::ImageIO::Base
vector< File::Entry > files
 

Detailed Description

Definition at line 29 of file gz.h.

Constructor & Destructor Documentation

◆ GZ() [1/2]

MR::ImageIO::GZ::GZ ( GZ &&  )
default

◆ GZ() [2/2]

MR::ImageIO::GZ::GZ ( const Header &  header,
size_t  file_header_size,
size_t  file_tailer_size = 0 
)
inline

Definition at line 33 of file gz.h.

Member Function Documentation

◆ header()

uint8_t * MR::ImageIO::GZ::header ( )
inline

Definition at line 40 of file gz.h.

◆ load()

virtual void MR::ImageIO::GZ::load ( const Header &  ,
size_t   
)
protectedvirtual

Implements MR::ImageIO::Base.

◆ tailer()

uint8_t * MR::ImageIO::GZ::tailer ( )
inline

Definition at line 44 of file gz.h.

◆ unload()

virtual void MR::ImageIO::GZ::unload ( const Header &  )
protectedvirtual

Implements MR::ImageIO::Base.

Member Data Documentation

◆ bytes_per_segment

int64_t MR::ImageIO::GZ::bytes_per_segment
protected

Definition at line 49 of file gz.h.

◆ lead_in

std::unique_ptr<uint8_t[]> MR::ImageIO::GZ::lead_in
protected

Definition at line 51 of file gz.h.

◆ lead_in_size

size_t MR::ImageIO::GZ::lead_in_size
protected

Definition at line 50 of file gz.h.

◆ lead_out

std::unique_ptr<uint8_t[]> MR::ImageIO::GZ::lead_out
protected

Definition at line 51 of file gz.h.

◆ lead_out_size

size_t MR::ImageIO::GZ::lead_out_size
protected

Definition at line 50 of file gz.h.

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