idl/DSC_Engines.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   : DSC_Engines.idl
//  Author : Andre RIBES, EDF
//  $Header:
//
#ifndef _DSC_ENGINES_IDL_
#define _DSC_ENGINES_IDL_

#include "SALOME_Component.idl"
#include "SALOME_Ports.idl"

module Engines {

  interface DSC : Engines::EngineComponent {

/*--------------------------------------------------------------------------------------------*/
/*-------------------------------------- Types Part ------------------------------------------*/


    typedef sequence<Ports::Port> uses_port;


    enum Message {AddingConnection,
                  RemovingConnection, 
                  ApplicationError};
    
    exception PortNotDefined {};
    
    exception PortAlreadyDefined {};
    
    exception PortNotConnected {};


    exception BadPortType {
      string expected;
      string received;
    };

    exception NilPort {};

    exception BadPortReference {};

    exception BadProperty {};


/*--------------------------------------------------------------------------------------------*/
/*-------------------------------------- Operation Part --------------------------------------*/


    void add_provides_port(in Ports::Port ref, 
                  in string provides_port_name,
                  in Ports::PortProperties port_prop) raises(PortAlreadyDefined,
                                              NilPort,
                                              BadProperty);


    void add_uses_port(in string repository_id, 
                 in string uses_port_name,
                 in Ports::PortProperties port_prop) raises(PortAlreadyDefined,
                                          BadProperty);


    Ports::Port get_provides_port(in string provides_port_name,
                      in boolean connection_error) raises(PortNotDefined,
                                              PortNotConnected,
                                              BadPortType);


    uses_port get_uses_port(in string uses_port_name) raises(PortNotDefined, 
                                        PortNotConnected,
                                        BadPortType);



    void connect_provides_port(in string provides_port_name) raises(PortNotDefined); 
    

    void connect_uses_port(in string uses_port_name, 
                  in Ports::Port provides_port_ref) raises(PortNotDefined, 
                                            BadPortType, 
                                            NilPort);


    boolean is_connected(in string port_name) raises(PortNotDefined);


    void disconnect_provides_port(in string provides_port_name, 
                      in Engines::DSC::Message message) raises(PortNotDefined,
                                                PortNotConnected);


    void disconnect_uses_port(in string uses_port_name, 
                     in Ports::Port provides_port_ref, 
                     in Engines::DSC::Message message) raises(PortNotDefined,
                                               PortNotConnected,
                                               BadPortReference);

    Ports::PortProperties get_port_properties(in string port_name) raises(PortNotDefined);

  };

  interface ConnectionManager {
   
    exception BadId {};

    typedef short connectionId;


    connectionId connect(in Engines::DSC uses_component, 
                in string uses_port_name, 
                in Engines::DSC provides_component, 
                in string provides_port_name) raises(Engines::DSC::PortNotDefined, 
                                         Engines::DSC::BadPortType, 
                                         Engines::DSC::NilPort);


    void disconnect(in connectionId id,
              in Engines::DSC::Message message) raises(Engines::ConnectionManager::BadId,
                                        Engines::DSC::PortNotDefined,
                                        Engines::DSC::PortNotConnected,
                                        Engines::DSC::BadPortReference);

    oneway void ShutdownWithExit();

    long getPID();
  };

/*--------------------------------------------------------------------------------------------*/
  
  interface Superv_Component : Engines::DSC {
    

    boolean init_service(in string service_name);
  };
};

#endif