Orocos Real-Time Toolkit  2.5.0
Public Member Functions | Protected Member Functions | Protected Attributes
RTT::base::InputPortInterface Class Reference

The base class of the InputPort. More...

#include <rtt/base/InputPortInterface.hpp>

Inheritance diagram for RTT::base::InputPortInterface:
RTT::base::PortInterface RTT::corba::RemotePort< base::InputPortInterface > RTT::InputPort< T > RTT::corba::RemoteInputPort

List of all members.

Public Member Functions

 InputPortInterface (std::string const &name, ConnPolicy const &default_policy=ConnPolicy())
void clear ()
 Clears the connection.
ConnPolicy getDefaultPolicy () const
virtual bool addConnection (internal::ConnID *port_id, ChannelElementBase::shared_ptr channel_input, ConnPolicy const &policy=ConnPolicy())
 Adds a user created connection to this port.
virtual bool removeConnection (internal::ConnID *cid)
 Removes the input channel.
virtual DataSourceBasegetDataSource ()=0
 Returns a DataSourceBase interface to read this port.
virtual FlowStatus read (DataSourceBase::shared_ptr source, bool copy_old_data=true)
 Reads the port and updates the value hold by the given data source.
virtual void disconnect ()
 Removes any connection that either go to or come from this port *and* removes all callbacks and cleans up the NewDataOnPortEvent.
virtual bool disconnect (PortInterface *port)
 Removes the channel that connects this port to port.
virtual bool connected () const
 Returns true if this port is connected.
virtual bool channelReady (base::ChannelElementBase::shared_ptr channel)
 Call this to indicate that the connection leading to this port is ready to use.
void signalInterface (bool true_false)
 When called with true, will signal the DataFlowInterface when new data is available.
virtual bool connectTo (PortInterface *other, ConnPolicy const &policy)
 Connects this port with other, using the given policy.
virtual bool connectTo (PortInterface *other)
 Connects this port with other, using the default policy of the input.
virtual const
internal::ConnectionManager
getManager () const
 Returns the connection manager of this port (if any).
virtual internal::ConnIDgetPortID () const
 Returns the identity of this port in a ConnID object.
const std::string & getName () const
 Get the name of this Port.
bool setName (const std::string &name)
 Change the name of this unconnected Port.
const std::string & getDescription () const
 Get the documentation of this port.
PortInterfacedoc (const std::string &desc)
 Set the documentation of this port.
virtual const types::TypeInfogetTypeInfo () const =0
 Returns the types::TypeInfo object for the port's type.
virtual internal::ConnFactorygetConnFactory ()
 The ChannelFactory object that allows to build the ChannelElement chain needed to build connections to or from this port.
virtual bool isLocal () const
 Returns true if this port is located on this process, and false otherwise.
virtual int serverProtocol () const
 Returns the protocol over which this port can be accessed.
virtual PortInterfaceclone () const =0
 Create a local clone of this port with the same name.
virtual PortInterfaceantiClone () const =0
 Create a local clone of this port with the same name.
virtual ServicecreatePortObject ()
 Create accessor Object for this Port, for addition to a TaskContext Object interface.
virtual bool createStream (ConnPolicy const &policy)=0
 Creates a data stream from or to this port using connection-less transports.
void setInterface (DataFlowInterface *iface)
 Once a port is added to a DataFlowInterface, it gets a pointer to that interface.
DataFlowInterfacegetInterface () const
 Returns the DataFlowInterface this port belongs to or null if it was not added to such an interface.

Protected Member Functions

void signal ()
 The ConnOutputEndpoint signals that new data is available.
 InputPortInterface (const InputPortInterface &orig)

Protected Attributes

internal::ConnectionManager cmanager
ConnPolicy default_policy
bool msignal_interface
DataFlowInterfaceiface

Detailed Description

The base class of the InputPort.

It contains the connection management code, which is independent of the actual data being transmitted.

Definition at line 60 of file InputPortInterface.hpp.


Member Function Documentation

bool InputPortInterface::addConnection ( internal::ConnID cid,
ChannelElementBase::shared_ptr  channel_input,
ConnPolicy const &  policy = ConnPolicy() 
) [virtual]

Adds a user created connection to this port.

This is an advanced method, prefer to use connectTo and createStream.

Implements RTT::base::PortInterface.

Reimplemented in RTT::corba::RemoteInputPort.

Definition at line 99 of file InputPortInterface.cpp.

References RTT::internal::ConnectionManager::addConnection().

virtual PortInterface* RTT::base::PortInterface::antiClone ( ) const [pure virtual, inherited]

Create a local clone of this port with the same name.

If this port is a local port, this is an object of the inverse direction (read for write and write for read), and same name. If this object is a remote port, then it is a local port of the inverse direction and with the same name.

Implemented in RTT::OutputPort< T >, RTT::InputPort< T >, RTT::corba::RemoteInputPort, and RTT::corba::RemoteOutputPort.

bool InputPortInterface::channelReady ( base::ChannelElementBase::shared_ptr  channel) [virtual]

Call this to indicate that the connection leading to this port is ready to use.

The input port will check its channel elements by sending an inputReady() message. If this succeeds, this function returns true and the input port is ready to use (this->connected() == true). If sending inputReady() returns failure, this method returns false and the connection is aborted (this->connected() == false).

Reimplemented in RTT::corba::RemoteInputPort.

Definition at line 106 of file InputPortInterface.cpp.

Clears the connection.

After call to read() will return false after clear() has been called

Definition at line 145 of file InputPortInterface.cpp.

References RTT::internal::ConnectionManager::clear().

virtual PortInterface* RTT::base::PortInterface::clone ( ) const [pure virtual, inherited]

Create a local clone of this port with the same name.

If this port is a local port, this is an object of the same type and same name. If this object is a remote port, then it is a local port of the same type and same name.

Implemented in RTT::OutputPort< T >, RTT::InputPort< T >, RTT::corba::RemoteInputPort, and RTT::corba::RemoteOutputPort.

bool InputPortInterface::connectTo ( PortInterface other,
ConnPolicy const &  policy 
) [virtual]

Connects this port with other, using the given policy.

Unlike OutputPortInterface::createConnection, other can be the write port and this the read port.

Returns:
true on success, false on failure

Implements RTT::base::PortInterface.

Definition at line 84 of file InputPortInterface.cpp.

References RTT::base::OutputPortInterface::createConnection(), and RTT::base::PortInterface::getName().

Referenced by connectTo().

bool InputPortInterface::connectTo ( PortInterface other) [virtual]

Connects this port with other, using the default policy of the input.

Unlike OutputPortInterface::createConnection, other can be the write port and this the read port.

Returns:
true on success, false on failure

Implements RTT::base::PortInterface.

Definition at line 94 of file InputPortInterface.cpp.

References connectTo().

virtual bool RTT::base::PortInterface::createStream ( ConnPolicy const &  policy) [pure virtual, inherited]

Creates a data stream from or to this port using connection-less transports.

Typically, policy.transport and policy.name_id must be properly filled in such that the data stream can be set up and input and output port can find each other. You need to call this method on two ports (input and output) using the same transport and (probably) same name_id.

Parameters:
policyThe connection policy describing how the stream must be set up.

Implemented in RTT::OutputPort< T >, and RTT::InputPort< T >.

bool InputPortInterface::disconnect ( PortInterface port) [virtual]

Removes the channel that connects this port to port.

All other ports or callbacks remain unaffected.

Implements RTT::base::PortInterface.

Definition at line 155 of file InputPortInterface.cpp.

References RTT::internal::ConnectionManager::disconnect().

PortInterface & PortInterface::doc ( const std::string &  desc) [inherited]

Set the documentation of this port.

Parameters:
descThe description of the port
Returns:
a reference to this object.

Definition at line 60 of file PortInterface.cpp.

References RTT::DataFlowInterface::setPortDescription().

Referenced by RTT::InputPort< T >::createPortObject().

Returns a DataSourceBase interface to read this port.

The returned data source is always the same object and will be destroyed when the port is destroyed.

Implemented in RTT::InputPort< T >, and RTT::corba::RemoteInputPort.

const std::string& RTT::base::PortInterface::getDescription ( ) const [inline, inherited]

Get the documentation of this port.

Returns:
A description.

Definition at line 91 of file PortInterface.hpp.

virtual const internal::ConnectionManager* RTT::base::InputPortInterface::getManager ( ) const [inline, virtual]

Returns the connection manager of this port (if any).

This method provides access to the internals of this port in order to allow connection introspection.

Returns:
null if no such manager is available, or the manager otherwise.
See also:
ConnectionManager::getChannels() for a list of all connections of this port.

Implements RTT::base::PortInterface.

Definition at line 160 of file InputPortInterface.hpp.

FlowStatus InputPortInterface::read ( DataSourceBase::shared_ptr  source,
bool  copy_old_data = true 
) [virtual]

Reads the port and updates the value hold by the given data source.

This is only valid for local ports.

source has to be an assignable data source

Reimplemented in RTT::InputPort< T >.

Definition at line 139 of file InputPortInterface.cpp.

Removes the input channel.

Returns true if the provided channel was actually a channel of this port, and false otherwise.

You should usually not use this directly. Use disconnect() instead.

Implements RTT::base::PortInterface.

Definition at line 123 of file InputPortInterface.cpp.

Referenced by RTT::internal::ConnFactory::createStream(), and RTT::internal::ConnOutputEndpoint< T >::disconnect().

void PortInterface::setInterface ( DataFlowInterface iface) [inherited]

Once a port is added to a DataFlowInterface, it gets a pointer to that interface.

This allows advanced ports to track back to which component they belong.

Definition at line 92 of file PortInterface.cpp.

Referenced by RTT::DataFlowInterface::addLocalPort().

bool PortInterface::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.

Return values:
trueif !this->connected(), the name has changed.
falseif this->connected(), the name has not been changed.

Definition at line 51 of file PortInterface.cpp.

References RTT::base::PortInterface::connected().

Referenced by RTT::DataFlowInterface::addEventPort(), RTT::TaskContext::addEventPort(), RTT::DataFlowInterface::addPort(), and RTT::TaskContext::addPort().


The documentation for this class was generated from the following files: