src/SALOMEDS/SALOMEDS_Study_i.hxx

   1 // Copyright (C) 2007-2019  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : SALOMEDS_Study_i.hxx
  24 //  Author : Sergey RUIN
  25 //  Module : SALOME
  26 //
  27 #ifndef __SALOMEDS_STUDY_I_H__
  28 #define __SALOMEDS_STUDY_I_H__
  29
  30 // std C++ headers
  31 #include <iostream>
  32
  33 // IDL headers
  34 #include <SALOMEconfig.h>
  35 #include CORBA_SERVER_HEADER(SALOME_GenericObj)
  36 #include CORBA_SERVER_HEADER(SALOMEDS)
  37
  38 #include <stdio.h>
  39
  40 //SALOMEDS headers
  41 #include "SALOMEDS_SComponentIterator_i.hxx"
  42 #include "SALOMEDS_StudyBuilder_i.hxx"
  43 #include "SALOMEDS_SObject_i.hxx"
  44 #include "SALOMEDS_UseCaseBuilder_i.hxx"
  45 #include "SALOMEDS_Driver_i.hxx"
  46
  47 #include "SALOMEDSImpl_Study.hxx"
  48 #include "SALOMEDSImpl_AttributeIOR.hxx"
  49
  50 class Standard_EXPORT SALOMEDS_Study_i: public POA_SALOMEDS::Study
  51 {
  52 private:
  53
  54   void                            NameChanged();
  55   CORBA::ORB_var                 _orb;
  56   SALOMEDSImpl_Study*            _impl;
  57   SALOMEDS_StudyBuilder_i*       _builder;
  58   SALOMEDSImpl_AbstractCallback* _notifier;
  59   SALOMEDSImpl_AbstractCallback* _genObjRegister;
  60   SALOMEDS_DriverFactory_i*      _factory;
  61   bool                           _closed;
  62
  63 public:
  64
  65   //! standard constructor
  66   SALOMEDS_Study_i(CORBA::ORB_ptr);
  67
  68   //! standard destructor
  69
  70   virtual ~SALOMEDS_Study_i();
  71
  72   virtual PortableServer::POA_ptr _default_POA();
  73
  74   virtual void Init();
  75   virtual void Clear();
  76
  77   //! method to Open a Study
  78   /*!
  79     \param char* arguments, the study URL
  80     \return Study_ptr arguments
  81   */
  82   virtual bool Open(const wchar_t* aStudyUrl) throw (SALOME::SALOME_Exception);
  83
  84   //! method to save a Study
  85   virtual CORBA::Boolean Save(CORBA::Boolean theMultiFile, CORBA::Boolean theASCII);
  86
  87   //! method to save a Study to the persistent reference aUrl
  88   /*!
  89     \param char* arguments, the new URL of the study
  90   */
  91   virtual CORBA::Boolean SaveAs(const wchar_t* aUrl, CORBA::Boolean theMultiFile, CORBA::Boolean theASCII);
  92
  93   //! method to copy the object
  94   /*!
  95     \param theObject object to copy
  96   */
  97   virtual CORBA::Boolean Copy(SALOMEDS::SObject_ptr theObject);
  98   virtual CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
  99   //! method to paste the object in study
 100   /*!
 101     \param theObject object to paste
 102   */
 103   virtual SALOMEDS::SObject_ptr Paste(SALOMEDS::SObject_ptr theObject) throw(SALOMEDS::StudyBuilder::LockProtection);
 104   virtual CORBA::Boolean CanPaste(SALOMEDS::SObject_ptr theObject);
 105
 106   //! method to Get persistent reference of study (idem URL())
 107   /*!
 108     \sa URL()
 109     \return char* arguments, the persistent reference of the study
 110   */
 111   virtual char* GetPersistentReference();
 112
 113   //! method to detect if a study is empty
 114   /*!
 115     \return bool arguments, true if study is empty
 116   */
 117   virtual CORBA::Boolean IsEmpty();
 118
 119   //! method to Find a Component with ComponentDataType = aComponentName
 120   /*!
 121     \param aComponentName char* arguments
 122     \return SComponent_ptr arguments, the component found
 123   */
 124   virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
 125
 126   //! method to Find a Component Find a Component from it's ID
 127   /*!
 128     \param aComponentID char* arguments
 129     \return SComponent_ptr arguments, the component found
 130   */
 131   virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
 132
 133   //! method to  Find an Object with SALOMEDS::Name = anObjectName
 134   /*!
 135     \param anObjectName char* arguments
 136     \return SObject_ptr arguments, the object found
 137   */
 138   virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
 139
 140
 141   //! method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName
 142   /*!
 143     \param anObjectName char* arguments
 144     \param aComponentName char* arguments
 145     \return ListOfSObject_ptr arguments, a list of objects found
 146   */
 147
 148   virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName ) ;
 149
 150   //! method to Find an Object with ID = anObjectID
 151   /*!
 152     \param anObjectID char* arguments
 153     \return SObject_ptr arguments, the object found
 154   */
 155   virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
 156
 157   //! method to Create an Object with ID = anObjectID
 158   /*!
 159     \param anObjectID char* arguments
 160     \return SObject_ptr arguments, the object found
 161   */
 162   virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
 163
 164   //! method to Find an Object with ID = anObjectIOR
 165   /*!
 166     \param anObjectIOR char* arguments
 167     \return SObject_ptr arguments, the object found
 168   */
 169   virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
 170
 171   //! method to Find an Object by its path
 172   /*!
 173     \param thePath char* arguments
 174     \return SObject_ptr arguments, the object found
 175   */
 176   virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
 177
 178   //! method to get a path of SObject
 179   /*!
 180     \param aSO  SObject_ptr arguments
 181     \return char* arguments, the path of the SObject
 182   */
 183   virtual char* GetObjectPath(CORBA::Object_ptr theObject);
 184
 185   //! method to Create a ChildIterator from an SObject
 186   /*!
 187     \param aSO  SObject_ptr arguments
 188     \return ChildIterator_ptr arguments, the created ChildIterator
 189   */
 190   virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
 191
 192   //! method to Create a SComponentIterator
 193   /*!
 194     \return SComponentIterator_ptr arguments, the created SComponentIterator
 195   */
 196   virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
 197
 198   //! method to Create a StudyBuilder
 199   /*!
 200     \return StudyBuilder_ptr arguments, the created StudyBuilder
 201   */
 202   virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
 203
 204   //! method to get study name
 205   /*!
 206     \return char* arguments, the study name
 207   */
 208   virtual wchar_t* Name();
 209
 210   //! method to set study name
 211   /*!
 212     \param name char* arguments, the study name
 213   */
 214   virtual void Name(const wchar_t* name);
 215
 216   //! method to get if study has been saved
 217   /*!
 218     \return bool arguments
 219   */
 220   virtual CORBA::Boolean IsSaved();
 221
 222  //! method to set if study has been saved
 223   /*!
 224     \param save bool arguments
 225   */
 226   virtual void  IsSaved(CORBA::Boolean save);
 227
 228  //! method to Detect if a Study has been modified since it has been saved
 229   /*!
 230     \return bool arguments
 231   */
 232   virtual CORBA::Boolean IsModified();
 233
 234  //! method to set Modified flag of a Study to True
 235   virtual void Modified();
 236
 237   //! method to get URL of the study (idem GetPersistentReference)
 238   /*!
 239     \return char* arguments, the study URL
 240   */
 241   virtual wchar_t* URL();
 242
 243  //! method to set URL of the study
 244   /*!
 245     \param url char* arguments, the study URL
 246   */
 247   virtual void URL(const wchar_t* url);
 248
 249   static void IORUpdated(SALOMEDSImpl_AttributeIOR* theAttribute);
 250
 251   virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
 252
 253   virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
 254
 255   virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties();
 256
 257   virtual char* GetLastModificationDate();
 258
 259   virtual SALOMEDS::ListOfDates* GetModificationsDate();
 260
 261   virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
 262   virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
 263
 264   virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
 265
 266   void EnableUseCaseAutoFilling(CORBA::Boolean isEnabled);
 267
 268   // postponed destroying of CORBA object functionality
 269   virtual void AddPostponed(const char* theIOR);
 270
 271   virtual void AddCreatedPostponed(const char* theIOR);
 272
 273   virtual void RemovePostponed(CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
 274                                                         // if theUndoLimit==0, removes all
 275   virtual void UndoPostponed(CORBA::Long theWay); // theWay = 1: resurrect objects,
 276                                                 // theWay = -1: get back to the list of postponed
 277
 278   virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters(const char* theID, CORBA::Long theSavePoint);
 279   virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters(const char* theID,
 280                                                                const char* theModuleName,
 281                                                                CORBA::Long theSavePoint);
 282
 283   virtual void SetStudyLock(const char* theLockerID);
 284
 285   virtual bool IsStudyLocked();
 286
 287   virtual void UnLockStudy(const char* theLockerID);
 288
 289   virtual SALOMEDS::ListOfStrings* GetLockerID();
 290
 291   virtual void SetReal(const char* theVarName, CORBA::Double theValue);
 292
 293   virtual void SetInteger(const char* theVarName, CORBA::Long theValue);
 294
 295   virtual void SetBoolean(const char* theVarName, CORBA::Boolean theValue);
 296
 297   virtual void SetString(const char* theVarName, const char* theValue);
 298
 299   virtual void SetStringAsDouble(const char* theVarName, CORBA::Double theValue);
 300
 301   virtual CORBA::Double GetReal(const char* theVarName);
 302
 303   virtual CORBA::Long GetInteger(const char* theVarName);
 304
 305   virtual CORBA::Boolean GetBoolean(const char* theVarName);
 306
 307   virtual char* GetString(const char* theVarName);
 308
 309   virtual CORBA::Boolean IsReal(const char* theVarName);
 310
 311   virtual CORBA::Boolean IsInteger(const char* theVarName);
 312
 313   virtual CORBA::Boolean IsBoolean(const char* theVarName);
 314
 315   virtual CORBA::Boolean IsString(const char* theVarName);
 316
 317   virtual CORBA::Boolean IsVariable(const char* theVarName);
 318
 319   virtual SALOMEDS::ListOfStrings* GetVariableNames();
 320
 321   virtual CORBA::Boolean RemoveVariable(const char* theVarName);
 322
 323   virtual CORBA::Boolean RenameVariable(const char* theVarName, const char* theNewVarName);
 324
 325   virtual CORBA::Boolean IsVariableUsed(const char* theVarName);
 326
 327   virtual SALOMEDS::ListOfListOfStrings* ParseVariables(const char* theVars);
 328
 329   virtual char* GetDefaultScript(const char* theModuleName, const char* theShift);
 330
 331   virtual CORBA::Boolean DumpStudy(const char* thePath,
 332                                    const char* theBaseName,
 333                                    CORBA::Boolean isPublished,
 334                                    CORBA::Boolean isMultiFile);
 335
 336   virtual SALOMEDSImpl_Study* GetImpl() { return _impl; }
 337
 338   virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
 339
 340   static void SetThePOA(PortableServer::POA_ptr);
 341   static PortableServer::POA_ptr GetThePOA();
 342
 343   void ping(){};
 344   CORBA::Long getPID();
 345   void ShutdownWithExit();
 346
 347   void Shutdown();
 348
 349   virtual void attach(SALOMEDS::Observer_ptr theObs, CORBA::Boolean modify);
 350   virtual void detach(SALOMEDS::Observer_ptr theObs);
 351 };
 352 #endif