IDocument.h

浏览该文件的文档.

/************************************************************************
* @file IDocument.h
*
* @brief 文档类
*
* @details 文档类
*
* @author dixu
*
* @version 1.0
*
* @date 2014-9-8
*
* @license 北京华科软科技有限公司
*
*************************************************************************/
 
#ifndef BIMHOMEAPP_APP_IDOCUMENT_H
#define BIMHOMEAPP_APP_IDOCUMENT_H
 
#include "BHGlobal.h"
#include <iostream>
#include <string>
#include <vector>
#include <set>
#include <map>
#include "boost/any.hpp"
#include "IDocumentType.h"
#include "Base/Placement.h"
 
namespace App
{
    class IDocumentObject;
    class AppDocObserverDelegate;
    class IPropertyAccessor;
 
    class AppExport IDocument
    {
    public:
        static IDocument* create(
            const char* pName,
            IDocument *pProduct = nullptr,
            const char* pUserName = nullptr,
            bool createView = true,
            bool tempDoc = false,
            DocType type = DocType::Component);
 
        static IDocument* create(
            const char* pName,
            IDocument* pProduct = nullptr,
            const char* pAppDocDelegateName = nullptr,
            const char* pUserName = nullptr,
            DocType type = DocType::Component,
            bool createView = true,
            bool tempDoc = false);
        
        static IDocument* loadFile(
            const char* pPath,
            IDocument* pProduct = nullptr,
            const char* pAppDocDelegateName = nullptr,
            DocType type = DocType::Component,
            bool createView = true,
            bool tempDoc = false);
 
        virtual ~IDocument();
 
        virtual const char* getFileName() const = 0;
 
        virtual const char* getName() const = 0;
 
 
        virtual const char* getProgramVersion() const = 0;
 
        virtual App::IDocument* getParentDocument() = 0;
 
        virtual App::IDocument* getParentDocumentByType(const std::string& parentClassTypeId) = 0;
 
        virtual App::IDocument* getRootDocument() = 0;
 
        virtual void getSubDocument(std::set<App::IDocument*>& docSet) = 0;
 
        virtual void getAllDocument(std::set<App::IDocument*>& docSet) = 0;
 
        virtual App::IDocument* getDocumentById(std::string uuid) = 0;
 
        virtual App::IDocument* getDocumentByName(std::string name) = 0;
 
        virtual std::string getTemplateDirName(const std::string& uuid) = 0;
 
        virtual std::string getTransientDirectoryName(const std::string& uuid, const std::string& filename) const = 0;
 
        virtual std::vector<std::string> getAvailableRedoNames() const = 0;
 
        virtual int getAvailableRedos(int id = 0) const = 0;
 
        virtual int getAvailableUndos(int id = 0) const = 0;
 
        virtual int getRefCount() = 0;
 
        virtual int getTransactionID(bool undo, unsigned pos = 0) const = 0;
 
        virtual void setDocumentLabel(const std::string& labelName) = 0;
 
        virtual void setDocumentName(const char* name) = 0;
 
        virtual void setUndoMode(int iMode) = 0;
 
        virtual const char* getErrorDescription(const App::IDocumentObject* pIObject) const = 0;
 
        virtual bool hasPendingTransaction() const = 0;
 
        virtual bool isClosable() const = 0;
 
        virtual bool isPerformingTransaction() const = 0;
 
        virtual bool isSaved() const = 0;
 
        virtual bool isTransactionEmpty() const = 0;
 
        virtual bool afterRestore(bool checkPartial = false) = 0;
 
        virtual void exportGraphviz(std::ostream& os) const = 0;
 
        virtual void purgeTouched() = 0;
 
        virtual void deleteSubPartOrProduct(App::IDocument* pDocument) = 0;
 
        virtual void abortTransaction() = 0;
 
        virtual void commitTransaction() = 0;
 
        virtual void openTransaction(const char* name = nullptr) = 0;
 
        virtual void topologicalSort(std::vector<App::IDocumentObject*>& docVec) const = 0;
 
        virtual bool afterRestore(const std::vector<App::IDocumentObject*>& docVec, bool checkPartial = false) = 0;
 
        virtual IDocumentObject* moveObject(IDocumentObject* obj, bool recursive = false) = 0;
 
        virtual std::vector<App::IDocumentObject*> importLinks(const std::vector<App::IDocumentObject*>& objs = {}) = 0;
 
        virtual void getLinksTo(std::set<IDocumentObject*>& links, const IDocumentObject* obj, int options, int maxCount = 0, const std::vector<IDocumentObject*>& objs = {}) const = 0;
 
        virtual void getRootObjects(std::vector<App::IDocumentObject*>& iObjVec) const = 0;
 
        virtual void setRootIDocument(App::IDocument* doc) = 0;
 
        virtual void getDocumentType(DocType& type) = 0;
 
        virtual void getDependentDocuments(std::vector<App::IDocument*>&, bool sort = true) = 0;
 
        virtual IDocumentObject* getObjectById(long id, bool findInLinkedPart = false) const = 0;
 
        virtual IDocumentObject* getObject(const char* Name, bool findInLinkedPart = false) const = 0;
 
        virtual void exportObjects(const std::vector<App::IDocumentObject*>& iObjVec, std::ostream& os) = 0;
 
        virtual void addObject(IDocumentObject* pIObj, const char* pObjectName = nullptr) = 0;
 
        virtual App::IDocumentObject* addObject(const char* sType, const char* pObjectName = nullptr,
            bool isNew = true, const char* viewType = nullptr, bool isPartial = false, long id = 0,
            void* pDocObjDelegate = nullptr, void* pViewProviderDelegate = nullptr) = 0;
 
        virtual void _removeObject(IDocumentObject* pcObject) = 0;
 
        virtual void removeObject(const char* sName) = 0;
 
        virtual void removeAllObjects() = 0;
 
 
        virtual Base::Placement getPlacement() const = 0;
 
        virtual void setPlacement(Base::Placement placement) = 0;
 
        virtual Base::Placement getLocalPlacement() const = 0;
 
        virtual void setLocalPlacement(Base::Placement placement) = 0;
 
        virtual std::string getId() = 0;
 
        virtual  void setId(std::string id) = 0;
 
        virtual  void setFileName(std::string filename) = 0;
 
        virtual void locateObjs() = 0;
 
        virtual void removeChildDocument(IDocument* pChildDoc) = 0;
 
        virtual App::IDocument* addChildDocument(std::string name, DocType type, std::string path, std::string id, std::string afterId, bool usePartLink = true, bool doFinishRestore = true, void* pAppDocDelegate = nullptr, void* pGuiDocDelegate = nullptr) = 0;
 
        virtual  void setDocCategory(std::string category) = 0;
 
        virtual  std::string getDocCategory() = 0;
        virtual void getDocumentByDocCategory(std::vector<App::IDocument*>& iDocVec, std::string category) = 0;
 
        virtual std::string getUniqueObjectName(const char* Name) const = 0;
 
        virtual std::vector<IDocument*> getPartMaps() = 0;
 
        virtual void getDocumentObjects(std::vector<IDocumentObject*>& iObjVec) const = 0;
 
        virtual void getDocumentObjectsHasName(std::vector<App::IDocumentObject*>& iObjVec, const std::string& name) const = 0;
 
        virtual void importFile(const char* partFileName, bool dofinishRestore = true) = 0;
 
        virtual void setActiveIDocument(App::IDocument* pObj);
 
        virtual void deleteIDocument(App::IDocument* doc);
 
        virtual void paramterNewObject(const std::map<std::string, boost::any>& data);
 
        virtual std::string getDocumentId() = 0;
 
        virtual IPropertyAccessor* getPropertyAccessor() = 0;
 
        virtual bool save(bool saveSub = true) = 0;
 
        virtual bool saveAs(const char* file, bool saveSub = true) = 0;
 
        virtual void setObserverDelegate(AppDocObserverDelegate* pObsDelegate) = 0;
 
        virtual const AppDocObserverDelegate* getObserverDelegate() = 0;
 
        virtual int recomputeDocument(const std::vector<App::IDocumentObject*>& objs = {},
            bool force = false, bool* hasError = nullptr, int options = 0) = 0;
 
    };
}
 
#endif // BIMHOMEAPP_APP_ANNOTATION_H