CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | List of all members
OdDbFiler Class Referenceabstract

#include <DbFiler.h>

Inheritance diagram for OdDbFiler:
OdRxObject OdDbDwgFiler OdDbDxfFiler OdDbDeepCloneFiler OdIdFiler OdTfDwgFiler CFxBagFiler OdDbWblockCloneFiler

Public Types

enum  FilerType {
  kFileFiler = 0, kCopyFiler = 1, kUndoFiler = 2, kBagFiler = 3,
  kIdXlateFiler = 4, kPageFiler = 5, kDeepCloneFiler = 6, kIdFiler = 7,
  kPurgeFiler = 8, kWblockCloneFiler = 9
}
 

Public Member Functions

 OdDbFiler ()
 
 ODRX_DECLARE_MEMBERS (OdDbFiler)
 
virtual OdResult filerStatus () const
 
virtual void resetFilerStatus ()
 
virtual FilerType filerType () const =0
 
virtual OdDbDatabasedatabase () const
 
virtual OdDb::DwgVersion dwgVersion (OdDb::MaintReleaseVer *pMaintReleaseVer=0) const
 
OdDbAuditInfogetAuditInfo () const
 
virtual void setController (OdDbFilerController *pFilerController)
 
virtual OdDbFilerController * controller () 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

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class is the abstract base class for classes that are used for file I/O operations utilizing the .dwg and .dxf file formats.

Corresponding C++ library: TD_Db

<group OdDb_Classes>

Definition at line 56 of file DbFiler.h.

Member Enumeration Documentation

◆ FilerType

Enumerator
kFileFiler 
kCopyFiler 
kUndoFiler 
kBagFiler 
kIdXlateFiler 
kPageFiler 
kDeepCloneFiler 
kIdFiler 
kPurgeFiler 
kWblockCloneFiler 

Definition at line 80 of file DbFiler.h.

Constructor & Destructor Documentation

◆ OdDbFiler()

OdDbFiler::OdDbFiler ( )
inline

Definition at line 59 of file DbFiler.h.

Member Function Documentation

◆ controller()

virtual OdDbFilerController* OdDbFiler::controller ( ) const
virtual

Returns the FilerController with which this Filer object is associated.

Reimplemented in OdIdFiler.

◆ database()

virtual OdDbDatabase* OdDbFiler::database ( ) const
virtual

Returns the database with which this Filer object is associated.

Reimplemented in OdTfDwgFiler.

◆ dwgVersion()

virtual OdDb::DwgVersion OdDbFiler::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 in OdIdFiler.

◆ filerStatus()

virtual OdResult OdDbFiler::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 in OdIdFiler.

◆ filerType()

virtual FilerType OdDbFiler::filerType ( ) const
pure virtual

Returns the type of this Filer object.

Implemented in OdTfDwgFiler, and OdIdFiler.

◆ getAuditInfo()

OdDbAuditInfo* OdDbFiler::getAuditInfo ( ) const

Returns the AuditInfo with which this Filer object is associated.

◆ ODRX_DECLARE_MEMBERS()

OdDbFiler::ODRX_DECLARE_MEMBERS ( OdDbFiler  )

◆ resetFilerStatus()

virtual void OdDbFiler::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 in OdIdFiler.

◆ setController()

virtual void OdDbFiler::setController ( OdDbFilerController *  pFilerController)
virtual

Sets the FilerController with which this Filer object is associated.

Parameters
pFilerController[in] Pointer to the FilerController.

Reimplemented in OdIdFiler.


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