#include </home/sspr/src/www/orocos-1.0/export/build/orocos-rtt-1.2.2/build/rtt/BufferPort.hpp>
Inheritance diagram for ReadBufferPort:
Use connection() to access the buffer. If the port is not connected, connection() returns null.
| T | The type of the data of the buffer. |
Public Types | |
| enum | PortType { ReadPort, WritePort, ReadWritePort } |
| This enum classifies if a port is inbound outbound or both. | |
Public Member Functions | |
| ReadBufferPort (const std::string &name) | |
| Construct an unconnected Port to a readable buffer. | |
| bool | Pop (T &data) |
| Pop a value from the buffer of this Port's connection. | |
| T | front () const |
| Get the next value to be Pop()'ed, or the default value if empty. | |
| void | clear () |
| Clears all contents of this buffer. | |
| BufferBase::size_type | size () const |
| Returns the actual number of items that are stored in the buffer. | |
| BufferBase::size_type | capacity () const |
| Returns the maximum number of items that can be stored in the buffer. | |
| bool | empty () const |
| Check if this buffer is empty. | |
| bool | full () const |
| Check if this buffer is full. | |
| virtual PortType | getPortType () const |
| Get the PortType of this port. | |
| ReadBufferPort & | operator= (BufferInterface< T > *impl) |
| Provide a new implementation for the connection of this port. | |
| bool | connected () const |
| Inspect if this Port is currently connected with another Port. | |
| virtual bool | connect (typename ReadConnectionInterface< T >::shared_ptr conn) |
| Connect a readable buffer to this Port. | |
| void | disconnect () |
| No longer participate in a connection. | |
| bool | connectTo (ConnectionInterface::shared_ptr other) |
| Connect this port to a Connection. | |
| virtual ReadInterface< T > * | read () const |
| Get the buffer to read from. | |
| virtual ConnectionInterface::shared_ptr | connection () const |
| Returns the connection in which this Port currently participates. | |
| virtual PortInterface * | clone () const |
| Create a clone of this port with the same name. | |
| virtual PortInterface * | antiClone () const |
| The anti-Clone of a ReadBufferPort is a WriteBufferPort with prefered buffer size '1'. | |
| virtual TaskObject * | createPortObject () |
| Create accessor Object for this Port, for addition to a TaskContext Object interface. | |
| const std::string & | getName () const |
| Get the name of this Port. | |
| bool | setName (const std::string &name) |
| Change the name of this unconnected Port. | |
| bool | ready () const |
| Returns true if this Port is ready to be used. | |
| virtual bool | connectTo (PortInterface *other) |
| Connect to another Port and create a new connection if necessary. | |
| virtual ConnectionInterface::shared_ptr | createConnection (PortInterface *other, ConnectionTypes::ConnectionType con_type=ConnectionTypes::lockfree) |
| Create a connection object from this port to another port. | |
| virtual ConnectionInterface::shared_ptr | createConnection (ConnectionTypes::ConnectionType con_type=ConnectionTypes::lockfree) |
| Create a new connection object to which this port is subscribed. | |
Protected Attributes | |
|
ReadConnectionInterface< T >::shared_ptr | mconn |
| std::string | portname |
| ReadBufferPort | ( | const std::string & | name | ) | [inline] |
Construct an unconnected Port to a readable buffer.
| name | The name of this port. |
| bool Pop | ( | T & | data | ) | [inline] |
Pop a value from the buffer of this Port's connection.
| data | The location where to store the popped value. |
| this->read()->Pop(data) | if this->connected() | |
| false | if !this->connected() |
| BufferBase::size_type size | ( | ) | const [inline] |
Returns the actual number of items that are stored in the buffer.
Reimplemented in BufferPort.
| BufferBase::size_type capacity | ( | ) | const [inline] |
Returns the maximum number of items that can be stored in the buffer.
Reimplemented in BufferPort.
| bool empty | ( | ) | const [inline] |
| bool full | ( | ) | const [inline] |
| ReadBufferPort< T > & operator= | ( | BufferInterface< T > * | impl | ) |
Provide a new implementation for the connection of this port.
If this port is not connected, a new connection is created.
Reimplemented in BufferPort.
| bool connectTo | ( | ConnectionInterface::shared_ptr | other | ) | [inline, virtual] |
Connect this port to a Connection.
If the connection is in the connected() state, this port will participate in that connection, otherwise, the port will become connected once conn becomes connected().
Implements PortInterface.
Reimplemented in BufferPort.
| virtual ReadInterface<T>* read | ( | ) | const [inline, virtual] |
Get the buffer to read from.
The Task may use this to read from a Buffer connected to this port.
| virtual ConnectionInterface::shared_ptr connection | ( | ) | const [inline, virtual] |
Returns the connection in which this Port currently participates.
It is possible that this port is part of a dormant connection, ( the connection object is not in the connected() state), in that case this method will return null, until the dormant connection becomes connected().
| null | if not connected to another Port. |
Implements PortInterface.
Reimplemented in BufferPort.
| bool setName | ( | const std::string & | name | ) | [inherited] |
Change the name of this unconnected Port.
One can only change the name when it is not yet connected.
| true | if !this->connected(), the name has changed. | |
| false | if this->connected(), the name has not been changed. |
| bool ready | ( | ) | const [inherited] |
Returns true if this Port is ready to be used.
Identical to connected().
| virtual bool connectTo | ( | PortInterface * | other | ) | [virtual, inherited] |
Connect to another Port and create a new connection if necessary.
1.5.1