CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdIdFiler Class Reference

#include <DbFiler.h>

Inheritance diagram for OdIdFiler:
OdDbDwgFiler OdDbFiler OdRxObject

Public Member Functions

 OdIdFiler ()
 
void seek (OdInt64 offset, OdDb::FilerSeekType seekType)
 
OdUInt64 tell () const
 
OdResult filerStatus () const
 
void resetFilerStatus ()
 
FilerType filerType () const
 
OdDb::DwgVersion dwgVersion (OdDb::MaintReleaseVer *pMaintReleaseVer=0) const
 
bool rdBool ()
 
OdString rdString ()
 
void rdBytes (void *buffer, OdUInt32 numBytes)
 
OdInt8 rdInt8 ()
 
OdUInt8 rdUInt8 ()
 
OdInt16 rdInt16 ()
 
OdInt32 rdInt32 ()
 
OdInt64 rdInt64 ()
 
double rdDouble ()
 
OdDbHandle rdDbHandle ()
 
OdDbObjectId rdSoftOwnershipId ()
 
OdDbObjectId rdHardOwnershipId ()
 
OdDbObjectId rdHardPointerId ()
 
OdDbObjectId rdSoftPointerId ()
 
OdGePoint2d rdPoint2d ()
 
OdGePoint3d rdPoint3d ()
 
OdGeVector3d rdVector3d ()
 
OdGeVector2d rdVector2d ()
 
OdGeScale3d rdScale3d ()
 
void wrBool (bool value)
 
void wrString (const OdString &value)
 
void wrBytes (const void *buffer, OdUInt32 numBytes)
 
void wrInt8 (OdInt8 value)
 
void wrUInt8 (OdUInt8 value)
 
void wrInt16 (OdInt16 value)
 
void wrInt32 (OdInt32 value)
 
void wrInt64 (OdInt64 value)
 
void wrDouble (double value)
 
void wrDbHandle (const OdDbHandle &value)
 
void wrPoint2d (const OdGePoint2d &value)
 
void wrPoint3d (const OdGePoint3d &value)
 
void wrVector2d (const OdGeVector2d &value)
 
void wrVector3d (const OdGeVector3d &value)
 
void wrScale3d (const OdGeScale3d &value)
 
void setController (OdDbFilerController *pFilerController)
 
OdDbFilerController * controller () const
 
- Public Member Functions inherited from OdDbDwgFiler
 OdDbDwgFiler ()
 
 ODRX_DECLARE_MEMBERS (OdDbDwgFiler)
 
virtual voidrdAddress ()
 
virtual void wrAddress (const void *value)
 
virtual void wrSoftOwnershipId (const OdDbObjectId &value)=0
 
virtual void wrHardOwnershipId (const OdDbObjectId &value)=0
 
virtual void wrSoftPointerId (const OdDbObjectId &value)=0
 
virtual void wrHardPointerId (const OdDbObjectId &value)=0
 
virtual bool usesReferences () const
 
virtual void addReference (OdDbObjectId id, OdDb::ReferenceType rt)
 
- Public Member Functions inherited from OdDbFiler
 OdDbFiler ()
 
 ODRX_DECLARE_MEMBERS (OdDbFiler)
 
virtual OdDbDatabasedatabase () const
 
OdDbAuditInfogetAuditInfo () const
 
- 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
 

Additional Inherited Members

- Public Types inherited from OdDbFiler
enum  FilerType {
  kFileFiler = 0 , kCopyFiler = 1 , kUndoFiler = 2 , kBagFiler = 3 ,
  kIdXlateFiler = 4 , kPageFiler = 5 , kDeepCloneFiler = 6 , kIdFiler = 7 ,
  kPurgeFiler = 8 , kWblockCloneFiler = 9
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class is the empty implementation of a base class for classes that are used as ID Filers.

Corresponding C++ library: TD_Db

<group Other_Classes>

Definition at line 1338 of file DbFiler.h.

Constructor & Destructor Documentation

◆ OdIdFiler()

OdIdFiler::OdIdFiler ( )
inline

Definition at line 1341 of file DbFiler.h.

Member Function Documentation

◆ controller()

OdDbFilerController* OdIdFiler::controller ( ) const
inlinevirtual

Returns the FilerController with which this Filer object is associated.

Reimplemented from OdDbFiler.

Definition at line 1423 of file DbFiler.h.

◆ dwgVersion()

OdDb::DwgVersion OdIdFiler::dwgVersion ( OdDb::MaintReleaseVer pMaintReleaseVer = 0) const
virtual

Returns the version of this the file which this Filer object is associated.

Remarks
The maintenance release version is returned if and only if pMaintReleaseVer != 0.
Parameters
pMaintReleaseVer[in] Pointer to the MaintReleaseVer to receive the maintenance release version.

Reimplemented from OdDbFiler.

◆ filerStatus()

OdResult OdIdFiler::filerStatus ( ) const
virtual

Returns the current status of this Filer object.

Remarks
The default implementation of this function does nothing but throw an exception.

Reimplemented from OdDbFiler.

◆ filerType()

FilerType OdIdFiler::filerType ( ) const
virtual

Returns the type of this Filer object.

Implements OdDbFiler.

◆ rdBool()

bool OdIdFiler::rdBool ( )
virtual

Returns the bool value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdBytes()

void OdIdFiler::rdBytes ( void buffer,
OdUInt32  numBytes 
)
virtual

Returns the specified number of bytes from this Filer object.

Parameters
buffer[out] Receives the bytes.
numBytes[in] Number of bytes.

Implements OdDbDwgFiler.

◆ rdDbHandle()

OdDbHandle OdIdFiler::rdDbHandle ( )
virtual

Returns the handle value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdDouble()

double OdIdFiler::rdDouble ( )
virtual

Returns the double value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdHardOwnershipId()

OdDbObjectId OdIdFiler::rdHardOwnershipId ( )
virtual

Returns the HardOwnershipId value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdHardPointerId()

OdDbObjectId OdIdFiler::rdHardPointerId ( )
virtual

Returns the HardPointerId value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdInt16()

OdInt16 OdIdFiler::rdInt16 ( )
virtual

Returns the Int16 value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdInt32()

OdInt32 OdIdFiler::rdInt32 ( )
virtual

Returns the Int32 value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdInt64()

OdInt64 OdIdFiler::rdInt64 ( )
virtual

Returns the Int64 value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdInt8()

OdInt8 OdIdFiler::rdInt8 ( )
virtual

Returns the Int8 value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdPoint2d()

OdGePoint2d OdIdFiler::rdPoint2d ( )
virtual

Returns the 2D point value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdPoint3d()

OdGePoint3d OdIdFiler::rdPoint3d ( )
virtual

Returns the 3D point value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdScale3d()

OdGeScale3d OdIdFiler::rdScale3d ( )
virtual

Returns the scale value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdSoftOwnershipId()

OdDbObjectId OdIdFiler::rdSoftOwnershipId ( )
virtual

Returns the SoftOwnershipId value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdSoftPointerId()

OdDbObjectId OdIdFiler::rdSoftPointerId ( )
virtual

Returns the SoftPointerId value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdString()

OdString OdIdFiler::rdString ( )
virtual

Returns the string value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdUInt8()

OdUInt8 OdIdFiler::rdUInt8 ( )
virtual

Returns the UInt8 value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdVector2d()

OdGeVector2d OdIdFiler::rdVector2d ( )
virtual

Returns the 2D vector value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ rdVector3d()

OdGeVector3d OdIdFiler::rdVector3d ( )
virtual

Returns the 3D vector value of the current item of this Filer object.

Implements OdDbDwgFiler.

◆ resetFilerStatus()

void OdIdFiler::resetFilerStatus ( )
virtual

Resets the current status of this Filer object to eOk.

Remarks
The default implementation of this function does nothing but throw an exception.

Reimplemented from OdDbFiler.

◆ seek()

void OdIdFiler::seek ( OdInt64  offset,
OdDb::FilerSeekType  seekType 
)
virtual

Moves the I/O pointer to the specified location in this Filer object.

Parameters
offset[in] Number of bytes.
seekType[in] Seek type.
Remarks
seekType must be one of the following:

Value Description. OdDb::kSeekFromStart SEEK_SET Start of file. OdDb::kSeekFromCurrent SEEK_CUR Current position of I/O pointer. OdDb::kSeekFromEnd SEEK_END End of file.

Implements OdDbDwgFiler.

◆ setController()

void OdIdFiler::setController ( OdDbFilerController *  pFilerController)
inlinevirtual

Sets the FilerController with which this Filer object is associated.

Parameters
pFilerController[in] Pointer to the FilerController.

Reimplemented from OdDbFiler.

Definition at line 1421 of file DbFiler.h.

◆ tell()

OdUInt64 OdIdFiler::tell ( ) const
virtual

Returns the current I/O pointer position of this Filer object.

Implements OdDbDwgFiler.

◆ wrBool()

void OdIdFiler::wrBool ( bool  value)
virtual

Writes the specified bool value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrBytes()

void OdIdFiler::wrBytes ( const void buffer,
OdUInt32  numBytes 
)
virtual

Writes the specified number of bytes to this Filer object.

Parameters
buffer[in] array of bytes.
numBytes[in] Number of bytes.

Implements OdDbDwgFiler.

◆ wrDbHandle()

void OdIdFiler::wrDbHandle ( const OdDbHandle value)
virtual

Writes the specified handle value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrDouble()

void OdIdFiler::wrDouble ( double  value)
virtual

Writes the specified double value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrInt16()

void OdIdFiler::wrInt16 ( OdInt16  value)
virtual

Writes the specified Int16 value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrInt32()

void OdIdFiler::wrInt32 ( OdInt32  value)
virtual

Writes the specified Int32 value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrInt64()

void OdIdFiler::wrInt64 ( OdInt64  value)
virtual

Writes the specified Int64 value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrInt8()

void OdIdFiler::wrInt8 ( OdInt8  value)
virtual

Writes the specified Int8 value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrPoint2d()

void OdIdFiler::wrPoint2d ( const OdGePoint2d value)
virtual

Writes the specified 2D point value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrPoint3d()

void OdIdFiler::wrPoint3d ( const OdGePoint3d value)
virtual

Writes the specified 3D point value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrScale3d()

void OdIdFiler::wrScale3d ( const OdGeScale3d value)
virtual

Writes the specified 3D scale value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrString()

void OdIdFiler::wrString ( const OdString value)
virtual

Writes the specified string value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrUInt8()

void OdIdFiler::wrUInt8 ( OdUInt8  value)
virtual

Writes the specified UInt8 value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrVector2d()

void OdIdFiler::wrVector2d ( const OdGeVector2d value)
virtual

Writes the specified 2D vector value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.

◆ wrVector3d()

void OdIdFiler::wrVector3d ( const OdGeVector3d value)
virtual

Writes the specified 3D vector value to this Filer object.

Parameters
value[in] Value.

Implements OdDbDwgFiler.


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