src/SALOMEDS/SALOMEDS_StudyBuilder_i.hxx

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/
  19 //
  20 //  File   : SALOMEDS_StudyBuilder_i.hxx
  21 //  Author : Sergey RUIN
  22 //  Module : SALOME
  23
  24 #ifndef __SALOMEDS_STUDYBUILDER_I_H__
  25 #define __SALOMEDS_STUDYBUILDER_I_H__
  26
  27 // std C++ headers
  28 #include <iostream>
  29
  30 // IDL headers
  31 #include <SALOMEconfig.h>
  32 #include CORBA_SERVER_HEADER(SALOMEDS)
  33 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
  34
  35 #include "SALOMEDSImpl_StudyBuilder.hxx"
  36
  37 // Cascade header
  38 #include <TDocStd_Document.hxx>
  39
  40 class SALOMEDS_StudyBuilder_i: public POA_SALOMEDS::StudyBuilder,
  41                                public PortableServer::RefCountServantBase
  42 {
  43 private:
  44   CORBA::ORB_ptr                    _orb;
  45   Handle(SALOMEDSImpl_StudyBuilder) _impl;  // OCAF Document
  46 public:
  47
  48   SALOMEDS_StudyBuilder_i(const Handle(SALOMEDSImpl_StudyBuilder), CORBA::ORB_ptr);
  49
  50   ~SALOMEDS_StudyBuilder_i();
  51
  52   //! NewComponent
  53   /*!
  54     \param ComponentDataType
  55     \return <ReturnValue>
  56   */
  57   virtual SALOMEDS::SComponent_ptr NewComponent(const char* ComponentDataType);
  58
  59   //! DefineComponentInstance
  60   /*!
  61     \param SComponent_ptr
  62     \param ComponentIOR
  63   */
  64   virtual void DefineComponentInstance (SALOMEDS::SComponent_ptr, CORBA::Object_ptr ComponentIOR);
  65
  66   //!
  67   /*!
  68     <long-description>
  69
  70     \param aComponent
  71   */
  72   virtual void RemoveComponent(SALOMEDS::SComponent_ptr aComponent);
  73
  74   //!
  75   /*!
  76     <long-description>
  77
  78     \param theFatherObject
  79     \return <ReturnValue>
  80   */
  81   virtual SALOMEDS::SObject_ptr NewObject(SALOMEDS::SObject_ptr theFatherObject);
  82   //!
  83   /*!
  84     <long-description>
  85
  86     \param theFatherObject
  87     \param atag
  88     \return <ReturnValue>
  89   */
  90   virtual SALOMEDS::SObject_ptr NewObjectToTag(SALOMEDS::SObject_ptr theFatherObject, CORBA::Long atag);
  91
  92   /*!
  93     The methods adds a new subdirectory, the path can be absolute or relative (then the current context is used)
  94   */
  95   virtual void AddDirectory(const char* thePath);
  96
  97   virtual void LoadWith(SALOMEDS::SComponent_ptr sco, SALOMEDS::Driver_ptr Engine)
  98     throw(SALOME::SALOME_Exception);
  99   virtual void Load(SALOMEDS::SObject_ptr sco);
 100
 101   virtual void RemoveObject(SALOMEDS::SObject_ptr anObject);
 102   virtual void RemoveObjectWithChildren(SALOMEDS::SObject_ptr anObject);
 103
 104   virtual SALOMEDS::GenericAttribute_ptr FindOrCreateAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
 105   virtual CORBA::Boolean FindAttribute(SALOMEDS::SObject_ptr anObject, SALOMEDS::GenericAttribute_out anAttribute, const char* aTypeOfAttribute);
 106   virtual void RemoveAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
 107
 108   virtual void Addreference(SALOMEDS::SObject_ptr me, SALOMEDS::SObject_ptr thereferencedObject);
 109
 110   virtual void RemoveReference(SALOMEDS::SObject_ptr me);
 111
 112   virtual void SetGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
 113   virtual bool IsGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
 114
 115   virtual void NewCommand();
 116   virtual void CommitCommand() throw(SALOMEDS::StudyBuilder::LockProtection);
 117   virtual CORBA::Boolean HasOpenCommand();
 118   virtual void AbortCommand();
 119   virtual void Undo() throw(SALOMEDS::StudyBuilder::LockProtection);
 120   virtual void Redo() throw(SALOMEDS::StudyBuilder::LockProtection);
 121   CORBA::Boolean GetAvailableUndos();
 122   CORBA::Boolean GetAvailableRedos();
 123   CORBA::Boolean IsSaved();
 124   CORBA::Boolean IsModified();
 125   virtual CORBA::Long UndoLimit();
 126   virtual void UndoLimit(CORBA::Long);
 127
 128   void CheckLocked() throw (SALOMEDS::StudyBuilder::LockProtection);
 129
 130   virtual void SetName(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
 131   virtual void SetComment(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
 132   virtual void SetIOR(SALOMEDS::SObject_ptr theSO, const char* theValue) throw(SALOMEDS::StudyBuilder::LockProtection);
 133 };
 134 #endif