daiModel.h

Go to the documentation of this file.

// Copyright (C) 2002-2019, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2019 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _DAI_MODEL_H
#define _DAI_MODEL_H
 
#include "daiSessionInstance.h"
#include "daiInstanceIterator.h"
#include "daiBaseType.h"
#include "daiSchema.h"
#include "daiEntityExtent.h"
 
#include "SharedPtr.h"
#include "SmartPtr.h"
 
#include "sdai.h"
 
class OdExpSchemaModule;
typedef OdSmartPtr<OdExpSchemaModule> SchemaModulePtr;
 
namespace OdDAI {
 
  //DOM-IGNORE-BEGIN
  class ModelContents;
  typedef OdSmartPtr<ModelContents> ModelContentsPtr;
 
  class OdSpfFilerBase;
  typedef OdSmartPtr<OdSpfFilerBase> OdSpfFilerBasePtr;
 
  class Model;
  typedef OdSmartPtr<Model> ModelPtr;  //DOM-IGNORE-END
 
  class DAI_EXPORT Model : public SessionInstance
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(Model);
    Model();
    //DOM-IGNORE-END
 
    void initialize(const OdAnsiString& schemaName);
 
    //void initialize(const OdAnsiString& schemaName, OdDAI::OdSpfFilerBasePtr& pFiler);
    void initialize(OdDAI::SchemaPtr schema);
 
    /* \details
    Retreives a name of the model.
    \returns Returns a name of the model.
    */
    OdAnsiString name() const { return m_name; };
 
    /* \details
    Retreives a repository which contains the model.
    \returns Returns a pointer to the repository which contains the model.
    */
    Repository* repository() const { return m_repository; };
 
    void RenameModel(const OdAnsiString &modelName);
 
 
    const OdDAI::Entity*     getEntityDefinition(const char *entityName) const;
 
    const OdDAI::SchemaPtr   underlyingSchema() const;
 
    const OdAnsiString&      underlyingSchemaName() const;
 
    OdDAIObjectId            getEntityInstance(const OdDbHandle &h);
 
    EntityInstancePtr  createEntityInstance(const OdDAI::EntityPtr& entityDef);
 
    EntityInstancePtr  createEntityInstance(const char *entityTypeName);
 
    OdDAIObjectId appendEntityInstance(EntityInstancePtr pInst);
 
    OdDAIObjectId insertEntityInstance(EntityInstancePtr pInstanceToInsert, const OdDbHandle& insertHandle);
 
    OdDAI::InstanceIteratorPtr  newIterator();
 
    //OdEntityExtentPtr        getEntityExtent(const char *entityName) const;
 
    OdDAIObjectIdAggr*         getEntityExtent(EntityPtr entityDef) const;
 
    OdDAIObjectIds           getEntityExtent(const char *entityName) const;
 
    SdaiAccessMode           mode() const;
 
    void                     closeModel();
 
    void                     closeModel() const;
 
    void                     PromoteModelToReadWrite() const;
 
//DOM-IGNORE-BEGIN
  protected:
 
    OdResult in(OdDAI::OdSpfFilerBasePtr& rdFiler);
 
    void out(OdDAI::OdSpfFilerBasePtr& wrFiler);
 
    void name(const OdAnsiString &name) { m_name = name; };
    void repository(Repository *repo) { m_repository = repo; };
 
    ModelContentsPtr createModelContents(const OdAnsiString &schemaName);
    OdDAI::SchemaPtr getSchemaDef(const OdAnsiString &schemaName);
    virtual void subInitialize() = 0;
 
  protected:
    OdAnsiString m_name;
    SchemaPtr m_underlyingSchema;
    SchemaModulePtr m_schemaModule;
    ModelContentsPtr m_contents;
    Repository *m_repository;
 
  private:
    friend class Repository; 
    mutable SdaiAccessMode  m_accessMode;
//DOM-IGNORE-END
  };
  
  
}
 
#endif // _DAI_MODEL_H