Stream for reading from several FileSpaces by given positions in clusters. More...

#include <io_tape_define.h>

Inheritance diagram for reader_ex:

Collaboration diagram for reader_ex:

Public Member Functions
virtual void	ReadObjectCatalog ()
	Read the object catalog.

virtual TapeBase *	ReadObjectByPosition (const ClusterReference &position)
	Read an object by position in cluster.

virtual bool	SetReadPosition (ClusterReference &)
	Set reading position.

virtual const c3d::IModelTree *	GetModelTree () const
	Get pointer to the model tree.

virtual bool	IsFullRead ()
	Indicator of full reading of the current object. While reading an arbitrary object there can be a need to read some data from its parent. In this case the parent object is read partially and has the flag FullRead = false. More...

virtual void	SetFullRead (bool full)
	Set indicator of full reading of the current object.

virtual uint32	GetLastError ()
	Get reading errors.

Public Member Functions inherited from reader
TapeBase *	readObject (TapeBase *mem=0)
	Read the object.

TapeBase *	readObjectPointer ()
	Read a pointer to the object.

bool	readUInt64 (uint64 &)
	Read unsigned 64-bit integer.

bool	readInt64 (int64 &)
	Read 64-bit integer.

virtual int	readByte ()
	Read a byte from the buffer.

virtual bool	readBytes (void *bf, size_t len)
	Read a sequence of bytes from the buffer.

virtual void	PreserveRegisteredObj (TapeBase *)
	Temporarily preserve registered object to be deleted after reading complete.

Public Member Functions inherited from tape
virtual	~tape ()
	Destructor.

const iobuf_Seq &	GetIOBuffer () const
	Get access to the buffer.

iobuf_Seq &	GetIOBuffer ()
	Get access to the buffer.

uint8	mode () const
	Get the buffer mode.

void	setMode (uint8 m)
	Set the buffer mode.

void	clearState (io::state sub)
	Remove the buffer state.

void	setState (io::state add)
	Add the buffer state.

void	SetVersionsByStorage ()
	Set the current version to be equal to the storage version.

VERSION	MathVersion () const
	Return the main version (of the mathematical kernel).

VERSION	AppVersion (size_t ind=-1) const
	Return the additional version (of the target application).

const VersionContainer &	GetVersionsContainer () const
	Get access to the version container.

void	SetVersionsContainer (const VersionContainer &vers) const
	Set the version of open file.

VERSION	SetStorageVersion (VERSION v)
	Set the storage version.

int	fresh () const
	Is the buffer fresh?

bool	good () const
	Whether the buffer state is correct.

virtual uint8	eof () const
	Is the end of file reached?

virtual uint32	state () const
	Get the flag of the buffer state.

virtual io::pos	tell ()
	Get current position in stream. More...

void	registrate (const TapeBase *e)
	Unregister the pointer.

void	unregistrate (const TapeBase *e)
	Does a registered object exist?

bool	exist (const TapeBase *e) const
	Flush the registration array.

void	flushRegister ()
	Get the number of registered objects.

size_t	RegisteredCount () const
	Get the maximal possible number of objects for registration.

size_t	GetMaxRegisteredCount () const
	Reserve memory for n objects.

bool	IsOwnBuffer () const
	Do we own the buffer?

void	SetOwnBuffer (bool own)
	Set the flag of buffer ownership.

uint8	GetIndexType (size_t index) const
	Get index type.

void	InitProgress (IProgressIndicator *pr)
	Work with progress indicator. More...

void	ResetProgress ()
	Release current progress indicator. Set parent progress indicator if it exists.

ProgressBarWrapper *	GetProgress ()
	Get progress indicator.

void	FinishProgress ()
	End the progress indicator.

Static Public Member Functions
static std::unique_ptr< reader_ex >	CreateReaderEx (std::unique_ptr< iobuf_Seq > buf, uint16 om)
	Create reader_ex instance for sequential buffer.

static std::unique_ptr< reader_ex >	CreateMemReaderEx (membuf &sb, uint8 om)
	Create reader for membuf.

Static Public Member Functions inherited from reader
static reader_ptr	CreateReader (std::unique_ptr< iobuf_Seq > buf, uint16 om)
	Create reader for iobuf_Seq.

static reader_ptr	CreateMemReader (membuf &sb, uint8 om)
	Create reader for membuf.

Protected Member Functions
	reader_ex (iobuf_Seq &buf, bool ownbuf, bool openSys, uint16 om)
	Constructor.

	reader_ex (membuf &sb, uint8 om)
	Constructor. More...

	reader_ex (iobuf_Seq &buf, uint16 om)
	Constructor. More...

virtual TapeBase *	ReadDetachedObject ()
	Read object on defined position.

virtual void	RegisterObject (TapeBase *obj, uint8 regId, ClusterReference ref=ClusterReference())
	Register the object.

Protected Member Functions inherited from reader
	reader (iobuf_Seq &buf, bool ownbuf, bool openSys, uint16 om, TapeRegistrator *reg)
	Constructor.

	reader (membuf &sb, uint8 om)
	Constructor. More...

	reader (iobuf_Seq &buf, uint16 om)
	Constructor. More...

size_t	ReadObjectIndex ()
	Read object index.

Protected Member Functions inherited from tape
	tape (membuf &, bool openSys, uint8 om, TapeRegistrator *, bool ownReg=false)
	Constructor.

	tape (iobuf_Seq &buf, bool ownBuf, bool openSys, uint16 om, TapeRegistrator *, bool ownReg=false)
	Constructor.

Additional Inherited Members
Public Types inherited from tape
enum	objectType
	An object type.

Protected Attributes inherited from tape
iobuf_Seq &	buf
	Buffer for data.

TapeManager &	manager
	Stream manager.

uint8	level
	Nesting level while reading/writing.

TapeRegistrator &	registrator
	Structure for registration of written/read addresses.

ProgressBarWrapper *	progress
	Progress indicator.

Detailed Description

Stream for reading from several FileSpaces by given positions in clusters.

Stream for reading from several FileSpace by given positions in clusters.

Constructor & Destructor Documentation

◆ reader_ex() [1/2]

reader_ex::reader_ex	(	membuf &	sb,
		uint8	om
	)

protected

Constructor.

Deprecated:: The method is deprecated.

◆ reader_ex() [2/2]

reader_ex::reader_ex	(	iobuf_Seq &	buf,
		uint16	om
	)

protected

Constructor.

Deprecated:: The method is deprecated.

Member Function Documentation

◆ IsFullRead()

virtual bool reader_ex::IsFullRead ( )

virtual

Indicator of full reading of the current object. While reading an arbitrary object there can be a need to read some data from its parent. In this case the parent object is read partially and has the flag FullRead = false.

Get indicator of full reading of the current object.

Reimplemented from reader.

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

io_tape_define.h

Public Member Functions

Static Public Member Functions