idl/SALOME_RessourcesCatalog.idl

   1 //  Copyright (C) 2007-2010  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.
  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   : SALOME_RessourcesCatalog.idl
  24 //  Author : Estelle Deville
  25 //  $Header$
  26 //
  27 /*! \file SALOME_RessourcesCatalog.idl \brief interfaces for %SALOME Resources Catalog
  28 */
  29
  30 /*! \brief module that provides interface to manage the Resources Catalog of %SALOME
  31 */
  32 module SALOME_RessourcesCatalog{
  33
  34   //! Information about a processor
  35   struct proc_info{
  36     //! processor number
  37     long number;
  38     //! model name
  39     string model_name;
  40     //! frequency in MHz
  41     float cpu_mhz;
  42     //! cache size in MB
  43     float cache_size;
  44   };
  45
  46   //! a list of processor informations
  47   typedef sequence<proc_info> ListOfProc;
  48
  49   //! Information about a computer
  50   /*!
  51      Os and informations about processors
  52   */
  53   struct computer_info{
  54     //! computer name
  55     string name;
  56     //! OS name
  57     string OS;
  58     //! OS version
  59     string OS_version;
  60     //! processors list
  61     ListOfProc procs;
  62   };
  63
  64   //! Container type
  65   enum ContainerType {
  66   Cpp, /*!< C++ container */
  67   python, /*!< python container */
  68   NP /*!< NP container */
  69   };
  70   //! a list of container types
  71   typedef sequence<ContainerType> ListOfContainerType;
  72
  73   //! a list of computer names
  74   typedef sequence<string> ListOfComputer;
  75
  76   //! exception thrown if a computer is not found in the catalog
  77   exception NotFound {};
  78
  79   //------------------------------------------------------------------
  80 /*! \brief interface to get information about Resources
  81 */
  82   interface RessourcesCatalog {
  83     //! Get the catalog computers list
  84     ListOfComputer GetComputerList();
  85     //! Get the container types list for a given computer
  86     ListOfContainerType GetContainerTypeList (in string computer) raises(NotFound);
  87     //! Get computer information for a given computer
  88     computer_info GetComputerInfo(in string computer) raises(NotFound);
  89   };
  90 };