Salome HOME
CCAR: documentation update
[modules/kernel.git] / idl / Palm_Ports.idl
1 //  Copyright (C) 2007-2008  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 //  File   : Palm_Ports.idl
23 //  Author : AndrĂ© RIBES, EDF
24 //
25 #ifndef _PALM_PORTS_IDL_
26 #define _PALM_PORTS_IDL_
27
28 #include "SALOME_Ports.idl"
29
30 /*! \file  Palm_Ports.idl
31     \brief This file contains IDL palm ports declarations.
32 */
33
34 module Ports {
35
36   module Palm_Ports {
37
38     /*! \brief Interface of a short for palm.
39      */
40     interface Palm_Data_Short_Port : Ports::Data_Port {
41
42       /*! \brief  This operation permits to transmit a short.
43
44         \param data the short transmitted.
45         \param time time associated to the short.
46         \param tag  tag associated to the short.
47        */
48       void put (in short data, in long time, in long tag);
49     };
50
51     /*!
52       It is a sequence of short for palm ports.
53      */
54     typedef sequence<short> seq_short;
55
56     /*! \brief Interface of a sequence of short port.
57      */
58     interface Palm_Data_Seq_Short_Port : Ports::Data_Port {
59       /*! \brief  This operation permits to transmit a sequence of short.
60
61         \param data the sequence transmitted.
62         \param time time associated to the data.
63         \param tag  tag associated to the data.
64        */
65       void put (in seq_short data, in long time, in long tag);
66     };
67
68   };
69 };
70
71 #endif