src/SALOMEDS/SALOMEDS_Study_i.hxx

   1 //  Copyright (C) 2007-2008  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.
  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 //  File   : SALOMEDS_Study_i.hxx
  23 //  Author : Sergey RUIN
  24 //  Module : SALOME
  25 //
  26 #ifndef __SALOMEDS_STUDY_I_H__
  27 #define __SALOMEDS_STUDY_I_H__
  28
  29 // std C++ headers
  30 #include <iostream>
  31
  32 // IDL headers
  33 #include <SALOMEconfig.h>
  34 #include CORBA_SERVER_HEADER(SALOME_GenericObj)
  35 #include CORBA_SERVER_HEADER(SALOMEDS)
  36
  37 #include <stdio.h>
  38
  39 //SALOMEDS headers
  40 #include "SALOMEDS_SComponentIterator_i.hxx"
  41 #include "SALOMEDS_StudyBuilder_i.hxx"
  42 #include "SALOMEDS_SObject_i.hxx"
  43 #include "SALOMEDS_UseCaseBuilder_i.hxx"
  44
  45 #include "SALOMEDSImpl_Study.hxx"
  46 #include "SALOMEDSImpl_AttributeIOR.hxx"
  47
  48 class Standard_EXPORT SALOMEDS_Study_i: public POA_SALOMEDS::Study
  49 {
  50 private:
  51   CORBA::ORB_var                 _orb;
  52   SALOMEDSImpl_Study*            _impl;
  53   SALOMEDS_StudyBuilder_i*       _builder;
  54   static std::map<SALOMEDSImpl_Study*, SALOMEDS_Study_i*> _mapOfStudies;
  55
  56 public:
  57
  58   //! standard constructor
  59   SALOMEDS_Study_i(SALOMEDSImpl_Study*, CORBA::ORB_ptr);
  60
  61   //! standard destructor
  62   virtual ~SALOMEDS_Study_i();
  63
  64   //! method to Get persistent reference of study (idem URL())
  65   /*!
  66     \sa URL()
  67     \return char* arguments, the persistent reference of the study
  68   */
  69   virtual char* GetPersistentReference();
  70
  71
  72   //! method to Get transient reference of study
  73   /*!
  74     \return char* arguments, the transient reference of the study
  75   */
  76   virtual char* GetTransientReference();
  77
  78   //! method to detect if a study is empty
  79   /*!
  80     \return bool arguments, true if study is empty
  81   */
  82   virtual CORBA::Boolean IsEmpty();
  83
  84   //! method to Find a Component with ComponentDataType = aComponentName
  85   /*!
  86     \param aComponentName char* arguments
  87     \return SComponent_ptr arguments, the component found
  88   */
  89   virtual SALOMEDS::SComponent_ptr FindComponent (const char* aComponentName);
  90
  91   //! method to Find a Component Find a Component from it's ID
  92   /*!
  93     \param aComponentID char* arguments
  94     \return SComponent_ptr arguments, the component found
  95   */
  96   virtual SALOMEDS::SComponent_ptr FindComponentID(const char* aComponentID);
  97
  98   //! method to  Find an Object with SALOMEDS::Name = anObjectName
  99   /*!
 100     \param anObjectName char* arguments
 101     \return SObject_ptr arguments, the object found
 102   */
 103   virtual SALOMEDS::SObject_ptr FindObject(const char* anObjectName);
 104
 105
 106   //! method to Find Object(s) with SALOMEDS::Name = anObjectName in a component with ComponentDataType = aComponentName
 107   /*!
 108     \param anObjectName char* arguments
 109     \param aComponentName char* arguments
 110     \return ListOfSObject_ptr arguments, a list of objects found
 111   */
 112
 113   virtual SALOMEDS::Study::ListOfSObject* FindObjectByName( const char* anObjectName, const char* aComponentName ) ;
 114
 115   //! method to Find an Object with ID = anObjectID
 116   /*!
 117     \param anObjectID char* arguments
 118     \return SObject_ptr arguments, the object found
 119   */
 120   virtual SALOMEDS::SObject_ptr FindObjectID(const char* anObjectID);
 121
 122   //! method to Create an Object with ID = anObjectID
 123   /*!
 124     \param anObjectID char* arguments
 125     \return SObject_ptr arguments, the object found
 126   */
 127   virtual SALOMEDS::SObject_ptr CreateObjectID(const char* anObjectID);
 128
 129   //! method to Find an Object with ID = anObjectIOR
 130   /*!
 131     \param anObjectIOR char* arguments
 132     \return SObject_ptr arguments, the object found
 133   */
 134   virtual SALOMEDS::SObject_ptr FindObjectIOR(const char* anObjectIOR);
 135
 136   //! method to Find an Object by its path
 137   /*!
 138     \param thePath char* arguments
 139     \return SObject_ptr arguments, the object found
 140   */
 141   virtual SALOMEDS::SObject_ptr FindObjectByPath(const char* thePath);
 142
 143   //! method to get a path of SObject
 144   /*!
 145     \param aSO  SObject_ptr arguments
 146     \return char* arguments, the path of the SObject
 147   */
 148   virtual char* GetObjectPath(CORBA::Object_ptr theObject);
 149
 150   //! method to set a context: root ('/') is UserData component
 151   /*!
 152   */
 153   virtual void SetContext(const char* thePath);
 154
 155   //! method to get a context
 156   /*!
 157   */
 158   virtual char* GetContext();
 159
 160   //! method to get all object names in the given context (or in the current context, if 'theContext' is empty)
 161   /*!
 162   */
 163   virtual SALOMEDS::ListOfStrings* GetObjectNames(const char* theContext);
 164
 165   //! method to get all directory names in the given context (or in the current context, if 'theContext' is empty)
 166   /*!
 167   */
 168   virtual SALOMEDS::ListOfStrings* GetDirectoryNames(const char* theContext);
 169
 170   //! method to get all file names in the given context (or in the current context, if 'theContext' is empty)
 171   /*!
 172   */
 173   virtual SALOMEDS::ListOfStrings* GetFileNames(const char* theContext);
 174
 175   //! method to get all components names
 176   /*!
 177   */
 178   virtual SALOMEDS::ListOfStrings* GetComponentNames(const char* theContext);
 179
 180   //! method to Create a ChildIterator from an SObject
 181   /*!
 182     \param aSO  SObject_ptr arguments
 183     \return ChildIterator_ptr arguments, the created ChildIterator
 184   */
 185   virtual SALOMEDS::ChildIterator_ptr NewChildIterator(SALOMEDS::SObject_ptr aSO);
 186
 187   //! method to Create a SComponentIterator
 188   /*!
 189     \return SComponentIterator_ptr arguments, the created SComponentIterator
 190   */
 191   virtual SALOMEDS::SComponentIterator_ptr NewComponentIterator();
 192
 193   //! method to Create a StudyBuilder
 194   /*!
 195     \return StudyBuilder_ptr arguments, the created StudyBuilder
 196   */
 197   virtual SALOMEDS::StudyBuilder_ptr NewBuilder();
 198
 199   //! method to get study name
 200   /*!
 201     \return char* arguments, the study name
 202   */
 203   virtual char* Name();
 204
 205   //! method to set study name
 206   /*!
 207     \param name char* arguments, the study name
 208   */
 209   virtual void  Name(const char* name);
 210
 211   //! method to get if study has been saved
 212   /*!
 213     \return bool arguments
 214   */
 215   virtual CORBA::Boolean IsSaved();
 216
 217  //! method to set if study has been saved
 218   /*!
 219     \param save bool arguments
 220   */
 221   virtual void  IsSaved(CORBA::Boolean save);
 222
 223  //! method to Detect if a Study has been modified since it has been saved
 224   /*!
 225     \return bool arguments
 226   */
 227   virtual CORBA::Boolean IsModified();
 228
 229  //! method to set Modified flag of a Study to True
 230   virtual void Modified();
 231
 232   //! method to get URL of the study (idem GetPersistentReference)
 233   /*!
 234     \return char* arguments, the study URL
 235   */
 236   virtual char* URL();
 237
 238  //! method to set URL of the study
 239   /*!
 240     \param url char* arguments, the study URL
 241   */
 242   virtual void  URL(const char* url);
 243
 244   virtual CORBA::Short StudyId();
 245   virtual void  StudyId(CORBA::Short id);
 246
 247   static SALOMEDS::Study_ptr GetStudy(const DF_Label& theLabel, CORBA::ORB_ptr orb);
 248   static SALOMEDS_Study_i* GetStudyServant(SALOMEDSImpl_Study*, CORBA::ORB_ptr orb);
 249
 250   static void IORUpdated(SALOMEDSImpl_AttributeIOR* theAttribute);
 251
 252   virtual void UpdateIORLabelMap(const char* anIOR, const char* aLabel);
 253
 254   virtual SALOMEDS::Study::ListOfSObject* FindDependances(SALOMEDS::SObject_ptr anObject);
 255
 256   virtual SALOMEDS::AttributeStudyProperties_ptr GetProperties();
 257
 258   virtual char* GetLastModificationDate();
 259
 260   virtual SALOMEDS::ListOfDates* GetModificationsDate();
 261
 262   virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
 263   virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
 264
 265   virtual SALOMEDS::UseCaseBuilder_ptr GetUseCaseBuilder();
 266
 267   virtual void Close();
 268
 269   void EnableUseCaseAutoFilling(CORBA::Boolean isEnabled);
 270
 271   // postponed destroying of CORBA object functionality
 272   virtual void AddPostponed(const char* theIOR);
 273
 274   virtual void AddCreatedPostponed(const char* theIOR);
 275
 276 #ifndef WIN32
 277   virtual void RemovePostponed(const CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
 278                                                         // if theUndoLimit==0, removes all
 279   virtual void UndoPostponed(const CORBA::Long theWay); // theWay = 1: resurrect objects,
 280                                                 // theWay = -1: get back to the list of postponed
 281 #else
 282   virtual void RemovePostponed(CORBA::Long theUndoLimit); // removes postponed IORs of old transaction
 283                                                         // if theUndoLimit==0, removes all
 284   virtual void UndoPostponed(CORBA::Long theWay); // theWay = 1: resurrect objects,
 285                                                 // theWay = -1: get back to the list of postponed
 286 #endif
 287
 288   virtual SALOMEDS::AttributeParameter_ptr GetCommonParameters(const char* theID, CORBA::Long theSavePoint);
 289   virtual SALOMEDS::AttributeParameter_ptr GetModuleParameters(const char* theID,
 290                                                                const char* theModuleName,
 291                                                                CORBA::Long theSavePoint);
 292
 293   virtual void SetStudyLock(const char* theLockerID);
 294
 295   virtual bool IsStudyLocked();
 296
 297   virtual void UnLockStudy(const char* theLockerID);
 298
 299   virtual SALOMEDS::ListOfStrings* GetLockerID();
 300
 301   virtual void SetReal(const char* theVarName, CORBA::Double theValue);
 302
 303   virtual void SetInteger(const char* theVarName, CORBA::Long theValue);
 304
 305   virtual void SetBoolean(const char* theVarName, CORBA::Boolean theValue);
 306
 307   virtual void SetString(const char* theVarName, const char* theValue);
 308
 309   virtual void SetStringAsDouble(const char* theVarName, CORBA::Double theValue);
 310
 311   virtual CORBA::Double GetReal(const char* theVarName);
 312
 313   virtual CORBA::Long GetInteger(const char* theVarName);
 314
 315   virtual CORBA::Boolean GetBoolean(const char* theVarName);
 316
 317   virtual char* GetString(const char* theVarName);
 318
 319   virtual CORBA::Boolean IsReal(const char* theVarName);
 320
 321   virtual CORBA::Boolean IsInteger(const char* theVarName);
 322
 323   virtual CORBA::Boolean IsBoolean(const char* theVarName);
 324
 325   virtual CORBA::Boolean IsString(const char* theVarName);
 326
 327   virtual CORBA::Boolean IsVariable(const char* theVarName);
 328
 329   virtual SALOMEDS::ListOfStrings* GetVariableNames();
 330
 331   virtual CORBA::Boolean RemoveVariable(const char* theVarName);
 332
 333   virtual CORBA::Boolean RenameVariable(const char* theVarName, const char* theNewVarName);
 334
 335   virtual CORBA::Boolean IsVariableUsed(const char* theVarName);
 336
 337   virtual SALOMEDS::ListOfListOfStrings* ParseVariables(const char* theVars);
 338
 339   virtual char* GetDefaultScript(const char* theModuleName, const char* theShift);
 340
 341   virtual CORBA::Boolean DumpStudy(const char* thePath, const char* theBaseName, CORBA::Boolean isPublished);
 342
 343   virtual SALOMEDSImpl_Study* GetImpl() { return _impl; }
 344
 345   virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
 346 };
 347 #endif