DataFlow.idl

Go to the documentation of this file.

#ifndef ORO_CORBA_DATAFLOW_IDL
#define ORO_CORBA_DATAFLOW_IDL

#ifdef CORBA_IS_TAO
//resolves LNK2005
#include <tao/orb.idl>
#endif

module RTT
{
  module corba
  {
    enum CFlowStatus { CNoData, COldData, CNewData };
    enum CWriteStatus { CWriteSuccess, CWriteFailure, CNotConnected };
    enum CConnectionModel { CData, CBuffer, CCircularBuffer };
    enum CLockPolicy { CUnsync, CLocked, CLockFree };
    enum CBufferPolicy { CBufferPolicyUnspecified, CPerConnection, CPerInputPort, CPerOutputPort, CShared };
    struct CConnPolicy
    {
        CConnectionModel type;
        long size;
        CLockPolicy lock_policy;
        boolean init;
        boolean pull;
        CBufferPolicy buffer_policy;
        long max_threads;
        boolean mandatory;
        long transport;
        long data_size;
        string name_id;
    };

    interface CChannelElement
    {

        //boolean setDataSample(in any sample);

        boolean inputReady();

        boolean channelReady(in CConnPolicy cp);

        CFlowStatus read(out any sample, in boolean copy_old_data);

        CWriteStatus write(in any sample);

        oneway void writeOneway(in any sample);

        void disconnect();
    };

    interface CRemoteChannelElement : CChannelElement
    {
        void setRemoteSide(in CRemoteChannelElement other);

        oneway void remoteSignal();

        void remoteDisconnect(in boolean forward);

    };

    exception CNoSuchPortException {};
    exception CNoCorbaTransport {};
    exception CInvalidArgument {};

    enum CPortType { CInput, COutput };

    struct CPortDescription
    {
        CPortType type;
        string   name;
        string   description;
        string   type_name;
    };

    interface CDataFlowInterface
    {
      typedef sequence<string> CPortNames;
      typedef sequence<CPortDescription> CPortDescriptions;

      CPortNames getPorts();

      CPortDescriptions getPortDescriptions();

      CPortType getPortType(in string port_name)
            raises(CNoSuchPortException);

      string getDataType(in string port_name)
            raises(CNoSuchPortException);

      boolean isConnected(in string port_name)
            raises(CNoSuchPortException);

      void disconnectPort(in string port_name)
            raises(CNoSuchPortException);

      CChannelElement buildChannelOutput(in string input_port, inout CConnPolicy policy)
            raises(CNoCorbaTransport,CNoSuchPortException,CInvalidArgument);

      CChannelElement buildChannelInput(in string output_port, inout CConnPolicy policy)
            raises(CNoCorbaTransport,CNoSuchPortException,CInvalidArgument);

      boolean createConnection(in string local_port, in CDataFlowInterface remote_ports,
            in string remote_port, inout CConnPolicy policy)
            raises(CNoSuchPortException);

      boolean createSharedConnection(in string input_port, inout CConnPolicy policy)
            raises(CNoSuchPortException,CInvalidArgument);

      boolean removeConnection(in string local_port,
            in CDataFlowInterface remote_ports, in string remote_port)
            raises(CNoSuchPortException);

      boolean createStream(in string local_port, inout CConnPolicy policy)
            raises(CNoSuchPortException);

      void removeStream(in string local_port, in string stream_name)
            raises(CNoSuchPortException);
    };
  };
};
#endif