lass::io::BinaryIMemoryBlock Class Reference

Input Stream from a memory block. More...

#include <binary_i_memory_block.h>

Inheritance diagram for lass::io::BinaryIMemoryBlock:

[legend]

Collaboration diagram for lass::io::BinaryIMemoryBlock:

[legend]


Public Member Functions
	BinaryIMemoryBlock ()
	Construct an "empty" closed stream.
	BinaryIMemoryBlock (const void *iBegin, long iSize)
	Construct stream by pointer to memory block and length of block.
	BinaryIMemoryBlock (const void iBegin, const void iEnd)
	Construct stream by pointer to memory block and to one byte past end of block.
long	tellg () const
BinaryIStream &	seekg (long iPosition)
BinaryIStream &	seekg (long iOffset, std::ios_base::seekdir iDirection)
BinaryIStream &	operator>> (char &x)
BinaryIStream &	operator>> (num::Tint8 &x)
BinaryIStream &	operator>> (num::Tuint8 &x)
BinaryIStream &	operator>> (num::Tint16 &x)
BinaryIStream &	operator>> (num::Tuint16 &x)
BinaryIStream &	operator>> (num::Tint32 &x)
BinaryIStream &	operator>> (num::Tuint32 &x)
BinaryIStream &	operator>> (num::Tint64 &x)
BinaryIStream &	operator>> (num::Tuint64 &x)
BinaryIStream &	operator>> (num::Tfloat32 &x)
BinaryIStream &	operator>> (num::Tfloat64 &x)
BinaryIStream &	operator>> (bool &x)
BinaryIStream &	operator>> (void *&x)
BinaryIStream &	operator>> (std::string &oOut)
template<typename T >
BinaryIStream &	operator>> (std::vector< T > &oOut)
template<typename T >
BinaryIStream &	operator>> (std::complex< T > &oOut)
void	read (void *oOutput, size_t iNumberOfBytes)
	read a number of bytes from stream to buffer
num::Endianness	endianness () const
void	setEndianness (num::Endianness iEndianness)
const bool	good () const
const bool	eof () const
const bool	fail () const
const bool	bad () const
std::ios_base::iostate	rdstate () const
void	clear (std::ios_base::iostate iState=std::ios_base::goodbit)
void	setstate (std::ios_base::iostate iState)
	operator num::SafeBool () const
const bool	operator! () const
Protected Member Functions
void	swap (NonCopyable &)
Private Types
typedef char	TByte
Private Member Functions
long	doTellg () const
void	doSeekg (long iOffset, std::ios_base::seekdir iDirection)
void	doRead (void *oOutput, size_t iNumberOfBytes)
Private Attributes
const TByte *	begin_
long	size_
long	position_

Detailed Description

Input Stream from a memory block.

Definition at line 68 of file binary_i_memory_block.h.

Member Typedef Documentation

typedef char lass::io::BinaryIMemoryBlock::TByte [private]

Definition at line 78 of file binary_i_memory_block.h.

Constructor & Destructor Documentation

lass::io::BinaryIMemoryBlock::BinaryIMemoryBlock ( )

Construct an "empty" closed stream.

Definition at line 54 of file binary_i_memory_block.cpp.

lass::io::BinaryIMemoryBlock::BinaryIMemoryBlock	(	const void *	iBegin,
		long	iSize
	)

Construct stream by pointer to memory block and length of block.

Definition at line 66 of file binary_i_memory_block.cpp.

References LASS_ASSERT, and size_.

lass::io::BinaryIMemoryBlock::BinaryIMemoryBlock	(	const void *	iBegin,
		const void *	iEnd
	)

Construct stream by pointer to memory block and to one byte past end of block.

Definition at line 79 of file binary_i_memory_block.cpp.

References LASS_ASSERT, and size_.

Member Function Documentation

long lass::io::BinaryIMemoryBlock::doTellg ( ) const [private, virtual]

Implements lass::io::BinaryIStream.

Definition at line 119 of file binary_i_memory_block.cpp.

References position_.

void lass::io::BinaryIMemoryBlock::doSeekg	(	long	iOffset,
		std::ios_base::seekdir	iDirection
	)			`[private, virtual]`

Implements lass::io::BinaryIStream.

Definition at line 126 of file binary_i_memory_block.cpp.

References LASS_ASSERT, position_, and size_.

void lass::io::BinaryIMemoryBlock::doRead	(	void *	oOutput,
		size_t	iNumberOfBytes
	)			`[private, virtual]`

Implements lass::io::BinaryIStream.

Definition at line 92 of file binary_i_memory_block.cpp.

References begin_, lass::io::StreamBase::good(), LASS_ASSERT, lass::stde::next(), position_, lass::io::StreamBase::setstate(), and size_.

long lass::io::BinaryIStream::tellg ( ) const [inherited]

Definition at line 73 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::doTellg().

BinaryIStream & lass::io::BinaryIStream::seekg ( long iPosition ) [inherited]

Definition at line 80 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::doSeekg().

Referenced by lass::io::Image::openTargaTrueColor(), and lass::io::Image::HeaderIgi::readFrom().

BinaryIStream & lass::io::BinaryIStream::seekg	(	long	iOffset,
		std::ios_base::seekdir	iDirection
	)			`[inherited]`

Definition at line 88 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::doSeekg().

BinaryIStream & lass::io::BinaryIStream::operator>> ( char & x ) [inherited]

Definition at line 96 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tint8 & x ) [inherited]

Definition at line 103 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tuint8 & x ) [inherited]

Definition at line 110 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tint16 & x ) [inherited]

Definition at line 117 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tuint16 & x ) [inherited]

Definition at line 124 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tint32 & x ) [inherited]

Definition at line 131 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tuint32 & x ) [inherited]

Definition at line 138 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tint64 & x ) [inherited]

Definition at line 145 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tuint64 & x ) [inherited]

Definition at line 152 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tfloat32 & x ) [inherited]

Definition at line 159 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( num::Tfloat64 & x ) [inherited]

Definition at line 166 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::readValue().

BinaryIStream & lass::io::BinaryIStream::operator>> ( bool & x ) [inherited]

Definition at line 173 of file binary_i_stream.cpp.

References lass::io::StreamBase::good().

BinaryIStream & lass::io::BinaryIStream::operator>> ( void *& x ) [inherited]

Definition at line 186 of file binary_i_stream.cpp.

References lass::io::StreamBase::good(), and LASS_META_ASSERT.

BinaryIStream & lass::io::BinaryIStream::operator>> ( std::string & oOut ) [inherited]

Definition at line 201 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::doRead(), lass::io::StreamBase::good(), and LASS_ASSERT.

template<typename T >

BinaryIStream & lass::io::BinaryIStream::operator>> ( std::vector< T > & oOut ) [inline, inherited]

Definition at line 60 of file binary_i_stream.inl.

References lass::io::StreamBase::good(), LASS_ASSERT, and lass::stde::T.

template<typename T >

BinaryIStream & lass::io::BinaryIStream::operator>> ( std::complex< T > & oOut ) [inline, inherited]

Definition at line 95 of file binary_i_stream.inl.

References lass::io::StreamBase::good(), and lass::stde::T.

void lass::io::BinaryIStream::read	(	void *	output,
		size_t	numBytes
	)			`[inherited]`

read a number of bytes from stream to buffer

Parameters:

	iBytes	pointer to buffer. Must be able to contain at least numBytes bytes.
	numBytes	number of bytes to be read

Definition at line 229 of file binary_i_stream.cpp.

References lass::io::BinaryIStream::doRead().

Referenced by lass::io::BinaryISocket::doRead(), lass::io::Image::openRadianceHdr(), lass::io::Image::openTargaTrueColor(), lass::io::Image::HeaderPfm::readFrom(), and lass::io::Image::HeaderRadianceHdr::readFrom().

num::Endianness lass::io::BinaryStreamBase::endianness ( ) const [inline, inherited]

Definition at line 75 of file binary_stream_base.h.

Referenced by lass::io::BinaryIStream::readValue(), and lass::io::BinaryOStream::writeValue().

void lass::io::BinaryStreamBase::setEndianness ( num::Endianness iEndianness ) [inline, inherited]

Definition at line 76 of file binary_stream_base.h.

Referenced by lass::io::EndiannessSetter::EndiannessSetter(), and lass::io::EndiannessSetter::~EndiannessSetter().

const bool lass::io::StreamBase::good ( ) const [inline, inherited]

Definition at line 76 of file stream_base.h.

const bool lass::io::StreamBase::eof ( ) const [inline, inherited]

Definition at line 77 of file stream_base.h.

Referenced by lass::io::Image::open(), and lass::io::Image::save().

const bool lass::io::StreamBase::fail ( ) const [inline, inherited]

Definition at line 78 of file stream_base.h.

Referenced by lass::io::StreamBase::operator num::SafeBool().

const bool lass::io::StreamBase::bad ( ) const [inline, inherited]

Definition at line 79 of file stream_base.h.

std::ios_base::iostate lass::io::StreamBase::rdstate ( ) const [inline, inherited]

Definition at line 80 of file stream_base.h.

Referenced by lass::io::XmlOElement::XmlOElement().

void lass::io::StreamBase::clear ( std::ios_base::iostate iState = std::ios_base::goodbit ) [inline, inherited]

Definition at line 81 of file stream_base.h.

Referenced by lass::io::XmlOFile::close(), lass::io::XmlOFile::open(), and lass::io::XmlOElement::XmlOElement().

void lass::io::StreamBase::setstate ( std::ios_base::iostate iState ) [inline, inherited]

Definition at line 82 of file stream_base.h.

Referenced by lass::io::BinaryOFile::close(), lass::io::BinaryIFile::close(), lass::io::BinaryOFile::doFlush(), lass::io::BinaryISocket::doRead(), lass::io::BinaryIMemoryMap::doRead(), doRead(), lass::io::BinaryIFile::doRead(), lass::io::BinaryIMemoryMap::doSeekg(), lass::io::BinaryIFile::doSeekg(), lass::io::BinaryOFile::doSeekp(), lass::io::BinaryOFile::doWrite(), lass::io::BinaryOSocket::flusher(), lass::io::BinaryOFile::open(), lass::io::BinaryIMemoryMap::open(), and lass::io::BinaryIFile::open().

lass::io::StreamBase::operator num::SafeBool ( ) const [inline, inherited]

Definition at line 83 of file stream_base.h.

References lass::io::StreamBase::fail(), lass::num::safeFalse, and lass::num::safeTrue.

const bool lass::io::StreamBase::operator! ( ) const [inline, inherited]

Definition at line 84 of file stream_base.h.

void lass::util::NonCopyable::swap ( NonCopyable & ) [inline, protected, inherited]

Definition at line 60 of file non_copyable.h.

Referenced by lass::io::Image::readLine().

Field Documentation

const TByte* lass::io::BinaryIMemoryBlock::begin_ [private]

Definition at line 84 of file binary_i_memory_block.h.

Referenced by doRead().

long lass::io::BinaryIMemoryBlock::size_ [private]

Definition at line 85 of file binary_i_memory_block.h.

Referenced by BinaryIMemoryBlock(), doRead(), and doSeekg().

long lass::io::BinaryIMemoryBlock::position_ [private]

Definition at line 86 of file binary_i_memory_block.h.

Referenced by doRead(), doSeekg(), and doTellg().

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

library of assembled shared sources

lass::io::BinaryIMemoryBlock Class Reference

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation