CFx SDK Documentation  2020SP3
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdFlatMemStreamImpl< TBase > Class Template Reference

#include <FlatMemStream.h>

Inheritance diagram for OdFlatMemStreamImpl< TBase >:
OdStreamPosImpl< OdEmptyBaseClass > OdEmptyBaseClass

Public Member Functions

OdUInt8data ()
 
 OdFlatMemStreamImpl ()
 
 OdFlatMemStreamImpl (void *buffer, OdUInt64 numBytes, OdUInt64 nCurPos)
 
void init (void *buffer, OdUInt64 numBytes, OdUInt64 curPosition=0)
 
OdUInt8 getByte ()
 
void getBytes (void *buffer, OdUInt32 numBytes)
 
void putByte (OdUInt8 value)
 
void putBytes (const void *buffer, OdUInt32 numBytes)
 
- Public Member Functions inherited from OdStreamPosImpl< OdEmptyBaseClass >
OdUInt64 left ()
 
OdUInt64 length ()
 
OdUInt64 tell ()
 
OdUInt64 seek (OdInt64 offset, OdDb::FilerSeekType seekType)
 
bool isEof ()
 

Protected Member Functions

virtual void append (OdUInt64 numBytes)
 

Protected Attributes

voidm_pMemData
 
- Protected Attributes inherited from OdStreamPosImpl< OdEmptyBaseClass >
OdUInt64 m_nEndPos
 
OdUInt64 m_nCurPos
 

Detailed Description

template<class TBase = OdEmptyBaseClass>
class OdFlatMemStreamImpl< TBase >

This class implements memory-resident I/O objects. Corresponding C++ library: TD_Root <group Other_Classes>

Definition at line 71 of file FlatMemStream.h.

Constructor & Destructor Documentation

◆ OdFlatMemStreamImpl() [1/2]

template<class TBase = OdEmptyBaseClass>
OdFlatMemStreamImpl< TBase >::OdFlatMemStreamImpl ( )
inline
Parameters
buffer[in] Character buffer.
numBytes[in] Number of bytes.
curPosition[in] Initial position of the file pointer.

Definition at line 97 of file FlatMemStream.h.

◆ OdFlatMemStreamImpl() [2/2]

template<class TBase = OdEmptyBaseClass>
OdFlatMemStreamImpl< TBase >::OdFlatMemStreamImpl ( void buffer,
OdUInt64  numBytes,
OdUInt64  nCurPos 
)
inline

Definition at line 99 of file FlatMemStream.h.

Member Function Documentation

◆ append()

template<class TBase = OdEmptyBaseClass>
virtual void OdFlatMemStreamImpl< TBase >::append ( OdUInt64  numBytes)
inlineprotectedvirtual

Appends the specified number of bytes to this FlatMemStream object.

Parameters
numBytes[in] Number of bytes.
Remarks
The default implementation of this function does nothing but throw an eNotOpenForWrite exception

Definition at line 90 of file FlatMemStream.h.

◆ data()

template<class TBase = OdEmptyBaseClass>
OdUInt8* OdFlatMemStreamImpl< TBase >::data ( )
inline

Returns the raw data associated with this FlatMemStream object.

Definition at line 80 of file FlatMemStream.h.

◆ getByte()

template<class TBase >
OdUInt8 OdFlatMemStreamImpl< TBase >::getByte
inline

Definition at line 193 of file FlatMemStream.h.

◆ getBytes()

template<class TBase >
void OdFlatMemStreamImpl< TBase >::getBytes ( void buffer,
OdUInt32  numBytes 
)
inline

Definition at line 200 of file FlatMemStream.h.

◆ init()

template<class TBase >
void OdFlatMemStreamImpl< TBase >::init ( void buffer,
OdUInt64  numBytes,
OdUInt64  curPosition = 0 
)
inline

Initializes this FlatMemStream object.

Parameters
buffer[in] Character buffer.
numBytes[in] Number of bytes.
curPosition[in] Initial position of the file pointer of the new object.

Definition at line 163 of file FlatMemStream.h.

◆ putByte()

template<class TBase >
void OdFlatMemStreamImpl< TBase >::putByte ( OdUInt8  value)
inline

Definition at line 208 of file FlatMemStream.h.

◆ putBytes()

template<class TBase >
void OdFlatMemStreamImpl< TBase >::putBytes ( const void buffer,
OdUInt32  numBytes 
)
inline

Definition at line 216 of file FlatMemStream.h.

Member Data Documentation

◆ m_pMemData

template<class TBase = OdEmptyBaseClass>
void* OdFlatMemStreamImpl< TBase >::m_pMemData
protected

Definition at line 75 of file FlatMemStream.h.


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