C3D Toolkit  Kernel - 117950, Vision - 2.7.5.29

Stream for reading. More...

#include <io_tape_define.h>

+ Inheritance diagram for reader:
+ Collaboration diagram for reader:

Public Member Functions

DEPRECATE_DECLARE reader (membuf &sb, uint8 om)
 Constructor. More...
 
DEPRECATE_DECLARE reader (iobuf_Seq &buf, uint16 om)
 Constructor. More...
 
TapeBasereadObject (TapeBase *mem=0)
 Read the object.
 
TapeBasereadObjectPointer ()
 Read a pointer to the object.
 
virtual void ReadObjectCatalog ()
 Read the object catalog.
 
virtual TapeBaseReadObjectByPosition (const ClusterReference &)
 Read an object by position in cluster.
 
virtual bool SetReadPosition (ClusterReference &)
 Set reading position.
 
DEPRECATE_DECLARE size_t readSBytes (void *bf, size_t len)
 Read a sequence of bytes from the buffer. More...
 
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 const c3d::IModelTreeGetModelTree () const
 Get pointer to the model tree.
 
virtual bool IsFullRead ()
 Get indicator of full reading of the current object. Set indicator of full reading of the current object.
 
virtual uint32 GetLastError ()
 Get reading errors.
 
- Public Member Functions inherited from tape
virtual ~tape ()
 Destructor.
 
DEPRECATE_DECLARE iobufbuffer () const
 Get access to the buffer. More...
 
DEPRECATE_DECLARE iobufoperator() () const
 Get access to the buffer. More...
 
const iobuf_SeqGetIOBuffer () const
 Get access to the buffer.
 
iobuf_SeqGetIOBuffer ()
 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 VersionContainerGetVersionsContainer () 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.
 
ProgressBarWrapperGetProgress ()
 Get progress indicator.
 
void FinishProgress ()
 End the progress indicator.
 

Static Public Member Functions

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 (iobuf_Seq &buf, bool ownbuf, bool openSys, uint16 om, TapeRegistrator *reg)
 Constructor.
 
DEPRECATE_DECLARE reader (iobuf_Seq &buf, bool ownbuf, bool openSys, uint16 om, TapeRegistrator &reg)
 Constructor. More...
 
DEPRECATE_DECLARE reader (membuf &sb, bool openSys, uint8 om, TapeRegistrator &reg)
 Constructor. More...
 
virtual TapeBaseReadDetachedObject ()
 Read object on defined position.
 
virtual void RegisterObject (TapeBase *obj, uint8 regId, ClusterReference ref=ClusterReference())
 Register the object.
 
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_Seqbuf
 Buffer for data.
 
TapeManagermanager
 Stream manager.
 
uint8 level
 Nesting level while reading/writing.
 
TapeRegistratorregistrator
 Structure for registration of written/read addresses.
 
ProgressBarWrapperprogress
 Progress indicator.
 

Detailed Description

Stream for reading.

Stream for reading.

Constructor & Destructor Documentation

◆ reader() [1/4]

DEPRECATE_DECLARE reader::reader ( iobuf_Seq buf,
bool  ownbuf,
bool  openSys,
uint16  om,
TapeRegistrator reg 
)
protected

Constructor.

Deprecated:
The method is deprecated.

◆ reader() [2/4]

DEPRECATE_DECLARE reader::reader ( membuf sb,
bool  openSys,
uint8  om,
TapeRegistrator reg 
)
protected

Constructor.

Deprecated:
The method is deprecated.

◆ reader() [3/4]

DEPRECATE_DECLARE reader::reader ( membuf sb,
uint8  om 
)

Constructor.

Deprecated:
The method is deprecated.

◆ reader() [4/4]

DEPRECATE_DECLARE reader::reader ( iobuf_Seq buf,
uint16  om 
)

Constructor.

Deprecated:
The method is deprecated.

Member Function Documentation

◆ readSBytes()

DEPRECATE_DECLARE size_t reader::readSBytes ( void *  bf,
size_t  len 
)

Read a sequence of bytes from the buffer.

Deprecated:
The method is deprecated.

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