Salome HOME
Add DLL specs.
[modules/smesh.git] / src / StdMeshers_I / StdMeshers_ObjRefUlils.hxx
1 // Copyright (C) 2007-2021  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 //  SMESH SMESH : implementation of SMESH idl descriptions
24 // File      : StdMeshers_ObjRefUlils.hxx
25 // Created   : Wed Oct 18 15:15:27 2006
26 // Author    : Edward AGAPOV (eap)
27 //
28 #ifndef StdMeshers_ObjRefUlils_HeaderFile
29 #define StdMeshers_ObjRefUlils_HeaderFile
30
31 #include "SMESH_Gen_i.hxx"
32 #include "SMESH_StdMeshers_I.hxx"
33
34 /*!
35  * \brief Class encapsulates methods
36  *  - converting internal objects to CORBA objects and backward and
37  *  - persistence methods for such objects
38  *
39  * These methods are useful for hypotheses referring to other objects
40  * like meshes, geom objects, other hypotheses, etc.
41  */
42 class StdMeshers_ObjRefUlils
43 {
44 public:
45   /*!
46    * \brief Return GEOM Object corresponding to TopoDS_Shape
47     * \param theShape - input TopoDS_Shape
48     * \retval GEOM::GEOM_Object_ptr - result object
49    */
50    static GEOM::GEOM_Object_ptr ShapeToGeomObject (const TopoDS_Shape& theShape ) {
51      if (SMESH_Gen_i* gen = SMESH_Gen_i::GetSMESHGen())
52        return gen->ShapeToGeomObject( theShape );
53      else
54        return GEOM::GEOM_Object::_nil();
55    }
56
57   /*!
58    * \brief Return TopoDS_Shape corresponding to GEOM_Object
59     * \param theGeomObject - input object
60     * \retval TopoDS_Shape - result TopoDS_Shape
61    */
62   static TopoDS_Shape GeomObjectToShape(GEOM::GEOM_Object_ptr theGeomObject) {
63      if (SMESH_Gen_i* gen = SMESH_Gen_i::GetSMESHGen())
64        return gen->GeomObjectToShape( theGeomObject );
65      else
66        return TopoDS_Shape();
67   }
68
69   /*!
70    * \brief Return TopoDS_Shape by a study entry
71    *  \param theEntry - study entry
72    *  \retval TopoDS_Shape - result TopoDS_Shape
73    */
74   STDMESHERS_I_EXPORT static TopoDS_Shape EntryToShape(const std::string theEntry);
75
76   /*!
77    * \brief Return study entry of GEOM Object
78    */
79   static std::string GeomObjectToEntry(GEOM::GEOM_Object_ptr theGeomObject);
80
81   /*!
82    * \brief Return GEOM Object by its study entry or TopoDS_Shape
83    */
84   static GEOM::GEOM_Object_ptr EntryOrShapeToGeomObject (const std::string&  theEntry,
85                                                          const TopoDS_Shape& theShape);
86
87
88   /*!
89    * \brief Store the shape in the stream
90     * \param theShape - shape to store
91     * \param stream - the stream
92    */
93   static void SaveToStream( const TopoDS_Shape& theShape, std::ostream & stream);
94
95   /*!
96    * \brief Retrieve a shape from the stream
97     * \param stream - the stream
98     * \retval TopoDS_Shape - resulting shape
99    */
100   static TopoDS_Shape LoadFromStream( std::istream & stream, std::string* entry=NULL );
101
102   /*!
103    * \brief Store the CORBA object in the stream
104     * \param obj - object to store
105     * \param stream - the stream
106    */
107   static void SaveToStream( CORBA::Object_ptr obj, std::ostream & stream );
108
109   /*!
110    * \brief Retrieve a CORBA object from the stream 
111     * \param stream - the stream
112     * \retval CORBA::Object_ptr - result object
113    */
114   template<class TInterface> 
115   static 
116   typename TInterface::_var_type LoadObjectFromStream( std::istream & stream )
117   {
118     if (SMESH_Gen_i* gen = SMESH_Gen_i::GetSMESHGen()) {
119       std::string str;
120       if (stream >> str) {
121         if ( StudyContext* myStudyContext = gen->GetStudyContext() ) {
122           std::string ior = myStudyContext->getIORbyOldId( atoi( str.c_str() ));
123           if ( !ior.empty() )
124              return TInterface::_narrow(gen->GetORB()->string_to_object( ior.c_str() ));
125         }
126       }
127     }
128     return TInterface::_nil();
129   }
130
131   /*!
132    * \brief Store the study entry of object in the stream
133     * \param studyEntry - the study entry
134     * \param stream - the stream
135    */
136   static void SaveToStream( const std::string& studyEntry, std::ostream & stream);
137
138 };
139
140 #endif