DataFlowInterface Interface Reference
[Component IDL and Corba Setup]

import "rtt/corba/DataFlow.idl";

List of all members.

---

Detailed Description

An interface to access the dataflow of a ControlTask object.

Data ports are exported as assignable expressions (Set/Get). Buffer ports are exported as buffer channels.

Definition at line 43 of file DataFlow.idl.

Public Types
enum	PortType { ReadPort, WritePort, ReadWritePort }
typedef sequence < string >	PortNames
Public Member Functions
PortNames	getPorts ()
	Returns the names of the ports of this component.
AssignableExpression	createDataChannel (in string port_name)
	Creates a data connection for an Orocos data port.
BufferChannel	createBufferChannel (in string port_name)
	Creates an bufferd channel for an Orocos port which will be used in a 'push' or 'pull' model.
Expression	createDataObject (in string port_name)
	Creates a read-only data object which represents the status of a Data or Buffer Channel connection.
PortType	getPortType (in string port_name)
	Check if a port will read from or write to a Channel.
string	getDataType (in string port_name)
	Get the type of data this port processes.
boolean	isConnected (in string port_name)
	Check if a port is already connected.

---

Member Enumeration Documentation

enum PortType

Enumerator:

ReadPort
WritePort
ReadWritePort

Definition at line 48 of file DataFlow.idl.

---

Member Function Documentation

AssignableExpression createDataChannel

(

in string

port_name

)

Creates a data connection for an Orocos data port.

You may use the returned AssignableExpression to write data to it or read data from it.

BufferChannel createBufferChannel

(

in string

port_name

)

Creates an bufferd channel for an Orocos port which will be used in a 'push' or 'pull' model.

You may use the returned BufferChannel to write data to it or read data from it.

Expression createDataObject

(

in string

port_name

)

Creates a read-only data object which represents the status of a Data or Buffer Channel connection.

For a DataChannel, it returns the current value, for a BufferChannel, it returns the value of the front() element. If the port is not connected, nill is returned.

boolean isConnected

(

in string

port_name

)

Check if a port is already connected.

If so, one can join in by using the create methods above. If not, the create methods above will setup a new connection.

---

The documentation for this interface was generated from the following file:

• rtt/corba/DataFlow.idl

---