Represents the basic channel element interface for reading, writing and disconnecting a channel. More...
import"rtt/transports/corba/DataFlow.idl";
Public Member Functions | |
| boolean | inputReady () |
| Used during connection setup to pass on an example of the data. More... | |
| boolean | channelReady (in CConnPolicy cp) |
| Checks if the connection channel elements are ready for a given input port. More... | |
| CFlowStatus | read (out any sample, in boolean copy_old_data) |
| Reads from this Channel Element. More... | |
| CWriteStatus | write (in any sample) |
| Writes into this Channel Element. More... | |
| oneway void | writeOneway (in any sample) |
| Writes into this Channel Element (one-way) More... | |
| void | disconnect () |
| Disconnect and dispose this object. More... | |
Detailed Description
Represents the basic channel element interface for reading, writing and disconnecting a channel.
Use this interface in case you want to communicate with an Orocos component's port from a non-Orocos application.
Definition at line 39 of file DataFlow.idl.
Member Function Documentation
| boolean RTT::corba::CChannelElement::channelReady | ( | in CConnPolicy | cp | ) |
Checks if the connection channel elements are ready for a given input port.
This is typically called by the createConnection setup logic to see if the input side agrees with the connection and can use it. For example, the input port can use this opportunity to check the
- Exceptions
-
CNoSuchPortException if input_port is not an input port or not present in this interface.
- Returns
- false if the connection could not be used.
| void RTT::corba::CChannelElement::disconnect | ( | ) |
Disconnect and dispose this object.
You may no longer use this object after calling this method.
| boolean RTT::corba::CChannelElement::inputReady | ( | ) |
Used during connection setup to pass on an example of the data.
This is done behind the scenes by the connection logic.
- Note
- : not implemented yet. Called by the input port to indicate that it's ready to be used. This is done behind the scenes by the connection logic.
| CFlowStatus RTT::corba::CChannelElement::read | ( | out any | sample, |
| in boolean | copy_old_data | ||
| ) |
Reads from this Channel Element.
| CWriteStatus RTT::corba::CChannelElement::write | ( | in any | sample | ) |
Writes into this Channel Element.
- Returns
- NotConnected if the channel became invalid
| oneway void RTT::corba::CChannelElement::writeOneway | ( | in any | sample | ) |
Writes into this Channel Element (one-way)
The documentation for this interface was generated from the following file:
- rtt/transports/corba/DataFlow.idl
