Salome HOME
updated copyright message
[modules/kernel.git] / src / SALOMEDS / SALOMEDS_StudyBuilder_i.hxx
1 // Copyright (C) 2007-2023  CEA, EDF, 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_StudyBuilder_i.hxx
24 //  Author : Sergey RUIN
25 //  Module : SALOME
26 //
27 #ifndef __SALOMEDS_STUDYBUILDER_I_H__
28 #define __SALOMEDS_STUDYBUILDER_I_H__
29
30 // std C++ headers
31 #include <iostream>
32
33 // IDL headers
34 #include <SALOMEconfig.h>
35 #include CORBA_SERVER_HEADER(SALOMEDS)
36 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
37
38 #include "SALOMEDSImpl_StudyBuilder.hxx"
39
40 class SALOMEDS_StudyBuilder_i: public POA_SALOMEDS::StudyBuilder
41 {
42 private:
43   CORBA::ORB_var                    _orb;
44   SALOMEDSImpl_StudyBuilder*        _impl;  
45 public:
46     
47   SALOMEDS_StudyBuilder_i(SALOMEDSImpl_StudyBuilder*, CORBA::ORB_ptr);
48
49   ~SALOMEDS_StudyBuilder_i();
50
51   virtual PortableServer::POA_ptr _default_POA();
52
53   //! NewComponent
54   /*!
55     \param ComponentDataType    
56     \return <ReturnValue>
57   */
58   virtual SALOMEDS::SComponent_ptr NewComponent(const char* ComponentDataType);
59
60   //! DefineComponentInstance
61   /*!
62     \param SComponent_ptr       
63     \param ComponentIOR 
64   */
65   virtual void DefineComponentInstance (SALOMEDS::SComponent_ptr, CORBA::Object_ptr ComponentIOR);
66   
67   //! 
68   /*!
69     <long-description>
70
71     \param aComponent   
72   */
73   virtual void RemoveComponent(SALOMEDS::SComponent_ptr aComponent);
74
75   //! 
76   /*!
77     <long-description>
78
79     \param theFatherObject      
80     \return <ReturnValue>
81   */
82   virtual SALOMEDS::SObject_ptr NewObject(SALOMEDS::SObject_ptr theFatherObject);
83   //! 
84   /*!
85     <long-description>
86
87     \param theFatherObject      
88     \param atag 
89     \return <ReturnValue>
90   */
91   virtual SALOMEDS::SObject_ptr NewObjectToTag(SALOMEDS::SObject_ptr theFatherObject, CORBA::Long atag);
92
93   virtual void LoadWith(SALOMEDS::SComponent_ptr sco, SALOMEDS::Driver_ptr Engine); 
94   virtual void Load(SALOMEDS::SObject_ptr sco);
95
96   virtual void RemoveObject(SALOMEDS::SObject_ptr anObject);
97   virtual void RemoveObjectWithChildren(SALOMEDS::SObject_ptr anObject);
98
99   virtual SALOMEDS::GenericAttribute_ptr FindOrCreateAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
100   virtual CORBA::Boolean FindAttribute(SALOMEDS::SObject_ptr anObject, SALOMEDS::GenericAttribute_out anAttribute, const char* aTypeOfAttribute);
101   virtual void RemoveAttribute(SALOMEDS::SObject_ptr anObject, const char* aTypeOfAttribute);
102
103   virtual void Addreference(SALOMEDS::SObject_ptr me, SALOMEDS::SObject_ptr thereferencedObject);
104
105   virtual void RemoveReference(SALOMEDS::SObject_ptr me);
106
107   virtual void SetGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
108   virtual bool IsGUID(SALOMEDS::SObject_ptr anObject, const char* theGUID);
109
110   virtual void NewCommand();
111   virtual void CommitCommand();
112   virtual CORBA::Boolean HasOpenCommand();
113   virtual void AbortCommand();
114   virtual void Undo();
115   virtual void Redo();
116   CORBA::Boolean GetAvailableUndos();
117   CORBA::Boolean GetAvailableRedos();
118   CORBA::Boolean IsSaved();
119   CORBA::Boolean IsModified();
120   virtual CORBA::Long UndoLimit();
121   virtual void UndoLimit(CORBA::Long);
122
123   void CheckLocked();
124
125   virtual void SetName(SALOMEDS::SObject_ptr theSO, const char* theValue);
126   virtual void SetComment(SALOMEDS::SObject_ptr theSO, const char* theValue);
127   virtual void SetIOR(SALOMEDS::SObject_ptr theSO, const char* theValue);
128
129   SALOMEDSImpl_StudyBuilder* GetImpl() { return _impl; }
130
131 };
132 #endif