Developer documentation
Version 3.0.3-105-gd3941f44
MR::ImageIO::Pipe Class Reference

#include "image_io/pipe.h"

Inheritance diagram for MR::ImageIO::Pipe:
MR::ImageIO::Base

Public Member Functions

 Pipe (Base &&io_handler)
 
- Public Member Functions inherited from MR::ImageIO::Base
 Base (const Header &header)
 
 Base (Base &&) noexcept=default
 
 Base (const Base &)=delete
 
Baseoperator= (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)
 

Static Public Attributes

static bool delete_piped_images
 

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

std::unique_ptr< File::MMapmmap
 
- 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::Entryfiles
 

Detailed Description

Definition at line 29 of file pipe.h.

Constructor & Destructor Documentation

◆ Pipe()

MR::ImageIO::Pipe::Pipe ( Base &&  io_handler)
inline

Definition at line 32 of file pipe.h.

Member Function Documentation

◆ load()

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

Implements MR::ImageIO::Base.

◆ unload()

virtual void MR::ImageIO::Pipe::unload ( const Header )
protectedvirtual

Implements MR::ImageIO::Base.

Member Data Documentation

◆ delete_piped_images

bool MR::ImageIO::Pipe::delete_piped_images
static

Definition at line 34 of file pipe.h.

◆ mmap

std::unique_ptr<File::MMap> MR::ImageIO::Pipe::mmap
protected

Definition at line 37 of file pipe.h.


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