idl/SALOME_ModuleCatalog.idl

Go to the documentation of this file.

// Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007  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.11.2.1.22.1.6.1 2011-06-01 13:51:33 vsr Exp $
//
module SALOME_ModuleCatalog
{
  enum ComponentType {  GEOM,  
                        MESH,  
                         Med,  
                      SOLVER,  
                        DATA,  
                        VISU,  
                      SUPERV,  
                       OTHER   
                     } ;
  struct ServicesParameter
  {
    string Parametertype; 
    string Parametername; 
  } ;

  enum DataStreamDependency {
    DATASTREAM_UNDEFINED, 
    DATASTREAM_TEMPORAL, 
    DATASTREAM_ITERATIVE 
  } ;

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

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

  typedef sequence<string> ListOfString;

  enum TypeKind 
  {
    NONE     ,
    Dble   , 
    Int      , 
    Str   , 
    Bool     , 
    Objref   , 
    Seq , 
    Array    , 
    Struc  
  };

  struct MemberDefinition
  {
    string name; 
    string type; 
  };
  typedef sequence<MemberDefinition> ListOfMemberDefinition;

  struct TypeDefinition
  {
    string name; 
    TypeKind kind; 
    string id; 
    string content; 
    ListOfString bases; 
    ListOfMemberDefinition members; 
  };

  typedef sequence<TypeDefinition> ListOfTypeDefinition;

  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;

  enum ImplType {
    SO,                       
    PY,                       
    EXE,                      
    CEXE                      
  } ;

  struct ComponentDef
  {
    ComponentType      type;
    string             name;
    string             username;
    boolean            multistudy;
    ImplType           implementationType;
    string             implname;
    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
  {
    ListOfInterfaces GetInterfaceList() ;

    DefinitionInterface GetInterface(in string interfacename) raises(NotFound);

    ListOfServices GetServiceList(in string interfacename) raises(NotFound);

    
    Service GetService(in string interfacename, 
                 in string servicename) raises(NotFound);

    Service GetDefaultService(in string interfacename) raises(NotFound);

    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 ImplType implementation_type;
    readonly attribute string implementation_name;
  } ;

  interface ModuleCatalog
  {
    void ping();

    long getPID();

    oneway void ShutdownWithExit();

    ListOfTypeDefinition GetTypes();

    ListOfComputers GetComputerList();

    string GetPathPrefix(in string machinename) raises(NotFound);

    ListOfComponents GetComponentList();

    ListOfIAPP_Affich GetComponentIconeList();

    ListOfComponents GetTypedComponentList(in ComponentType _component_type);

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

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

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

    void shutdown();
  } ;
};