OdGsFiler Class Reference

#include <GsFiler.h>

Inheritance diagram for OdGsFiler:

Classes
struct	SubstitutionActuator
struct	Substitutor

Public Types
enum	Section {   kEOFSection = -1 , kHeaderSection = 0 , kDatabaseLinkSection , kGsModuleSection ,   kDeviceSection , kClientDeviceSection , kViewSection , kClientViewSection ,   kModelSection , kClientModelSection , kNodeSection , kClientNodeSection ,   kMetafileSection , kClientMetafileSection , kClientMaterialSection , kBlockRefImplSection ,   kLinkedDeviceSection , kRenditionSection , kRuntimeChangesSection }
enum	Version { kV1 = 100 , kV2 = 200 , kVLast = kV2 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsFiler)
	OdGsFiler ()
virtual	~OdGsFiler ()
virtual bool	setStream (OdStreamBuf *pStream, bool bWrite=false)=0
virtual OdStreamBufPtr	getStream () const =0
virtual void	setDatabase (const OdDbBaseDatabase *pDb)=0
virtual OdDbBaseDatabase *	getDatabase () const =0
virtual void	setVersion (OdUInt32 nVersion)=0
virtual OdUInt32	version () const =0
virtual void	wrDbHash (const OdDbBaseDatabase *pDb)=0
virtual bool	checkDbHash (const OdDbBaseDatabase *pDb)=0
virtual void	setWriteSections (OdUInt64 nSections)=0
virtual void	setWriteSection (Section section, bool bSet)=0
virtual bool	isWriteSection (Section section) const =0
virtual void	setReadSections (OdUInt64 nSections)=0
virtual void	setReadSection (Section section, bool bSet)=0
virtual bool	isReadSection (Section section) const =0
virtual void	wrSectionBegin (Section section)=0
virtual void	wrSectionEnd (Section section)=0
virtual void	wrEOFSection ()=0
virtual Section	rdSection () const =0
virtual Section	curSection () const =0
virtual void	skipSection () const =0
virtual void	rdBackSection () const =0
virtual bool	checkEOF () const =0
virtual Substitutor *	subst () const =0
virtual void	makeSubstitutions (bool bClear=true) const =0
virtual OdRxObjectPtr	getSubstitutor () const =0
virtual void	setSubstitutor (OdRxObject *pSubst)=0
virtual void	setArbitraryData (const OdChar *pName, OdRxObject *pObject)=0
virtual OdRxObjectPtr	getArbitraryData (const OdChar *pName) const =0
virtual bool	hasArbitraryData (const OdChar *pName) const =0
virtual void	clearArbitraryData ()=0
virtual void	registerPtr (const void *pPtr)=0
virtual void	unregisterPtr (const void *pPtr)=0
virtual bool	isPtrRegistered (const void *pPtr) const =0
virtual void	clearRegisteredPtrs ()=0
virtual void	wrHandle (OdDbStub *pHandle)=0
virtual OdDbStub *	rdHandle () const =0
virtual void	wrClass (OdRxObject *pObj)=0
virtual OdRxObjectPtr	rdClass () const =0
virtual void	wrRawData (const void *pData, OdUInt32 nDataSize)=0
virtual void	rdRawData (void *pData, OdUInt32 nDataSize) const =0
virtual void	wrBool (bool bVal)
virtual bool	rdBool () const
virtual void	wrInt (int val)
virtual int	rdInt () const
virtual void	wrUInt (unsigned int val)
virtual unsigned int	rdUInt () const
virtual void	wrChar (char val)
virtual char	rdChar () const
virtual void	wrUInt8 (OdUInt8 val)
virtual OdUInt8	rdUInt8 () const
virtual void	wrInt16 (OdInt16 val)
virtual OdInt16	rdInt16 () const
virtual void	wrUInt16 (OdUInt16 val)
virtual OdUInt16	rdUInt16 () const
virtual void	wrInt32 (OdInt32 val)
virtual OdInt32	rdInt32 () const
virtual void	wrUInt32 (OdUInt32 val)
virtual OdUInt32	rdUInt32 () const
virtual void	wrInt64 (OdInt64 val)
virtual OdInt64	rdInt64 () const
virtual void	wrUInt64 (OdUInt64 val)
virtual OdUInt64	rdUInt64 () const
virtual void	wrIntPtr (OdIntPtr val)
virtual OdIntPtr	rdIntPtr () const
void	wrPtr (const void *pPtr)
void *	rdPtr () const
virtual void	wrCOLORREF (ODCOLORREF val)
virtual ODCOLORREF	rdCOLORREF () const
virtual void	wrFloat (float val)
virtual float	rdFloat () const
virtual void	wrDouble (double val)
virtual double	rdDouble () const
virtual void	wrPoint2d (const OdGePoint2d &pt)
virtual void	rdPoint2d (OdGePoint2d &pt) const
virtual void	wrVector2d (const OdGeVector2d &vec)
virtual void	rdVector2d (OdGeVector2d &vec) const
virtual void	wrPoint3d (const OdGePoint3d &pt)
virtual void	rdPoint3d (OdGePoint3d &pt) const
virtual void	wrVector3d (const OdGeVector3d &vec)
virtual void	rdVector3d (OdGeVector3d &vec) const
virtual void	wrMatrix3d (const OdGeMatrix3d &mat)
virtual void	rdMatrix3d (OdGeMatrix3d &mat) const
virtual void	wrExtents3d (const OdGeExtents3d &ext)
virtual void	rdExtents3d (OdGeExtents3d &ext) const
virtual void	wrAnsiString (const OdAnsiString &str)
virtual void	rdAnsiString (OdAnsiString &str) const
OdAnsiString	rdAnsiStringRet () const
virtual void	wrString (const OdString &str)
virtual void	rdString (OdString &str) const
OdString	rdStringRet () const
virtual void	wrUInt8Array (const OdUInt8Array &arr)
virtual void	wrUInt16Array (const OdUInt16Array &arr)
virtual void	wrUInt16Array (OdUInt32 count, const OdUInt16 *arr)
virtual void	wrUInt32Array (const OdUInt32Array &arr)
virtual void	wrUInt32Array (const OdUInt32Vector &arr)
virtual void	wrUInt64Array (const OdUInt64Array &arr)
virtual void	wrUInt64Array (const OdUInt64Vector &vec)
virtual void	wrUInt64Array (OdUInt32 count, const OdUInt64 *arr)
virtual void	wrIntArray (const OdIntArray &arr)
virtual void	wrFloatArray (const OdFloatArray &arr)
virtual void	wrFloatArray (OdUInt32 count, const float *arr)
virtual void	wrPoint2dArray (const OdGePoint2dArray &arr)
virtual void	wrPoint3dArray (const OdGePoint3dArray &arr)
virtual void	wrDbStubPtrArray (const OdDbStubPtrArray &arr)
virtual void	wrGsDCRect (const OdGsDCRect &rc)
virtual void	wrGsDCRectDouble (const OdGsDCRectDouble &rcd)
virtual void	rdUInt8Array (OdUInt8Array &arr)
virtual void	rdUInt16Array (OdUInt16Array &arr)
virtual void	rdUInt16Array (OdUInt32 count, OdUInt16 *arr)
virtual void	rdUInt32Array (OdUInt32Array &arr)
virtual void	rdUInt32Array (OdUInt32Vector &arr)
virtual void	rdUInt64Array (OdUInt64Array &arr)
virtual void	rdUInt64Array (OdUInt64Vector &vec)
virtual void	rdUInt64Array (OdUInt32 count, OdUInt64 *arr)
virtual void	rdIntArray (OdIntArray &arr)
virtual void	rdFloatArray (OdFloatArray &arr)
virtual void	rdFloatArray (OdUInt32 count, float *arr)
virtual void	rdPoint2dArray (OdGePoint2dArray &arr)
virtual void	rdPoint3dArray (OdGePoint3dArray &arr)
virtual void	rdDbStubPtrArray (OdDbStubPtrArray &arr)
virtual void	rdGsDCRect (OdGsDCRect &dcrc)
virtual void	rdGsDCRectDouble (OdGsDCRectDouble &dcrcd)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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 OdSmartPtr< OdGsFiler >	createObject (OdStreamBuf *pStream, bool bForWrite, const OdDbBaseDatabase *pDb, OdUInt32 nVersion=kVLast)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

<group OdGs_Classes>

Definition at line 62 of file GsFiler.h.

Member Enumeration Documentation

Section

enum OdGsFiler::Section

Represents a file section.

Enumerator
kEOFSection
kHeaderSection
kDatabaseLinkSection
kGsModuleSection
kDeviceSection
kClientDeviceSection
kViewSection
kClientViewSection
kModelSection
kClientModelSection
kNodeSection
kClientNodeSection
kMetafileSection
kClientMetafileSection
kClientMaterialSection
kBlockRefImplSection
kLinkedDeviceSection
kRenditionSection
kRuntimeChangesSection

Definition at line 80 of file GsFiler.h.

Version

enum OdGsFiler::Version

Represents a file version.

Enumerator
kV1
kV2
kVLast

Definition at line 107 of file GsFiler.h.

Constructor & Destructor Documentation

OdGsFiler()

OdGsFiler::OdGsFiler ( )

inline

Default constructor for the OdGsFiler class.

Definition at line 70 of file GsFiler.h.

~OdGsFiler()

virtual OdGsFiler::~OdGsFiler ( )

inlinevirtual

Destructor for the OdGsFiler class.

Definition at line 75 of file GsFiler.h.

Member Function Documentation

checkDbHash()

virtual bool OdGsFiler::checkDbHash ( const OdDbBaseDatabase *  pDb )

pure virtual

Implemented in OdGsFilerV100Impl.

checkEOF()

virtual bool OdGsFiler::checkEOF ( ) const

pure virtual

Checks whether currently read section is the end of file (EOF) section.

Returns

true if current section is EOF section, false otherwise.

Implemented in OdGsFilerV100Impl.

clearArbitraryData()

virtual void OdGsFiler::clearArbitraryData ( )

pure virtual

Implemented in OdGsFilerV100Impl.

clearRegisteredPtrs()

virtual void OdGsFiler::clearRegisteredPtrs ( )

pure virtual

Implemented in OdGsFilerV100Impl.

createObject()

static OdSmartPtr< OdGsFiler > OdGsFiler::createObject ( OdStreamBuf *  pStream, bool  bForWrite, const OdDbBaseDatabase *  pDb, OdUInt32  nVersion = kVLast  )

static

Creates a filer object and returns a smart pointer to it.

Parameters

pStream	[in] Pointer to a stream buffer.
bForWrite	[in] Flag that specifies whether to open filer for write operations.
pDb	[in] Pointer to a database.
nVersion	[in] File version.

curSection()

virtual Section OdGsFiler::curSection ( ) const

pure virtual

Retrieves the current section.

Implemented in OdGsFilerV100Impl.

getArbitraryData()

virtual OdRxObjectPtr OdGsFiler::getArbitraryData ( const OdChar *  pName ) const

pure virtual

Implemented in OdGsFilerV100Impl.

getDatabase()

virtual OdDbBaseDatabase * OdGsFiler::getDatabase ( ) const

pure virtual

Retrieves a pointer to a database that is used for this stream.

Implemented in OdGsFilerV100Impl.

getStream()

virtual OdStreamBufPtr OdGsFiler::getStream ( ) const

pure virtual

Retrieves a smart pointer to current stream.

Implemented in OdGsFilerV100Impl.

getSubstitutor()

virtual OdRxObjectPtr OdGsFiler::getSubstitutor ( ) const

pure virtual

Implemented in OdGsFilerV100Impl.

hasArbitraryData()

virtual bool OdGsFiler::hasArbitraryData ( const OdChar *  pName ) const

pure virtual

Implemented in OdGsFilerV100Impl.

isPtrRegistered()

virtual bool OdGsFiler::isPtrRegistered ( const void *  pPtr ) const

pure virtual

Implemented in OdGsFilerV100Impl.

isReadSection()

virtual bool OdGsFiler::isReadSection ( Section  section ) const

pure virtual

Checks whether the specified section is opened for read operations.

Parameters

section

[in] Section to check.

Returns

true if read operations are enabled for the section, false otherwise.

Implemented in OdGsFilerV100Impl.

isWriteSection()

virtual bool OdGsFiler::isWriteSection ( Section  section ) const

pure virtual

Checks whether the specified section is opened for write operations.

Parameters

section

[in] Section to check.

Returns

true if write operations are enabled for the section, false otherwise.

Implemented in OdGsFilerV100Impl.

makeSubstitutions()

virtual void OdGsFiler::makeSubstitutions ( bool  bClear = true ) const

pure virtual

Implemented in OdGsFilerV100Impl.

ODRX_DECLARE_MEMBERS()

OdGsFiler::ODRX_DECLARE_MEMBERS

(

OdGsFiler

)

rdAnsiString()

virtual void OdGsFiler::rdAnsiString ( OdAnsiString &  str ) const

virtual

Reads data of OdAnsiString type from the stream.

Parameters

str	[out] Receives ANSI string.

rdAnsiStringRet()

OdAnsiString OdGsFiler::rdAnsiStringRet ( ) const

inline

Reads and returns data of OdAnsiString type from the stream.

Definition at line 679 of file GsFiler.h.

rdBackSection()

virtual void OdGsFiler::rdBackSection ( ) const

pure virtual

Implemented in OdGsFilerV100Impl.

rdBool()

virtual bool OdGsFiler::rdBool ( ) const

virtual

Reads data of bool type from the stream.

Returns

read bool value.

rdChar()

virtual char OdGsFiler::rdChar ( ) const

virtual

Reads data of char type from the stream.

Returns

read char value.

rdClass()

virtual OdRxObjectPtr OdGsFiler::rdClass ( ) const

pure virtual

Retrieves a smart pointer to a class at current stream position.

Returns

smart pointer to a class by read class name, if class not found by class name this method returns a smart pointer to a not valid class.

Implemented in OdGsFilerV100Impl.

rdCOLORREF()

virtual ODCOLORREF OdGsFiler::rdCOLORREF ( ) const

virtual

Reads the color data defined by the ODCOLORREF macro. Length of the read data equals to OdUInt32 data type length.

rdDbStubPtrArray()

virtual void OdGsFiler::rdDbStubPtrArray ( OdDbStubPtrArray &  arr )

virtual

Reads an array of pointers to database-resident objects from the stream.

Parameters

arr	[out] Receives an array of pointers to database-resident objects.

rdDouble()

virtual double OdGsFiler::rdDouble ( ) const

virtual

Reads data of double type from the stream.

Returns

read double value.

rdExtents3d()

virtual void OdGsFiler::rdExtents3d ( OdGeExtents3d &  ext ) const

virtual

Reads data of OdGeExtents3d type from the stream.

Parameters

ext	[out] Receives 3D extents.

rdFloat()

virtual float OdGsFiler::rdFloat ( ) const

virtual

Reads data of float type from the stream.

Returns

read float value.

rdFloatArray() [1/2]

virtual void OdGsFiler::rdFloatArray ( OdFloatArray &  arr )

virtual

Reads an array of float values from the stream.

Parameters

arr	[out] Receives an array of float values.

rdFloatArray() [2/2]

virtual void OdGsFiler::rdFloatArray ( OdUInt32  count, float *  arr  )

virtual

Reads an array of float values from the stream.

Parameters

count	[in] Count of elements in the array.
arr	[out] Receives an array of float values.

rdGsDCRect()

virtual void OdGsFiler::rdGsDCRect ( OdGsDCRect &  dcrc )

virtual

Reads an array of 2D device rectangles from the stream.

Parameters

arr	[out] Receives an array of 2D device rectangles.

rdGsDCRectDouble()

virtual void OdGsFiler::rdGsDCRectDouble ( OdGsDCRectDouble &  dcrcd )

virtual

Reads an array of 2D device rectangles (with coordinates represented by values of the double type) from the stream.

Parameters

arr	[out] Receives an array of 2D device rectangles (with coordinates represented by values of the double type).

rdHandle()

virtual OdDbStub * OdGsFiler::rdHandle ( ) const

pure virtual

Retrieves a pointer to database handle.

Implemented in OdGsFilerV100Impl.

rdInt()

virtual int OdGsFiler::rdInt ( ) const

virtual

Reads data of int type from the stream.

Returns

read int value.

rdInt16()

virtual OdInt16 OdGsFiler::rdInt16 ( ) const

virtual

Reads data of OdInt16 type (int 16 bits) from the stream.

Returns

read OdInt16 value.

rdInt32()

virtual OdInt32 OdGsFiler::rdInt32 ( ) const

virtual

Reads data of OdInt32 type (int 32 bits) from the stream.

Returns

read OdInt32 value.

rdInt64()

virtual OdInt64 OdGsFiler::rdInt64 ( ) const

virtual

Reads data of OdInt64 type (int 64 bits) from the stream.

Returns

read OdInt64 value.

rdIntArray()

virtual void OdGsFiler::rdIntArray ( OdIntArray &  arr )

virtual

Reads an array of integer values from the stream.

Parameters

arr	[out] Receives an array of integer values.

rdIntPtr()

virtual OdIntPtr OdGsFiler::rdIntPtr ( ) const

virtual

Reads data of rdIntPtr type (integer that is able to store a pointer (32 or 64 depending on platform)) from the stream.

Returns

read OdIntPtr value.

rdMatrix3d()

virtual void OdGsFiler::rdMatrix3d ( OdGeMatrix3d &  mat ) const

virtual

Reads data of OdGeMatrix3d type from the stream.

Parameters

mat	[out] Receives 3D transformation matrix.

rdPoint2d()

virtual void OdGsFiler::rdPoint2d ( OdGePoint2d &  pt ) const

virtual

Reads data of OdGePoint2d type from the stream.

Parameters

pt	[out] Receives 2D point.

rdPoint2dArray()

virtual void OdGsFiler::rdPoint2dArray ( OdGePoint2dArray &  arr )

virtual

Reads an array of 2D points from the stream.

Parameters

arr	[out] Receives an array of 2D points.

rdPoint3d()

virtual void OdGsFiler::rdPoint3d ( OdGePoint3d &  pt ) const

virtual

Reads data of OdGePoint3d type from the stream.

Parameters

pt	[out] Receives 3D point.

rdPoint3dArray()

virtual void OdGsFiler::rdPoint3dArray ( OdGePoint3dArray &  arr )

virtual

Reads an array of 3D points from the stream.

Parameters

arr	[out] Receives an array of 3D points.

rdPtr()

void * OdGsFiler::rdPtr ( ) const

inline

Reads the data and returns pointer to it. Length of the read data equals to OdIntPtr data type length.

Definition at line 534 of file GsFiler.h.

rdRawData()

virtual void OdGsFiler::rdRawData ( void *  pData, OdUInt32  nDataSize  ) const

pure virtual

Reads raw data from the stream.

Parameters

pData	[out] Pointer to data (in bytes).
nDataSize	[in] Data size.

Implemented in OdGsFilerV100Impl.

rdSection()

virtual Section OdGsFiler::rdSection ( ) const

pure virtual

Reads sections one by one and returns a current section for which read access is not enabled or the EOF section.

Implemented in OdGsFilerV100Impl.

rdString()

virtual void OdGsFiler::rdString ( OdString &  str ) const

virtual

Reads data of OdString type (string) from the stream.

Parameters

str	[out] Receives a string.

rdStringRet()

OdString OdGsFiler::rdStringRet ( ) const

inline

Reads and returns data of OdString type from the stream.

Definition at line 698 of file GsFiler.h.

rdUInt()

virtual unsigned int OdGsFiler::rdUInt ( ) const

virtual

Reads data of unsigned int type from the stream.

Returns

read unsigned int value.

rdUInt16()

virtual OdUInt16 OdGsFiler::rdUInt16 ( ) const

virtual

Reads data of OdUInt16 type (unsigned int 16 bits) from the stream.

Returns

read OdUInt16 value.

rdUInt16Array() [1/2]

virtual void OdGsFiler::rdUInt16Array ( OdUInt16Array &  arr )

virtual

Reads an array of OdUInt16 values (unsigned int 16 bits) from the stream.

Parameters

arr	[out] Receives an array of OdUInt16 values.

rdUInt16Array() [2/2]

virtual void OdGsFiler::rdUInt16Array ( OdUInt32  count, OdUInt16 *  arr  )

virtual

Reads an array of OdUInt16 values (unsigned int 16 bits) from the stream.

Parameters

count	[in] Count of elements in the array.
arr	[out] Receives an array of OdUInt16 values.

rdUInt32()

virtual OdUInt32 OdGsFiler::rdUInt32 ( ) const

virtual

Reads data of OdUInt32 type (unsigned int 32 bits) from the stream.

Returns

read OdUInt32 value.

rdUInt32Array() [1/2]

virtual void OdGsFiler::rdUInt32Array ( OdUInt32Array &  arr )

virtual

Reads an array of OdUInt32 values (unsigned int 32 bits) from the stream.

Parameters

arr	[out] Receives an array of OdUInt32 values.

rdUInt32Array() [2/2]

virtual void OdGsFiler::rdUInt32Array ( OdUInt32Vector &  arr )

virtual

Reads a vector of OdUInt32 values (unsigned int 32 bits) from the stream.

Parameters

arr	[out] Receives a vector of OdUInt32 values.

rdUInt64()

virtual OdUInt64 OdGsFiler::rdUInt64 ( ) const

virtual

Reads data of OdUInt64 type (unsigned int 64 bits) from the stream.

Returns

read OdUInt64 value.

rdUInt64Array() [1/3]

virtual void OdGsFiler::rdUInt64Array ( OdUInt32  count, OdUInt64 *  arr  )

virtual

Reads an array of OdUInt64 values (unsigned int 64 bits) from the stream.

Parameters

count	[in] Count of elements in the array.
arr	[out] Receives an array of OdUInt64 values.

rdUInt64Array() [2/3]

virtual void OdGsFiler::rdUInt64Array ( OdUInt64Array &  arr )

virtual

Reads an array of OdUInt64 values (unsigned int 64 bits) from the stream.

Parameters

arr	[out] Receives an array of OdUInt64 values.

rdUInt64Array() [3/3]

virtual void OdGsFiler::rdUInt64Array ( OdUInt64Vector &  vec )

virtual

Reads a vector of OdUInt64 values (unsigned int 64 bits) from the stream.

Parameters

arr	[out] Receives a vector of OdUInt64 values.

rdUInt8()

virtual OdUInt8 OdGsFiler::rdUInt8 ( ) const

virtual

Reads data of OdUInt8 type (unsigned int 8 bits) from the stream.

Returns

read OdUInt8 value.

rdUInt8Array()

virtual void OdGsFiler::rdUInt8Array ( OdUInt8Array &  arr )

virtual

Reads an array of OdUInt8 values (unsigned int 8 bits) from the stream.

Parameters

arr	[out] Receives an array of OdUInt8 values.

rdVector2d()

virtual void OdGsFiler::rdVector2d ( OdGeVector2d &  vec ) const

virtual

Reads data of OdGeVector2d type from the stream.

Parameters

vec	[out] Receives 2D vector.

rdVector3d()

virtual void OdGsFiler::rdVector3d ( OdGeVector3d &  vec ) const

virtual

Reads data of OdGeVector3d type from the stream.

Parameters

vec	[out] Receives 3D vector.

registerPtr()

virtual void OdGsFiler::registerPtr ( const void *  pPtr )

pure virtual

Implemented in OdGsFilerV100Impl.

setArbitraryData()

virtual void OdGsFiler::setArbitraryData ( const OdChar *  pName, OdRxObject *  pObject  )

pure virtual

Implemented in OdGsFilerV100Impl.

setDatabase()

virtual void OdGsFiler::setDatabase ( const OdDbBaseDatabase *  pDb )

pure virtual

Sets a specified database.

Parameters

pDb	[in] Pointer to a database to set.

Implemented in OdGsFilerV100Impl.

setReadSection()

virtual void OdGsFiler::setReadSection ( Section  section, bool  bSet  )

pure virtual

Sets the specified section for read operations.

Parameters

section	[in] Section to set.
bSet	[in] Flag that specifies whether to read the section.

Implemented in OdGsFilerV100Impl.

setReadSections()

virtual void OdGsFiler::setReadSections ( OdUInt64  nSections )

pure virtual

Sets sections for read operations.

Parameters

nSections

[in] Sections to set for reading.

Implemented in OdGsFilerV100Impl.

setStream()

virtual bool OdGsFiler::setStream ( OdStreamBuf *  pStream, bool  bWrite = false  )

pure virtual

Attaches a specified stream and opens it for read and potentially write operations.

Parameters

pStream	[in] Pointer to a stream to set.
bWrite	[in] Flag that specifies whether to open stream for write operations.

Implemented in OdGsFilerV100Impl.

setSubstitutor()

virtual void OdGsFiler::setSubstitutor ( OdRxObject *  pSubst )

pure virtual

Implemented in OdGsFilerV100Impl.

setVersion()

virtual void OdGsFiler::setVersion ( OdUInt32  nVersion )

pure virtual

Sets a file version for this filer.

Parameters

nVersion

[in] File version. See Version enum.

Implemented in OdGsFilerV100Impl.

setWriteSection()

virtual void OdGsFiler::setWriteSection ( Section  section, bool  bSet  )

pure virtual

Sets the specified section for write operations.

Parameters

section	[in] Section to set.
bSet	[in] Flag that specifies whether to write to the section.

Implemented in OdGsFilerV100Impl.

setWriteSections()

virtual void OdGsFiler::setWriteSections ( OdUInt64  nSections )

pure virtual

Sets sections for write operations.

Parameters

nSections

[in] Sections to set for writing.

Implemented in OdGsFilerV100Impl.

skipSection()

virtual void OdGsFiler::skipSection ( ) const

pure virtual

Skips the current section and makes the following section current.

Implemented in OdGsFilerV100Impl.

subst()

virtual Substitutor * OdGsFiler::subst ( ) const

pure virtual

Implemented in OdGsFilerV100Impl.

unregisterPtr()

virtual void OdGsFiler::unregisterPtr ( const void *  pPtr )

pure virtual

Implemented in OdGsFilerV100Impl.

version()

virtual OdUInt32 OdGsFiler::version ( ) const

pure virtual

Retrieves a file version for this filer.

Returns

one of the following values: 100 - file version 1 200 - file version 2

Implemented in OdGsFilerV100Impl.

wrAnsiString()

virtual void OdGsFiler::wrAnsiString ( const OdAnsiString &  str )

virtual

Writes data of OdAnsiString type (ANSI string) to the stream.

Parameters

str	[in] Data to write.

wrBool()

virtual void OdGsFiler::wrBool ( bool  bVal )

virtual

Writes data of bool type to the stream.

Parameters

bVal	[in] Data to write.

wrChar()

virtual void OdGsFiler::wrChar ( char  val )

virtual

Writes data of char type to the stream.

Parameters

val	[in] Data to write.

wrClass()

virtual void OdGsFiler::wrClass ( OdRxObject *  pObj )

pure virtual

Writes a name of the class associated with passed object to the stream.

Parameters

pObj	[in] Pointer to database handle.

Implemented in OdGsFilerV100Impl.

wrCOLORREF()

virtual void OdGsFiler::wrCOLORREF ( ODCOLORREF  val )

virtual

Writes color value defined by the ODCOLORREF macro.

Parameters

val	[in] Value to write.

wrDbHash()

virtual void OdGsFiler::wrDbHash ( const OdDbBaseDatabase *  pDb )

pure virtual

Implemented in OdGsFilerV100Impl.

wrDbStubPtrArray()

virtual void OdGsFiler::wrDbStubPtrArray ( const OdDbStubPtrArray &  arr )

virtual

Writes an array of pointers to database-resident objects to the stream.

Parameters

arr	[in] Array to write.

wrDouble()

virtual void OdGsFiler::wrDouble ( double  val )

virtual

Writes data of double type to the stream.

Parameters

val	[in] Data to write.

wrEOFSection()

virtual void OdGsFiler::wrEOFSection ( )

pure virtual

Writes the end of file (EOF) section.

Implemented in OdGsFilerV100Impl.

wrExtents3d()

virtual void OdGsFiler::wrExtents3d ( const OdGeExtents3d &  ext )

virtual

Writes data of OdGeExtents3d type (3-dimensional extents) to the stream.

Parameters

ext	[in] Data to write.

wrFloat()

virtual void OdGsFiler::wrFloat ( float  val )

virtual

Writes data of float type to the stream.

Parameters

val	[in] Data to write.

wrFloatArray() [1/2]

virtual void OdGsFiler::wrFloatArray ( const OdFloatArray &  arr )

virtual

Writes an array of float values to the stream.

Parameters

arr	[in] Array to write.

wrFloatArray() [2/2]

virtual void OdGsFiler::wrFloatArray ( OdUInt32  count, const float *  arr  )

virtual

Writes an array of float values to the stream.

Parameters

count	[in] Count of elements in the array.
arr	[in] Array to write.

wrGsDCRect()

virtual void OdGsFiler::wrGsDCRect ( const OdGsDCRect &  rc )

virtual

Writes an array of 2D device rectangles to the stream.

Parameters

rc	[in] Array to write.

wrGsDCRectDouble()

virtual void OdGsFiler::wrGsDCRectDouble ( const OdGsDCRectDouble &  rcd )

virtual

Writes an array of 2D device rectangles (with coordinates represented by values of the double type) to the stream.

Parameters

rcd	[in] Array to write.

wrHandle()

virtual void OdGsFiler::wrHandle ( OdDbStub *  pHandle )

pure virtual

Writes database handle to the stream.

Parameters

pHandle

[in] Pointer to database handle.

Implemented in OdGsFilerV100Impl.

wrInt()

virtual void OdGsFiler::wrInt ( int  val )

virtual

Writes data of int type to the stream.

Parameters

val	[in] Data to write.

wrInt16()

virtual void OdGsFiler::wrInt16 ( OdInt16  val )

virtual

Writes data of OdInt16 type (int 16 bits) to the stream.

Parameters

val	[in] Data to write.

wrInt32()

virtual void OdGsFiler::wrInt32 ( OdInt32  val )

virtual

Writes data of OdInt32 type (int 32 bits) to the stream.

Parameters

val	[in] Data to write.

wrInt64()

virtual void OdGsFiler::wrInt64 ( OdInt64  val )

virtual

Reads data of OdInt64 type (int 64 bits) from the stream.

Returns

read OdInt64 value.

wrIntArray()

virtual void OdGsFiler::wrIntArray ( const OdIntArray &  arr )

virtual

Writes an array of integer values to the stream.

Parameters

arr	[in] Array to write.

wrIntPtr()

virtual void OdGsFiler::wrIntPtr ( OdIntPtr  val )

virtual

Writes data of OdIntPtr type (integer that is able to store a pointer (32 or 64 depending on platform)) to the stream.

Parameters

val	[in] Data to write.

wrMatrix3d()

virtual void OdGsFiler::wrMatrix3d ( const OdGeMatrix3d &  mat )

virtual

Writes data of OdGeMatrix3d type (3-dimensional transformation matrix) to the stream.

Parameters

mat	[in] Data to write.

wrPoint2d()

virtual void OdGsFiler::wrPoint2d ( const OdGePoint2d &  pt )

virtual

Writes data of OdGePoint2d type (2-dimensional point) to the stream.

Parameters

pt	[in] Data to write.

wrPoint2dArray()

virtual void OdGsFiler::wrPoint2dArray ( const OdGePoint2dArray &  arr )

virtual

Writes an array of 2D points to the stream.

Parameters

arr	[in] Array to write.

wrPoint3d()

virtual void OdGsFiler::wrPoint3d ( const OdGePoint3d &  pt )

virtual

Writes data of OdGePoint3d type (3-dimensional point) to the stream.

Parameters

pt	[in] Data to write.

wrPoint3dArray()

virtual void OdGsFiler::wrPoint3dArray ( const OdGePoint3dArray &  arr )

virtual

Writes an array of 3D points to the stream.

Parameters

arr	[in] Array to write.

wrPtr()

void OdGsFiler::wrPtr ( const void *  pPtr )

inline

Writes data defined by the passed pointer. Internally type is cast to OdIntPtr.

Parameters

pPtr	[in] Pointer to the data to write.

Definition at line 529 of file GsFiler.h.

wrRawData()

virtual void OdGsFiler::wrRawData ( const void *  pData, OdUInt32  nDataSize  )

pure virtual

Writes raw data to the stream.

Parameters

pData	[in] Pointer to data (in bytes).
nDataSize	[in] Data size.

Implemented in OdGsFilerV100Impl.

wrSectionBegin()

virtual void OdGsFiler::wrSectionBegin ( Section  section )

pure virtual

Begins writing to the section.

Parameters

section

[in] File section.

Implemented in OdGsFilerV100Impl.

wrSectionEnd()

virtual void OdGsFiler::wrSectionEnd ( Section  section )

pure virtual

Ends writing to the section.

Parameters

section

[in] File section.

Implemented in OdGsFilerV100Impl.

wrString()

virtual void OdGsFiler::wrString ( const OdString &  str )

virtual

Writes data of OdString type (string) to the stream.

Parameters

str	[in] Data to write.

wrUInt()

virtual void OdGsFiler::wrUInt ( unsigned int  val )

virtual

Writes data of unsigned int type to the stream.

Parameters

val	[in] Data to write.

wrUInt16()

virtual void OdGsFiler::wrUInt16 ( OdUInt16  val )

virtual

Writes data of OdUInt16 type (unsigned int 16 bits) to the stream.

Parameters

val	[in] Data to write.

wrUInt16Array() [1/2]

virtual void OdGsFiler::wrUInt16Array ( const OdUInt16Array &  arr )

virtual

Writes an array of OdUInt16 values (unsigned int 16 bits) to the stream.

Parameters

arr	[in] Array to write.

wrUInt16Array() [2/2]

virtual void OdGsFiler::wrUInt16Array ( OdUInt32  count, const OdUInt16 *  arr  )

virtual

Writes an array of OdUInt16 values (unsigned int 16 bits) to the stream.

Parameters

count	[in] Count of elements in the array.
arr	[in] Array to write.

wrUInt32()

virtual void OdGsFiler::wrUInt32 ( OdUInt32  val )

virtual

Writes data of OdUInt32 type (unsigned int 32 bits) to the stream.

Parameters

val	[in] Data to write.

wrUInt32Array() [1/2]

virtual void OdGsFiler::wrUInt32Array ( const OdUInt32Array &  arr )

virtual

Writes an array of OdUInt32 values (unsigned int 32 bits) to the stream.

Parameters

arr	[in] Array to write.

wrUInt32Array() [2/2]

virtual void OdGsFiler::wrUInt32Array ( const OdUInt32Vector &  arr )

virtual

Writes a vector of OdUInt32 values (unsigned int 32 bits) to the stream.

Parameters

arr	[in] Vector to write.

wrUInt64()

virtual void OdGsFiler::wrUInt64 ( OdUInt64  val )

virtual

Writes data of OdUInt64 type (unsigned int 64 bits) to the stream.

Parameters

val	[in] Data to write.

wrUInt64Array() [1/3]

virtual void OdGsFiler::wrUInt64Array ( const OdUInt64Array &  arr )

virtual

Writes an array of OdUInt64 values (unsigned int 64 bits) to the stream.

Parameters

arr	[in] Array to write.

wrUInt64Array() [2/3]

virtual void OdGsFiler::wrUInt64Array ( const OdUInt64Vector &  vec )

virtual

Writes a vector of OdUInt64 values (unsigned int 64 bits) to the stream.

Parameters

vec	[in] Vector to write.

wrUInt64Array() [3/3]

virtual void OdGsFiler::wrUInt64Array ( OdUInt32  count, const OdUInt64 *  arr  )

virtual

Writes an array of OdUInt64 values (unsigned int 16 bits) to the stream.

Parameters

count	[in] Count of elements in the array.
arr	[in] Array to write.

wrUInt8()

virtual void OdGsFiler::wrUInt8 ( OdUInt8  val )

virtual

Writes data of OdUInt8 type (unsigned int 8 bits) to the stream.

Parameters

val	[in] Data to write.

wrUInt8Array()

virtual void OdGsFiler::wrUInt8Array ( const OdUInt8Array &  arr )

virtual

Writes an array of OdUInt8 values (unsigned int 8 bits) to the stream.

Parameters

arr	[in] Array to write.

wrVector2d()

virtual void OdGsFiler::wrVector2d ( const OdGeVector2d &  vec )

virtual

Writes data of OdGeVector2d type (2-dimensional vector) to the stream.

Parameters

vec	[in] Data to write.

wrVector3d()

virtual void OdGsFiler::wrVector3d ( const OdGeVector3d &  vec )

virtual

Writes data of OdGeVector3d type (3-dimensional vector) to the stream.

Parameters

vec	[in] Data to write.

---

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

• GsFiler.h