MR::ImageIO::Base Class Reference

#include "image_io/base.h"

Inheritance diagram for MR::ImageIO::Base:

Public Member Functions
	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)

Public Attributes
vector< File::Entry >	files

Protected Member Functions
void	check () const
virtual void	load (const Header &header, size_t buffer_size)=0
virtual void	unload (const Header &header)=0

Protected Attributes
size_t	segsize
vector< std::unique_ptr< uint8_t[]> >	addresses
bool	is_new
bool	writable

Friends
std::ostream &	operator<< (std::ostream &stream, const Base &B)

Detailed Description

Definition at line 44 of file base.h.

Constructor & Destructor Documentation

Base() [1/3]

MR::ImageIO::Base::Base

(

const Header &

header

)

Base() [2/3]

MR::ImageIO::Base::Base ( Base &&  )

defaultnoexcept

Base() [3/3]

MR::ImageIO::Base::Base ( const Base &  )

delete

~Base()

virtual MR::ImageIO::Base::~Base ( )

virtual

Member Function Documentation

check()

void MR::ImageIO::Base::check ( ) const

inlineprotected

Definition at line 108 of file base.h.

close()

void MR::ImageIO::Base::close

(

const Header &

header

)

is_file_backed()

virtual bool MR::ImageIO::Base::is_file_backed ( ) const

virtual

Reimplemented in MR::ImageIO::Scratch.

is_image_new()

bool MR::ImageIO::Base::is_image_new ( ) const

inline

Definition at line 62 of file base.h.

is_image_readwrite()

bool MR::ImageIO::Base::is_image_readwrite ( ) const

inline

Definition at line 63 of file base.h.

load()

virtual void MR::ImageIO::Base::load ( const Header &  header, size_t  buffer_size  )

protectedpure virtual

Implemented in MR::ImageIO::Default, MR::ImageIO::GZ, MR::ImageIO::Mosaic, MR::ImageIO::Pipe, MR::ImageIO::RAM, MR::ImageIO::Scratch, MR::ImageIO::SparseLegacy, and MR::ImageIO::VariableScaling.

merge()

void MR::ImageIO::Base::merge ( const Base &  B )

inline

Definition at line 90 of file base.h.

nsegments()

size_t MR::ImageIO::Base::nsegments ( ) const

inline

Definition at line 80 of file base.h.

open()

void MR::ImageIO::Base::open	(	const Header &	header,
		size_t	buffer_size = 0
	)

operator=()

Base & MR::ImageIO::Base::operator= ( const Base &  )

delete

segment()

uint8_t * MR::ImageIO::Base::segment ( size_t  n ) const

inline

Definition at line 76 of file base.h.

segment_size()

size_t MR::ImageIO::Base::segment_size ( ) const

inline

Definition at line 83 of file base.h.

set_image_is_new()

void MR::ImageIO::Base::set_image_is_new ( bool  image_is_new )

inline

Definition at line 68 of file base.h.

set_readwrite()

void MR::ImageIO::Base::set_readwrite ( bool  readwrite )

inline

Definition at line 65 of file base.h.

set_readwrite_if_existing()

void MR::ImageIO::Base::set_readwrite_if_existing ( bool  readwrite )

inline

Definition at line 71 of file base.h.

unload()

virtual void MR::ImageIO::Base::unload ( const Header &  header )

protectedpure virtual

Implemented in MR::ImageIO::Default, MR::ImageIO::GZ, MR::ImageIO::Mosaic, MR::ImageIO::Pipe, MR::ImageIO::RAM, MR::ImageIO::Scratch, MR::ImageIO::SparseLegacy, and MR::ImageIO::VariableScaling.

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  stream, const Base &  B  )

friend

Definition at line 97 of file base.h.

Member Data Documentation

addresses

vector<std::unique_ptr<uint8_t[]> > MR::ImageIO::Base::addresses

protected

Definition at line 105 of file base.h.

files

vector<File::Entry> MR::ImageIO::Base::files

Definition at line 88 of file base.h.

is_new

bool MR::ImageIO::Base::is_new

protected

Definition at line 106 of file base.h.

segsize

size_t MR::ImageIO::Base::segsize

protected

Definition at line 104 of file base.h.

writable

bool MR::ImageIO::Base::writable

protected

Definition at line 106 of file base.h.

---

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

• core/image_io/base.h