src/ModuleCatalog/SALOME_ModuleCatalog_impl.hxx

   1 // Copyright (C) 2007-2014  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 //  SALOME ModuleCatalog : implementation of ModuleCatalog server which parsers xml description of modules
  24 //  File   : SALOME_ModuleCatalog_impl.hxx
  25 //  Author : Estelle Deville
  26 //  Module : SALOME
  27 //  $Header$
  28 //
  29 #ifndef MODULECATALOG_IMPL_H
  30 #define MODULECATALOG_IMPL_H
  31
  32 #include "SALOME_ModuleCatalog.hxx"
  33
  34 #include <string>
  35 #include <map>
  36
  37 #include <SALOMEconfig.h>
  38 #include CORBA_SERVER_HEADER(SALOME_ModuleCatalog)
  39
  40 #ifdef WIN32
  41 #pragma warning(disable:4275) // Disable warning interface non dll
  42 #pragma warning(disable:4290) // Warning Exception ...
  43 #endif
  44
  45 class MODULECATALOG_EXPORT SALOME_ModuleCatalogImpl: public POA_SALOME_ModuleCatalog::ModuleCatalog
  46 {
  47   class Private;
  48
  49 public:
  50   //! standard constructor
  51   SALOME_ModuleCatalogImpl(int artgc, char** argv, CORBA::ORB_ptr orb = NULL);
  52
  53   //! standard destructor
  54   virtual ~SALOME_ModuleCatalogImpl();
  55
  56   //! method to get a component list
  57   /*!
  58    * \return a component list
  59    */
  60   virtual SALOME_ModuleCatalog::ListOfComputers* GetComputerList();
  61
  62   //! method to get the list of all types of the catalog
  63   /*!
  64    * \return the types list
  65    */
  66   virtual SALOME_ModuleCatalog::ListOfTypeDefinition* GetTypes();
  67
  68   //! method to get the PathPrefix of a computer
  69   /*! If the wanted computer doesn't exist, the Notfound exception is thrown
  70    * \param machinename const char* arguments
  71    * \return the prefix path
  72   */
  73   virtual char* GetPathPrefix(const char* machinename);
  74
  75   //! method to read a XML file and import new components into the component list
  76   /*! If the XML file doesn't exist or is not readable, the Notfound exception is thrown
  77    * \param  const char* xmlFileName
  78    */
  79   virtual void ImportXmlCatalogFile(const char* xmlFileName);
  80
  81   //! method to get a component list
  82   /*!
  83    * \return a component list
  84    */
  85   virtual SALOME_ModuleCatalog::ListOfComponents* GetComponentList();
  86
  87   //! method to get a component list of component name and component icone
  88   /*!
  89    * \return a list of couple (component name, component icone)
  90    */
  91   virtual SALOME_ModuleCatalog::ListOfIAPP_Affich* GetComponentIconeList();
  92
  93   //! method to get a component list of a wanted type
  94   /*!
  95    * \return a component list
  96    */
  97   virtual SALOME_ModuleCatalog::ListOfComponents*
  98     GetTypedComponentList(SALOME_ModuleCatalog::ComponentType component_type);
  99
 100   //! method to get a component
 101   /*!
 102    * \param componentname const char* arguments
 103    * \return the wanted component
 104    */
 105   virtual SALOME_ModuleCatalog::Acomponent_ptr
 106     GetComponent(const char* componentname);
 107
 108   //! method to get a component description
 109   /*!
 110    * \param componentname const char* arguments
 111    * \return the wanted component description
 112    */
 113   virtual SALOME_ModuleCatalog::ComponentDef*
 114     GetComponentInfo(const char *name);
 115
 116   //! method to check the server is alive
 117   void ping();
 118
 119   //! get PID of the server
 120   CORBA::Long getPID();
 121
 122   //! shutdown server and exit
 123   void ShutdownWithExit();
 124
 125   //! shutdown server
 126   void shutdown();
 127
 128 private:
 129   //! method to parse arguments to get general and personal catalog files
 130   /*!
 131    * \param argc int arguments
 132    * \param argv char** arguments
 133    * \param _general char** arguments
 134    * \return true if parsing is OK
 135    */
 136   virtual bool _parseArguments(int argc, char **argv,
 137                                char **_general, char** _personal);
 138
 139
 140   CORBA::ORB_ptr _orb;
 141   Private* myPrivate;
 142 };
 143
 144 #endif // MODULECATALOG_IMPL_H