FxDatabase.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxPragmaPush.h"
 
#include "DDKERNEL.h"
 
#include <OdCodePage.h>
#include <DbDatabase.h>
#include <DbSecurity.h>
 
#include <set>
 
class CFxFileData;
class CFxGsModel;
class CFxRecentlyErased;
class CFxUnitsFormatter;
class CFxDatabaseHistory;
class CFxString;
class CFxView;
 
class CFxDatabase;
typedef OdSmartPtr<CFxDatabase> CFxDatabasePtr;
 
#define LAST_DWGDIRECT_UNDO_ID 0x1000 //this value is much bigger than last DWGDirect undo value

class DDKERNEL_API CFxDatabase : public OdDbDatabase
{
public:
    ODRX_DECLARE_MEMBERS(CFxDatabase);
 
    CFxDatabase(void);
    ~CFxDatabase(void) override;

    static CFxDatabasePtr LoadFile( const CFxString& strFilename, OdCodePageId* pCodepage = 0, const OdPassword& password = OdPassword() );

    virtual bool SaveFile( const CFxFileData* pNewData = 0, bool deleteBackupFile = true ) = 0;

    static CFxDatabasePtr RecoverFile( const CFxString& strFilename, OdCodePageId* pCodepage = 0, const OdPassword& password = OdPassword() );

    virtual void LockFile( bool bLock ) = 0;

    OdDbObjectId GetActiveViewportId( OdDbObjectId idLayout = OdDbObjectId::kNull ) const;

    bool IsModelLayoutActive() const;

    OdDbObjectId GetActiveBlockId() const;

    virtual const CFxUnitsFormatter* GetUnitsFormatter() const = 0;

    virtual const CFxFileData& GetFileData() const = 0;

    virtual void SetFileData(const CFxFileData &) const = 0;

    virtual CFxGsModel* GetFxGsModel() = 0;
    virtual const CFxGsModel* GetFxGsModel() const = 0;
    virtual CFxRecentlyErased* GetRecentlyErased() = 0;
    virtual void StartUndoRecord( const CFxString& strLabel ) = 0;

    virtual void ResetTime() = 0;

    virtual CFxDatabaseHistory* GetDatabaseHistory() = 0;

    virtual int BlockPurge( OdDbObjectId id, bool block ) = 0;

    virtual const std::set<OdDbObjectId>& GetBlockedPurge() const = 0;

    virtual const OdTimeStamp& getElapsedTime() = 0;
    
    virtual const OdError& GetLastError() const = 0;

    virtual void ClearError() = 0;
 
    //overrides of system variables
    OdCodePageId getDWGCODEPAGE() const override;
    OdGePoint2d getPLIMMIN() const  override = 0;
    OdGePoint2d getPLIMMAX() const override = 0;
 
    //newly added functions
    virtual bool setDWGCODEPAGE( OdCodePageId value ) = 0;
    virtual bool setTDUCREATE( OdDbDate value ) = 0;
    virtual bool setTDUUPDATE( OdDbDate value ) = 0;
    virtual bool setTDINDWG( OdDbDate value ) = 0;
    virtual bool setTDUSRTIMER( OdDbDate value ) = 0;
    virtual bool setPSTYLEMODE( bool value ) = 0;
    virtual bool setPUCSORG( OdGePoint3d value ) = 0;
    virtual bool setPUCSXDIR( OdGeVector3d value ) = 0;
    virtual bool setPUCSYDIR( OdGeVector3d value ) = 0;
    virtual bool setUCSORG( OdGePoint3d value ) = 0;
    virtual bool setUCSXDIR( OdGeVector3d value ) = 0;
    virtual bool setUCSYDIR( OdGeVector3d value ) = 0;
    virtual bool setPUCSAll( OdGePoint3d org, OdGeVector3d xDir, OdGeVector3d yDir ) = 0;
    virtual bool setUCSAll( OdGePoint3d org, OdGeVector3d xDir, OdGeVector3d yDir ) = 0;
 
    virtual OdString getUSERS1() const = 0;
    virtual bool setUSERS1( const OdString& value ) = 0;
    virtual OdString getUSERS2() const = 0;
    virtual bool setUSERS2( const OdString& value ) = 0;
    virtual OdString getUSERS3() const = 0;
    virtual bool setUSERS3( const OdString& value ) = 0;
    virtual OdString getUSERS4() const = 0;
    virtual bool setUSERS4( const OdString& value ) = 0;
    virtual OdString getUSERS5() const = 0;
    virtual bool setUSERS5( const OdString& value ) = 0;
    virtual OdInt16 getBINDTYPE() const = 0;
    virtual bool setBINDTYPE( OdInt16 value ) = 0;

#define QVAR_DEF_RO( type, name, validator ) \
    virtual type get##name() const = 0; \
    virtual bool set##name( type val ) = 0;
 
#define QVAR_DEF( type, name, validator ) \
    QVAR_DEF_RO( type, name, validator )
 
#define QVAR_DEF_RO_2( type, name, validator )
#define QVAR_DEF_2( type, name, validator )
 
#define FX_VAR_DEF_RO( type, name, def_val, metric_def_value, filerType, rbType, validation ) \
    QVAR_DEF_RO( type, name, validation )
 
#define FX_VAR_DEF( type, name, def_val, metric_def_value, filerType, rbType, validation ) \
    QVAR_DEF_RO( type, name, validation )
 
#define ODTUCSNAME OdDbHardPointerId
 
    #include <QuasiVarDefs.h>
    #include "fxdbvardefs.h"
 
#undef ODTUCSNAME
 
#undef QVAR_DEF_RO
#undef QVAR_DEF
#undef QVAR_DEF_RO_2
#undef QVAR_DEF_2
 
#undef FX_VAR_DEF_RO
#undef FX_VAR_DEF
 
    enum FxPartialUndoID
    {
        kPU_COMMANDNAME = LAST_DWGDIRECT_UNDO_ID + 1,
 
        //constant definitions
        #define FX_VAR_DEF(type, name, def_val, metric_def_value, filerType, rbType, validate)      kPU_Db##name,
        #define FX_VAR_DEF_RO(type, name, def_val, metric_def_value, filerType, rbType, validate)   kPU_Db##name,
        #define FX_REGVAR_DEF( type, name, def_val, filerType, rbType, validation )                 kPU_Db##name,
        #define FX_REGVAR_DEF_RO( type, name, def_val, filerType, rbType, validation )              kPU_Db##name,
        #define QVAR_DEF( type, name, validation )                                                  kPU_Db##name,
        #define QVAR_DEF_RO( type, name, validation )                                               kPU_Db##name,
 
            #include "fxdbvardefs.h"
            #include "FxSysVarDefs.h"
            #include <QuasiVarDefs.h>
 
        #undef FX_VAR_DEF
        #undef FX_VAR_DEF_RO
        #undef FX_REGVAR_DEF
        #undef FX_REGVAR_DEF_RO
        #undef QVAR_DEF
        #undef QVAR_DEF_RO
 
        #define REGVAR_DEF( type, name, def_val, filerType, validation ) kPU_Db##name,
            #include <SysVarDefs.h>
        #undef REGVAR_DEF
 
        kPU_DbDWGCODEPAGE,
        kPU_DbTDUCREATE,
        kPU_DbTDUUPDATE,
        kPU_DbTDINDWG,
        kPU_DbTDUSRTIMER,
        kPU_DbPSTYLEMODE,
        kPU_DbPUCSORG,
        kPU_DbPUCSXDIR,
        kPU_DbPUCSYDIR,
        kPU_DbREFEDIT,
        kPU_DbREFSET,
        kPU_DbREFBASEPT,
        kPU_DbHIDEOBJ,
        kPU_DbBEDIT,
        kPU_DbUCSALL,
        kPU_DbPUCSALL,
 
        kPU_DbDummy
    };
 
    //UNDOCTL modes
    enum UNDOCTL_Modes
    {
        Enabled = 0x1,
        One = 0x2,
        Auto = 0x4,
        Combine = 0x10,
        Layer = 0x20
    };

    virtual CFxView* GetGsView( OdDbObjectId id ) const = 0;
 
private:
    //don't call this function
    //use SaveFile
    void writeFile(
        OdStreamBuf* pStreamBuf,
        OdDb::SaveType fileType,
        OdDb::DwgVersion fileVersion,
        bool saveThumbnailImage = false,
        int dxfPrecision = 16);
 
};
 
#include "FxPragmaPop.h"