CFx SDK Documentation  2023 SP0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OdMemoryStream Class Referenceabstract

#include <MemoryStream.h>

Inheritance diagram for OdMemoryStream:
OdStreamBuf OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdMemoryStream)
 
virtual OdUInt32 pageDataSize () const =0
 
virtual void setPageDataSize (OdUInt32 pageDataSize)=0
 
virtual void reserve (OdUInt64 numBytes)=0
 
OdString fileName ()
 
- Public Member Functions inherited from OdStreamBuf
 ODRX_DECLARE_MEMBERS (OdStreamBuf)
 
virtual bool isEof ()
 
virtual OdUInt64 tell ()
 
virtual OdUInt64 length ()
 
virtual void truncate ()
 
virtual void rewind ()
 
virtual OdUInt64 seek (OdInt64 offset, OdDb::FilerSeekType seekType)
 
virtual OdUInt8 getByte ()
 
virtual void getBytes (void *buffer, OdUInt32 numBytes)
 
virtual void putByte (OdUInt8 value)
 
virtual void putBytes (const void *buffer, OdUInt32 numBytes)
 
virtual void copyDataTo (OdStreamBuf *pDestination, OdUInt64 sourceStart=0, OdUInt64 sourceEnd=0)
 
virtual OdUInt32 getShareMode ()
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdMemoryStreamPtr createNew (OdUInt32 pageDataSize=0x800)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

 OdMemoryStream ()
 
- Protected Member Functions inherited from OdStreamBuf
 OdStreamBuf ()
 

Detailed Description

This class defines the interface for paged-memory I/O objects.

Corresponding C++ library: TD_Root

<group Other_Classes>

Definition at line 50 of file MemoryStream.h.

Constructor & Destructor Documentation

◆ OdMemoryStream()

OdMemoryStream::OdMemoryStream ( )
protected

Member Function Documentation

◆ createNew()

static OdMemoryStreamPtr OdMemoryStream::createNew ( OdUInt32  pageDataSize = 0x800)
static

Creates a new MemoryStream object, and returns a SmartPointer to the new object.

Parameters
pageSize[in] PageDataSize.

◆ fileName()

OdString OdMemoryStream::fileName ( )
virtual

Returns a unique file name to be associated with this MemoryStream object.

Reimplemented from OdStreamBuf.

◆ ODRX_DECLARE_MEMBERS()

OdMemoryStream::ODRX_DECLARE_MEMBERS ( OdMemoryStream  )

◆ pageDataSize()

virtual OdUInt32 OdMemoryStream::pageDataSize ( ) const
pure virtual

Returns the PageDataSize for this MemoryStream object.

◆ reserve()

virtual void OdMemoryStream::reserve ( OdUInt64  numBytes)
pure virtual

Reserves the specified number of bytes for this MemoryStream object.

◆ setPageDataSize()

virtual void OdMemoryStream::setPageDataSize ( OdUInt32  pageDataSize)
pure virtual

Sets the PageDataSize for this MemoryStream object.

Parameters
pageDataSize[in] PageDataSize.

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