src/SALOMEDS/SALOMEDS_StudyBuilder_i.hxx

   1 //  SALOME SALOMEDS : data structure of SALOME and sources of Salome data server
   2 //
   3 //  Copyright (C) 2003  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : SALOMEDS_StudyBuilder_i.hxx
  25 //  Author : Yves FRICAUD
  26 //  Module : SALOME
  27 //  $Header$
  28
  29 #ifndef __SALOMEDS_STUDYBUIlDER_I_H__
  30 #define __SALOMEDS_STUDYBUILDER_I_H__
  31
  32 // IDL headers
  33 #include <SALOMEconfig.h>
  34 #include CORBA_SERVER_HEADER(SALOMEDS)
  35 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
  36
  37 // Cascade header
  38 #include <TDocStd_Document.hxx>
  39
  40 class SALOMEDS_Study_i;
  41 class SALOMEDS_SObject_i;
  42 class SALOMEDS_Callback_i;
  43
  44 class SALOMEDS_StudyBuilder_i: public virtual POA_SALOMEDS::StudyBuilder,
  45                                public virtual PortableServer::RefCountServantBase
  46 {
  47   SALOMEDS_StudyBuilder_i(); // Not implemented
  48   void operator=(const SALOMEDS_StudyBuilder_i&); // Not implemented
  49
  50   SALOMEDS_Study_i*        _study;
  51   Handle(TDocStd_Document) _doc;  // OCAF Document
  52
  53   void OnAddSObject(SALOMEDS::SObject_ptr theObject);
  54   void OnRemoveSObject(SALOMEDS::SObject_ptr theObject);
  55
  56 public:
  57   SALOMEDS_StudyBuilder_i(SALOMEDS_Study_i* theStudy,
  58                           const Handle(TDocStd_Document)& theDocument);
  59
  60   ~SALOMEDS_StudyBuilder_i();
  61
  62   CORBA::ORB_var GetORB() const;
  63   PortableServer::POA_var GetPOA() const;
  64
  65   //! NewComponent
  66   /*!
  67     \param ComponentDataType
  68     \return <ReturnValue>
  69   */
  70   virtual SALOMEDS::SComponent_ptr NewComponent(const char* ComponentDataType);
  71
  72   //! DefineComponentInstance
  73   /*!
  74     \param SComponent_ptr
  75     \param ComponentIOR
  76   */
  77   virtual void DefineComponentInstance (SALOMEDS::SComponent_ptr, CORBA::Object_ptr ComponentIOR);
  78
  79   //!
  80   /*!
  81     <long-description>
  82
  83     \param aComponent
  84   */
  85   virtual void RemoveComponent(SALOMEDS::SComponent_ptr aComponent);
  86
  87   //!
  88   /*!
  89     <long-description>
  90
  91     \param theFatherObject
  92     \return <ReturnValue>
  93   */
  94   virtual SALOMEDS::SObject_ptr NewObject(SALOMEDS::SObject_ptr theFatherObject);
  95   //!
  96   /*!
  97     <long-description>
  98
  99     \param theFatherObject
 100     \param atag
 101     \return <ReturnValue>
 102   */
 103   virtual SALOMEDS::SObject_ptr NewObjectToTag(SALOMEDS::SObject_ptr theFatherObject, CORBA::Long atag);
 104
 105   /*!
 106     The methods adds a new subdirectory, the path can be absolute or relative (then the current context is used)
 107   */
 108   virtual void AddDirectory(const char* thePath);
 109
 110   virtual void LoadWith(SALOMEDS::SComponent_ptr sco, SALOMEDS::Driver_ptr Engine)
 111     throw(SALOME::SALOME_Exception);
 112   virtual void Load(SALOMEDS::SObject_ptr sco);
 113
 114   SALOMEDS_SObject_i* RemoveSObject(SALOMEDS::SObject_ptr theSObject,
 115                                     bool theIsForgetAllAttributes = true);
 116   virtual void RemoveObject(SALOMEDS::SObject_ptr anObject);
 117   virtual void RemoveObjectWithChildren(SALOMEDS::SObject_ptr anObject);
 118
 119   virtual SALOMEDS::GenericAttribute_ptr FindOrCreateAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
 120   virtual CORBA::Boolean FindAttribute(SALOMEDS::SObject_ptr anObject, SALOMEDS::GenericAttribute_out anAttribute, const char* aTypeOfAttribute);
 121   virtual void RemoveAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
 122
 123   virtual void Addreference(SALOMEDS::SObject_ptr me, SALOMEDS::SObject_ptr thereferencedObject);
 124
 125   virtual void RemoveReference(SALOMEDS::SObject_ptr me);
 126
 127   virtual void SetGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
 128   virtual bool IsGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
 129
 130   virtual void NewCommand();
 131   virtual void CommitCommand() throw(SALOMEDS::StudyBuilder::LockProtection);
 132   virtual CORBA::Boolean HasOpenCommand();
 133   virtual void AbortCommand();
 134   virtual void Undo() throw(SALOMEDS::StudyBuilder::LockProtection);
 135   virtual void Redo() throw(SALOMEDS::StudyBuilder::LockProtection);
 136   CORBA::Boolean GetAvailableUndos();
 137   CORBA::Boolean GetAvailableRedos();
 138   CORBA::Boolean IsSaved();
 139   CORBA::Boolean IsModified();
 140   virtual CORBA::Long UndoLimit();
 141   virtual void UndoLimit(CORBA::Long);
 142
 143   void CheckLocked() throw (SALOMEDS::StudyBuilder::LockProtection);
 144
 145   virtual SALOMEDS::Callback_ptr SetOnAddSObject(SALOMEDS::Callback_ptr theCallback);
 146   virtual SALOMEDS::Callback_ptr SetOnRemoveSObject(SALOMEDS::Callback_ptr theCallback);
 147
 148   virtual void SetName(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
 149   virtual void SetComment(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
 150   virtual void SetIOR(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
 151 };
 152 #endif