SALOMEDS_Study_i.hxx

Go to the documentation of this file.

// Copyright (C) 2007-2025  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
//  File   : SALOMEDS_Study_i.hxx
//  Author : Sergey RUIN
//  Module : SALOME
//
#pragma once
 
// std C++ headers
#include <iostream>
 
// IDL headers
#include <SALOMEconfig.h>
#include CORBA_SERVER_HEADER(SALOME_GenericObj)
#include CORBA_SERVER_HEADER(SALOMEDS)
#include CORBA_CLIENT_HEADER(SALOME_Session)
#include <stdio.h>
 
//SALOMEDS headers
#include "SALOMEDS_SComponentIterator_i.hxx"
#include "SALOMEDS_StudyBuilder_i.hxx"
#include "SALOMEDS_SObject_i.hxx"
#include "SALOMEDS_UseCaseBuilder_i.hxx"
#include "SALOMEDS_Driver_i.hxx"
 
#include "SALOMEDSImpl_Study.hxx"
#include "SALOMEDSImpl_AttributeIOR.hxx"
 
class SALOME_NamingService_Abstract;
 
namespace KERNEL
{
  Standard_EXPORT SALOMEDS::Study_ptr getStudyServantSA();
  Standard_EXPORT SALOMEDS::Study_var retrieveNewStudyServantSA();
  Standard_EXPORT void killStudyServantSA();
  Standard_EXPORT void setStudyServantSA(SALOMEDS::Study_var study);
  Standard_EXPORT void setStudyServantSA(SALOMEDS::Study_var study, PortableServer::POA_var poa);
}
 
class Standard_EXPORT SALOMEDS_Study_i: public POA_SALOMEDS::Study
{
private:
 
  void                            NameChanged(SALOME::Session_ptr session);
  CORBA::ORB_var                 _orb;
  SALOMEDSImpl_Study*            _impl;  
  SALOMEDS_StudyBuilder_i*       _builder;    
  SALOMEDSImpl_AbstractCallback* _notifier;
  SALOMEDSImpl_AbstractCallback* _genObjRegister;
  SALOMEDS_DriverFactory_i*      _factory;
  bool                           _closed;
  SALOME_NamingService_Abstract *_ns = nullptr;
 
public:
  SALOMEDS_Study_i(CORBA::ORB_ptr, SALOME_NamingService_Abstract * = nullptr);
  SALOMEDS_Study_i(CORBA::ORB_ptr, SALOME::Session_ptr session);
  
 
  virtual ~SALOMEDS_Study_i();
 
  virtual PortableServer::POA_ptr _default_POA();
 
  virtual void Init() override;
  virtual void Init(SALOME::Session_ptr session);
  virtual void Clear();
 
 
  virtual bool Open(const wchar_t* aStudyUrl);
 
 
  virtual bool CanOpen(const wchar_t* aStudyUrl);
 
  virtual CORBA::Boolean Save(CORBA::Boolean theMultiFile, CORBA::Boolean theASCII);
 
 
  virtual CORBA::Boolean SaveAs(const wchar_t* aUrl, CORBA::Boolean theMultiFile, CORBA::Boolean theASCII);
 
 
  virtual CORBA::Boolean Copy(SALOMEDS::SObject_ptr theObject);
  virtual CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
 
  virtual SALOMEDS::SObject_ptr Paste(SALOMEDS::SObject_ptr theObject);
  virtual CORBA::Boolean CanPaste(SALOMEDS::SObject_ptr theObject);
 
 
  virtual char* GetPersistentReference();
 
 
  virtual CORBA::Boolean IsEmpty();
 
 
  virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
 
 
  virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
 
 
  virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
 
 
 
  virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName );
  
 
  virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
 
 
  virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
 
 
  virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
 
 
  virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
 
 
  virtual char* GetObjectPath(CORBA::Object_ptr theObject);
 
 
  virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
 
 
  virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
 
  SALOMEDS_SComponentIterator_i *NewComponentIteratorImpl();
 
 
  virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
 
 
  virtual wchar_t* Name();
 
 
  virtual void Name(const wchar_t* name);
 
 
  virtual CORBA::Boolean IsSaved();
 
 
  virtual void  IsSaved(CORBA::Boolean save);
 
 
  virtual CORBA::Boolean IsModified();
 
  virtual void Modified();
 
 
  virtual wchar_t* URL();
 
 
  virtual void URL(const wchar_t* url);
 
  static void IORUpdated(SALOMEDSImpl_AttributeIOR* theAttribute);
 
  virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
  
  virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
 
  virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties();
 
  virtual char* GetLastModificationDate();
 
  virtual SALOMEDS::ListOfDates* GetModificationsDate();
 
  virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
  virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
 
  virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
 
  void EnableUseCaseAutoFilling(CORBA::Boolean isEnabled); 
 
  // postponed destroying of CORBA object functionality
  virtual void AddPostponed(const char* theIOR);
 
  virtual void AddCreatedPostponed(const char* theIOR);
 
  virtual void RemovePostponed(CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
                                                          // if theUndoLimit==0, removes all
  virtual void UndoPostponed(CORBA::Long theWay); // theWay = 1: resurrect objects,
                                                  // theWay = -1: get back to the list of postponed
 
  virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters(const char* theID, CORBA::Long theSavePoint);
  virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters(const char* theID, 
                                                               const char* theModuleName, 
                                                               CORBA::Long theSavePoint);
 
  virtual void SetStudyLock(const char* theLockerID);
 
  virtual bool IsStudyLocked();
 
  virtual void UnLockStudy(const char* theLockerID);
 
  virtual SALOMEDS::ListOfStrings* GetLockerID();
 
  virtual void SetReal(const char* theVarName, CORBA::Double theValue);
  
  virtual void SetInteger(const char* theVarName, CORBA::Long theValue);
 
  virtual void SetBoolean(const char* theVarName, CORBA::Boolean theValue);
 
  virtual void SetString(const char* theVarName, const char* theValue);
 
  virtual void SetStringAsDouble(const char* theVarName, CORBA::Double theValue);
 
  virtual CORBA::Double GetReal(const char* theVarName);
  
  virtual CORBA::Long GetInteger(const char* theVarName);
 
  virtual CORBA::Boolean GetBoolean(const char* theVarName);
 
  virtual char* GetString(const char* theVarName);
 
  virtual CORBA::Boolean IsReal(const char* theVarName);
  
  virtual CORBA::Boolean IsInteger(const char* theVarName);
 
  virtual CORBA::Boolean IsBoolean(const char* theVarName);
 
  virtual CORBA::Boolean IsString(const char* theVarName);
 
  virtual CORBA::Boolean IsVariable(const char* theVarName);
 
  virtual SALOMEDS::ListOfStrings* GetVariableNames();
 
  virtual CORBA::Boolean RemoveVariable(const char* theVarName);
 
  virtual CORBA::Boolean RenameVariable(const char* theVarName, const char* theNewVarName);
 
  virtual CORBA::Boolean IsVariableUsed(const char* theVarName);
  
  virtual SALOMEDS::ListOfListOfStrings* ParseVariables(const char* theVars);
 
  virtual char* GetDefaultScript(const char* theModuleName, const char* theShift);
 
  virtual CORBA::Boolean DumpStudy(const char* thePath,
                                   const char* theBaseName,
                                   CORBA::Boolean isPublished,
                                   CORBA::Boolean isMultiFile);
 
  virtual char* GetDumpPath();
 
  virtual SALOMEDSImpl_Study* GetImpl() { return _impl; }
 
  virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
 
  static void SetThePOA(PortableServer::POA_ptr);
  static PortableServer::POA_ptr GetThePOA();
 
  void ping(){};
  CORBA::Long getPID();
  void ShutdownWithExit();
 
  void Shutdown();
 
  virtual void attach(SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify);
  virtual void detach(SALOMEDS::Observer_ptr theObs);
};