daiSession.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_SESSION_H
#define _DAI_SESSION_H
 
#include "OdPlatformSettings.h"
#include "OdaCommon.h"
#include "OdArray.h"
#include "RxObject.h"
#include "RxObjectImpl.h"
#include "SharedPtr.h"
 
#include "daiBuildOptions.h"
#include "daiSessionInstance.h"
#include "daiError/daiErrorId.h"
 
namespace OdDAI {
 
#if defined(_MSC_VER)
#pragma warning(push) 
#pragma warning(disable:4150)
#endif
 
  class Repository;
  typedef OdSmartPtr<Repository> RepositoryPtr;
 
  class Model;
  typedef OdSmartPtr<Model> ModelPtr;
 
  class daiErrorEvent;
  typedef OdSharedPtr<daiErrorEvent> daiErrorEventPtr;
 
  class DAI_EXPORT Session : public SessionInstance
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(Session);
    //DOM-IGNORE-END
 
    Session();
 
    static OdSmartPtr<Session> openSession();
    void closeSession();
 
    RepositoryPtr createRepo(const OdAnsiString &name);
    RepositoryPtr createRepoFromFile(const OdAnsiString &fileName, const OdAnsiString &name = "");
    RepositoryPtr findRepo(const OdAnsiString &name);
 
    /* \delete
    Opens an unopened repository which exists in the current session. 
    */
    void openRepo(RepositoryPtr &pRepository);
 
    /* \details
    Closes an opened repository assigned with this session.
    
    */
    void closeRepo(RepositoryPtr &pRepository);
 
    const OdArray<daiErrorEventPtr>&  errors();
    void recordError(const char* functionID, daiErrorId error, const char* descpt);
    Session&  operator<< (const daiErrorEventPtr& eveentToRecord);
 
    bool isRecordingOn(); 
    void startEventRecording();
    void stopEventRecording();
    
  protected:
 
    //Implementation m_sdaiImplementation;
    bool m_recordingActive;
    OdArray<daiErrorEventPtr> m_errors;
    OdArray<RepositoryPtr> m_knownServers;
    OdArray<RepositoryPtr> m_activeServers;
    OdArray<ModelPtr> m_activeModels;
 
    friend class Repository;
    class EventHandler;
  };
  typedef OdSmartPtr<Session> SessionPtr;
 
#if defined(_MSC_VER)
#pragma warning(pop) 
#endif
 
}
 
#endif // _DAI_SESSION_H