sirius::gdal::InputStream Class Reference

Stream an image in block. More...

#include <sirius/gdal/input_stream.h>

Public Member Functions
	InputStream (const std::string &image_path, const sirius::Size &block_size, const sirius::Size &block_margin_size, PaddingType block_padding_type)
	Instanciate an InputStreamer and set its block size. More...
	~InputStream ()=default
	InputStream (const InputStream &)=delete
InputStream &	operator= (const InputStream &)=delete
	InputStream (InputStream &&)=delete
InputStream &	operator= (InputStream &&)=delete
sirius::Size	Size ()
	Get the size of the input file. More...
StreamBlock	Read (std::error_code &ec)
	Read a block from the image. More...
bool	IsAtEnd ()
	Indicate end of image. More...

Detailed Description

Stream an image in block.

Constructor & Destructor Documentation

InputStream() [1/3]

sirius::gdal::InputStream::InputStream	(	const std::string &	image_path,
		const sirius::Size &	block_size,
		const sirius::Size &	block_margin_size,
		PaddingType	block_padding_type
	)

Instanciate an InputStreamer and set its block size.

Parameters

image_path	path to the input image
block_size	blocks size
block_margin_size	block margin size
block_padding_type	block padding type

~InputStream()

sirius::gdal::InputStream::~InputStream ( )

default

InputStream() [2/3]

sirius::gdal::InputStream::InputStream ( const InputStream &  )

delete

InputStream() [3/3]

sirius::gdal::InputStream::InputStream ( InputStream &&  )

delete

Member Function Documentation

IsAtEnd()

bool sirius::gdal::InputStream::IsAtEnd ( )

inline

Indicate end of image.

Returns

boolean if end is reached

operator=() [1/2]

InputStream& sirius::gdal::InputStream::operator= ( const InputStream &  )

delete

operator=() [2/2]

InputStream& sirius::gdal::InputStream::operator= ( InputStream &&  )

delete

Read()

StreamBlock sirius::gdal::InputStream::Read

(

std::error_code &

ec

)

Read a block from the image.

Parameters

ec	error code if operation failed

Returns

block read

Size()

sirius::Size sirius::gdal::InputStream::Size ( )

inline

Get the size of the input file.

Returns

input file size

---

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

• src/sirius/gdal/input_stream.h