General KERNEL Documentation

End User KERNEL Services

---

idl/SALOME_ModuleCatalog.idl

Go to the documentation of this file.

//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
// 
//  This library is free software; you can redistribute it and/or 
//  modify it under the terms of the GNU Lesser General Public 
//  License as published by the Free Software Foundation; either 
//  version 2.1 of the License. 
// 
//  This library is distributed in the hope that it will be useful, 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
//  Lesser General Public License for more details. 
// 
//  You should have received a copy of the GNU Lesser General Public 
//  License along with this library; if not, write to the Free Software 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
// 
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
//
//
//  File   : SALOME_ModuleCatalog.idl
//  Author : Estelle Deville
//  $Header: /home/server/cvs/KERNEL/KERNEL_SRC/idl/SALOME_ModuleCatalog.idl,v 1.9 2006/06/01 11:15:15 jfa Exp $

module SALOME_ModuleCatalog
{
  // Type Definitions
  enum ComponentType {  GEOM,  
                        MESH,  
                         Med,  
                      SOLVER,  
                        DATA,  
                        VISU,  
                      SUPERV,  
                       OTHER   
                     } ;
  struct ServicesParameter
  {
    string Parametertype; 
    string Parametername; 
  } ;

  enum DataStreamDependency {
    DATASTREAM_UNDEFINED,
    DATASTREAM_TEMPORAL,
    DATASTREAM_ITERATIVE
  } ;

  enum DataStreamType {
    DATASTREAM_UNKNOWN,
    DATASTREAM_INTEGER,
    DATASTREAM_FLOAT,
    DATASTREAM_DOUBLE,
    DATASTREAM_STRING,
    DATASTREAM_BOOLEAN
  } ;

  struct ServicesDataStreamParameter
  {
    DataStreamType Parametertype; 
    string Parametername;         
    DataStreamDependency Parameterdependency; 
  } ;

  typedef sequence<ServicesParameter> ListOfServicesParameter;
  typedef sequence<ServicesDataStreamParameter> ListOfServicesDataStreamParameter;

  struct Service
  {
    string                            ServiceName; 
    ListOfServicesParameter           ServiceinParameter; 
    ListOfServicesParameter           ServiceoutParameter; 
    ListOfServicesDataStreamParameter ServiceinDataStreamParameter; 
    ListOfServicesDataStreamParameter ServiceoutDataStreamParameter; 
    boolean                           Servicebydefault; 
    boolean                           TypeOfNode; 
  } ;
  typedef sequence<Service> ListOfInterfaceService;
  typedef sequence<string> ListOfServices ;
  struct DefinitionInterface
  {
    string                 interfacename ; 
    ListOfInterfaceService interfaceservicelist ; 
  } ;
  typedef sequence<DefinitionInterface> ListOfDefInterface ;
  typedef sequence<string> ListOfInterfaces ;

  struct PathPrefix {
    string             machine;
    string             path;
  };

  typedef sequence<PathPrefix> PathPrefixes;

  struct Component
  {
    ComponentType      type;
    string             name;
    string             username;
    boolean            multistudy;
    boolean            implementationType;
    string             icon;
    string             constraint;
    ListOfDefInterface interfaces;
    PathPrefixes       paths;
  };

  typedef sequence<string> ListOfComponents ;
  typedef sequence<string> ListOfComputers ;
  struct IAPP_Affich
  {
    string modulename;     
    string moduleusername; 
    string moduleicone;    
    string moduleversion;  
    string modulecomment;  
  };
  typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;

  exception NotFound
  {
    string what ; 
  } ;

  interface Acomponent
  {
    // GetInterfaceList : operation to get a list of the interfaces name of
    //                    a component
    ListOfInterfaces GetInterfaceList() ;

    // GetInterface : operation to get one interface of a component
  
    DefinitionInterface GetInterface(in string interfacename) raises(NotFound);

    // GetServiceList : operation to get a list of the services name of
    //                  an interface of a component
    ListOfServices GetServiceList(in string interfacename) raises(NotFound);

    
    // GetService : operation to get one service of an interface of a component
  
    Service GetService(in string interfacename, 
                 in string servicename) raises(NotFound);

    // GetDefaultService : operation to get the default service
    //                     of an interface of a component
    Service GetDefaultService(in string interfacename) raises(NotFound);

    // GetPathPrefix : operation to get the PathPrefix of a computer
    string GetPathPrefix(in string machinename) raises(NotFound);

    readonly attribute string constraint ;

    readonly attribute string componentname;

    readonly attribute string componentusername;

    readonly attribute boolean multistudy;

    readonly attribute ComponentType component_type ;

    readonly attribute string component_icone;

    readonly attribute boolean implementation_type;
  } ;

  interface ModuleCatalog
  {
    void ping();

    ListOfComputers GetComputerList();

    string GetPathPrefix(in string machinename) raises(NotFound);
    ListOfComponents GetComponentList();
    ListOfIAPP_Affich GetComponentIconeList();
    // GetComponentList : operation to get a list of the components name of
    //                    a particular type of the catalog   
    ListOfComponents GetTypedComponentList(in ComponentType _component_type);

    Acomponent GetComponent(in string componentname) raises(NotFound);

    Component GetComponentInfo(in string componentName) raises(NotFound);

    void ImportXmlCatalogFile(in string filename) raises(NotFound);

    void shutdown();
  } ;
};

---

General KERNEL Documentation

End User KERNEL Services

Generated on Wed Jul 26 14:49:30 2006 for SALOME v.3.2.1 by  1.4.6