FxBIMDatabase.h

Go to the documentation of this file.

//
// (C) Copyright 2020-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 "FxBIM.h"
#include "FxBIMConversion.h"
#include "FxBIMEntity.h"
 
#include "FxBIMDatabaseReference.h"
 
#include <DbObject.h>
#include <DbDatabase.h>
 
#if !defined( FX_BIM_CONVERTERS ) && !defined( FXBIM_SC )
    #if TD_VERSION >= 201000
 
        class OdIfcFile;
        typedef OdSmartPtr<OdIfcFile> OdIfcFilePtr;
 
    #else
 
        namespace OdIfc
        {
            class OdIfcFile;
            typedef OdSmartPtr<OdIfcFile> OdIfcFilePtr;
        }
 
    #endif
 
    class OdIfcHostAppServices;
    typedef OdSmartPtr<OdIfcHostAppServices> OdIfcHostAppServicesPtr;
 
    class OdBmDatabase;
    typedef OdSmartPtr<OdBmDatabase> OdBmDatabasePtr;
#endif //FX_BIM_CONVERTERS
 
class CFxBIMDatabase;
typedef OdSmartPtr< CFxBIMDatabase > CFxBIMDatabasePtr;
 
class OdDbDwgFiler;
 
enum class DisciplineType;
 
class CFxBIMLevel;
typedef OdSmartPtr< CFxBIMLevel > CFxBIMLevelPtr;
 
class FXBIM_COMMON_CODE_API CFxBIMDatabase : public OdDbObject
{
public:
    [[deprecated]]
    static Error Convert( const OdString& source, CFxBIMConversion& c, bool async, CFxDocument * pDoc );
    static Error Convert( CFxBIMConversion& c );
 
public:
    ODDB_DECLARE_MEMBERS( CFxBIMDatabase );
 
    virtual ~CFxBIMDatabase();
 
    virtual const OdString& FileName() const;
    virtual fileType FileType() const;
    virtual size_t FileSize() const; //in bytes
    virtual const OdString& FileCreator() const; //author's name
 
    virtual CFxBIMDbIteratorRAPtr Entities(); //CFxBIMEntity
    virtual Error AddEntity( CFxBIMEntityPtr pEntity );
    virtual OdDbObjectId Entity( const OdString &UniqueId ) const;
 
    CFxBIMIteratorRAPtr Buildings();
    CFxBIMBuildingPtr GetBuilding( const OdString& name );
    Error AddBuilding( CFxBIMBuildingPtr pBuilding );
 
    virtual CFxBIMIteratorRAPtr Disciplines();
    virtual CFxBIMDisciplinePtr GetDiscipline( const OdString& name );
    virtual Error AddDiscipline( CFxBIMDisciplinePtr pDiscipline );
    virtual Error SetDisciplineForAll( DisciplineType type, const OdString& customName = OdString::kEmpty );
 
    virtual CFxBIMIteratorRAPtr Zones();
    virtual CFxBIMZonePtr GetZone( const OdString& name );
    virtual Error AddZone( CFxBIMZonePtr pZone );
 
    virtual CFxBIMIteratorRAPtr Spaces();
    [[deprecated( "Use version that passes floor and building as parameters" )]]
    virtual CFxBIMSpacePtr GetSpace( const OdString& name );
    CFxBIMSpacePtr GetSpace( const OdString& name, const OdString& floor, const OdString& building );
    virtual Error AddSpace( CFxBIMSpacePtr pSpace );
 
    virtual CFxBIMIteratorRAPtr Floors();
    [[deprecated( "Use version that passes building as a parameter" )]]
    virtual CFxBIMFloorPtr GetFloor( const OdString& name );
    CFxBIMFloorPtr GetFloor( const OdString& name, const OdString& building );
    virtual Error AddFloor( CFxBIMFloorPtr pFloor );
 
    CFxBIMDbIteratorRAPtr Levels();
    OdDbObjectId GetLevel( const OdString& strName );
    OdDbObjectId GetLevel( const double dHeight );
    Error AddLevel( CFxBIMLevelPtr ptrLevel );
    Error RemoveLevel( CFxBIMLevelPtr ptrLevel );
 
    virtual CFxBIMIteratorRAPtr Categories();
    virtual CFxBIMCategoryPtr GetCategory( const OdString& name );
    virtual Error AddCategory( CFxBIMCategoryPtr pCategory );
 
    virtual CFxBIMIteratorPtr Types();
 
    virtual CFxBIMDbIteratorRAPtr Models(); //CFxBIMDatabaseReference
 
#if !defined( FX_BIM_CONVERTERS ) && !defined( FXBIM_SC )
#if TD_VERSION >= 201000
    static OdIfcFilePtr GetIFC( const OdString& fileName, OdIfcHostAppServicesPtr pIfcHAS = OdIfcHostAppServicesPtr() );
#else
    static OdIfc::OdIfcFilePtr GetIFC( const OdString& fileName, OdIfcHostAppServicesPtr pIfcHAS = OdIfcHostAppServicesPtr() );
#endif                                                   
 
#if !defined (Q_OS_MAC) && !defined (Q_OS_LINUX)
    static OdBmDatabasePtr GetRVT( const OdString& fileName );
#endif
 
    // 0 - undefined schema,
    // 1 - 2x3 schema,
    // 2 - 4 schema,
    // 3 - 4x2 schema
#if TD_VERSION >= 201000
    static OdIfcFilePtr CreateIFC( int schema, OdIfcHostAppServicesPtr pIfcHAS = OdIfcHostAppServicesPtr() );
#else
    static OdIfc::OdIfcFilePtr CreateIFC( int schema, OdIfcHostAppServicesPtr pIfcHAS = OdIfcHostAppServicesPtr() );
#endif
#endif 
 
    virtual CFxBIMDbIteratorRAPtr Materials();
    virtual OdDbObjectId GetMaterial( const OdString& name ); //CFxBIMMaterial
    virtual Error AddMaterial( CFxBIMMaterialPtr pMaterial );
    virtual Error RemoveMaterial( CFxBIMMaterialPtr pMaterial );
 
public:
    OdResult dwgInFields( OdDbDwgFiler* pFiler ) override;
    void dwgOutFields( OdDbDwgFiler* pFiler ) const override;
 
    OdResult dxfInFields( OdDbDxfFiler* pFiler ) override;
    void dxfOutFields( OdDbDxfFiler* pFiler ) const override;
 
protected:
    CFxBIMDatabase();
};