The base class of each OutputPort. More...

#include <rtt/base/OutputPortInterface.hpp>

Inheritance diagram for RTT::base::OutputPortInterface:

Public Member Functions
virtual bool	addConnection (internal::ConnID *port_id, ChannelElementBase::shared_ptr channel_input, ConnPolicy const &policy)
	Adds a new connection to this output port and initializes the connection if required by policy. More...

	OutputPortInterface (std::string const &name)

virtual	~OutputPortInterface ()

virtual bool	keepsLastWrittenValue () const =0
	Returns true if this port records the last written value. More...

virtual void	keepLastWrittenValue (bool new_flag)=0
	Change the setting for keeping the last written value. More...

virtual DataSourceBase::shared_ptr	getDataSource () const =0
	Returns a Data source that stores the last written value, or a null pointer if this port does not keep its last written value. More...

virtual void	disconnect ()
	Removes any connection that either go to or come from this port. More...

virtual bool	connected () const
	Returns true if there is at least one channel registered in this port's list of outputs. More...

virtual void	write (DataSourceBase::shared_ptr source)
	Write this port using the value stored in source. More...

bool	createDataConnection (InputPortInterface &sink, int lock_policy=ConnPolicy::LOCK_FREE)
	Connects this write port to the given read port, using a single-data policy with the given locking mechanism. More...

bool	createBufferConnection (InputPortInterface &sink, int size, int lock_policy=ConnPolicy::LOCK_FREE)
	Connects this write port to the given read port, using a buffered policy, with the buffer of the given size and the given locking mechanism. More...

bool	createConnection (InputPortInterface &sink)
	Connects this write port to the given read port, using as policy the default policy of the sink port. More...

virtual bool	createConnection (InputPortInterface &sink, ConnPolicy const &policy)=0
	Connects this write port to the given read port, using the given connection policy. More...

virtual bool	disconnect (PortInterface *port)
	Removes the channel that connects this port to `port`. More...

virtual bool	removeConnection (internal::ConnID *cid)
	Removes the connection associated with this channel, and the channel as well. More...

virtual bool	connectTo (PortInterface *other, ConnPolicy const &policy)
	Connects this port with other, using the given policy. More...

virtual bool	connectTo (PortInterface *other)
	Connects this port with other, using the default policy of the input. More...

virtual const internal::ConnectionManager *	getManager () const
	Returns the connection manager of this port (if any). More...

virtual internal::ConnID *	getPortID () const
	Returns the identity of this port in a ConnID object. More...

const std::string &	getName () const
	Get the name of this Port. More...

bool	setName (const std::string &name)
	Change the name of this unconnected Port. More...

const std::string &	getDescription () const
	Get the documentation of this port. More...

PortInterface &	doc (const std::string &desc)
	Set the documentation of this port. More...

virtual const types::TypeInfo *	getTypeInfo () const =0
	Returns the types::TypeInfo object for the port's type. More...

virtual bool	isLocal () const
	Returns true if this port is located on this process, and false otherwise. More...

virtual int	serverProtocol () const
	Returns the protocol over which this port can be accessed. More...

virtual PortInterface *	clone () const =0
	Create a local clone of this port with the same name. More...

virtual PortInterface *	antiClone () const =0
	Create a local clone of this port with the same name. More...

virtual Service *	createPortObject ()
	Create accessor Object for this Port, for addition to a TaskContext Object interface. More...

virtual bool	createStream (ConnPolicy const &policy)=0
	Creates a data stream from or to this port using connection-less transports. More...

void	setInterface (DataFlowInterface *iface)
	Once a port is added to a DataFlowInterface, it gets a pointer to that interface. More...

DataFlowInterface *	getInterface () const
	Returns the DataFlowInterface this port belongs to or null if it was not added to such an interface. More...

Protected Member Functions
virtual bool	connectionAdded (ChannelElementBase::shared_ptr channel_input, ConnPolicy const &policy)=0
	Upcall to OutputPort. More...

	OutputPortInterface (OutputPortInterface const &orig)

Protected Attributes
internal::ConnectionManager	cmanager

DataFlowInterface *	iface

Detailed Description

The base class of each OutputPort.

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

Definition at line 53 of file OutputPortInterface.hpp.

Constructor & Destructor Documentation

RTT::base::OutputPortInterface::OutputPortInterface ( OutputPortInterface const & orig )

protected

OutputPortInterface::OutputPortInterface ( std::string const & name )

Definition at line 50 of file OutputPortInterface.cpp.

OutputPortInterface::~OutputPortInterface ( )

virtual

Definition at line 53 of file OutputPortInterface.cpp.

References cmanager, and RTT::internal::ConnectionManager::disconnect().

Member Function Documentation

bool OutputPortInterface::addConnection	(	internal::ConnID *	port_id,
		ChannelElementBase::shared_ptr	channel_input,
		ConnPolicy const &	policy
	)

virtual

Adds a new connection to this output port and initializes the connection if required by policy.

Use with care. Allows you to add any arbitrary connection to this output port. It is your responsibility to do any further bookkeeping, such as informing the input that a new output has been added.

Implements RTT::base::PortInterface.

Reimplemented in RTT::corba::RemotePort< base::OutputPortInterface >.

Definition at line 72 of file OutputPortInterface.cpp.

References RTT::internal::ConnectionManager::addConnection(), cmanager, and connectionAdded().

Referenced by RTT::internal::ConnFactory::createAndCheckConnection(), RTT::internal::ConnFactory::createAndCheckStream(), and RTT::corba::CDataFlowInterface_i::deregisterChannel().

virtual PortInterface* RTT::base::PortInterface::antiClone ( ) const

pure virtualinherited

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.

virtual PortInterface* RTT::base::PortInterface::clone ( ) const

pure virtualinherited

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 OutputPortInterface::connected ( ) const

virtual

Returns true if there is at least one channel registered in this port's list of outputs.

Returns true if this port is connected.

Implements RTT::base::PortInterface.

Reimplemented in RTT::corba::RemotePort< base::OutputPortInterface >.

Definition at line 59 of file OutputPortInterface.cpp.

References cmanager, and RTT::internal::ConnectionManager::connected().

virtual bool RTT::base::OutputPortInterface::connectionAdded	(	ChannelElementBase::shared_ptr	channel_input,
		ConnPolicy const &	policy
	)

protectedpure virtual

Upcall to OutputPort.

Implemented in RTT::corba::RemotePort< base::OutputPortInterface >.

Referenced by addConnection().

bool OutputPortInterface::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 100 of file OutputPortInterface.cpp.

References createConnection().

bool OutputPortInterface::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 108 of file OutputPortInterface.cpp.

References createConnection().

bool OutputPortInterface::createBufferConnection	(	InputPortInterface &	sink,
		int	size,
		int	lock_policy = `ConnPolicy::LOCK_FREE`
	)

Connects this write port to the given read port, using a buffered policy, with the buffer of the given size and the given locking mechanism.

Definition at line 94 of file OutputPortInterface.cpp.

References RTT::ConnPolicy::buffer(), createConnection(), and RTT::base::InputPortInterface::getDefaultPolicy().

bool RTT::base::OutputPortInterface::createConnection ( InputPortInterface & sink )

Connects this write port to the given read port, using as policy the default policy of the sink port.

Referenced by RTT::OutputPort< T >::antiClone(), connectTo(), RTT::base::InputPortInterface::connectTo(), createBufferConnection(), createDataConnection(), and RTT::corba::CDataFlowInterface_i::deregisterChannel().

virtual bool RTT::base::OutputPortInterface::createConnection	(	InputPortInterface &	sink,
		ConnPolicy const &	policy
	)

pure virtual

Connects this write port to the given read port, using the given connection policy.

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

bool OutputPortInterface::createDataConnection	(	InputPortInterface &	sink,
		int	lock_policy = `ConnPolicy::LOCK_FREE`
	)

Connects this write port to the given read port, using a single-data policy with the given locking mechanism.

Definition at line 91 of file OutputPortInterface.cpp.

References createConnection(), and RTT::ConnPolicy::data().

Service * PortInterface::createPortObject ( )

virtualinherited

Create accessor Object for this Port, for addition to a TaskContext Object interface.

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

Definition at line 75 of file PortInterface.cpp.

References RTT::Service::addSynchronousOperation(), RTT::base::PortInterface::connected(), RTT::base::PortInterface::disconnect(), RTT::base::PortInterface::getName(), RTT::DataFlowInterface::getOwner(), and RTT::base::PortInterface::iface.

Referenced by RTT::InputPort< T >::createPortObject(), RTT::DataFlowInterface::createPortObject(), and RTT::OutputPort< T >::createPortObject().

virtual bool RTT::base::PortInterface::createStream ( ConnPolicy const & policy )

pure virtualinherited

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

policy The connection policy describing how the stream must be set up.

Implemented in RTT::OutputPort< T >, RTT::InputPort< T >, RTT::corba::RemotePort< base::InputPortInterface >, and RTT::corba::RemotePort< base::OutputPortInterface >.

Referenced by RTT::corba::CDataFlowInterface_i::deregisterChannel().

void OutputPortInterface::disconnect ( )

virtual

Removes any connection that either go to or come from this port.

Implements RTT::base::PortInterface.

Reimplemented in RTT::corba::RemotePort< base::OutputPortInterface >.

Definition at line 67 of file OutputPortInterface.cpp.

References cmanager, and RTT::internal::ConnectionManager::disconnect().

Referenced by RTT::internal::ConnFactory::createAndCheckConnection().

bool OutputPortInterface::disconnect ( PortInterface * port )

virtual

Removes the channel that connects this port to port.

Implements RTT::base::PortInterface.

Reimplemented in RTT::corba::RemoteOutputPort.

Definition at line 62 of file OutputPortInterface.cpp.

References cmanager, and RTT::internal::ConnectionManager::disconnect().

PortInterface & PortInterface::doc ( const std::string & desc )

inherited

Set the documentation of this port.

Parameters

desc	The description of the port

Returns: a reference to this object.

Definition at line 60 of file PortInterface.cpp.

References RTT::base::PortInterface::iface, and RTT::DataFlowInterface::setPortDescription().

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

virtual DataSourceBase::shared_ptr RTT::base::OutputPortInterface::getDataSource ( ) const

pure virtual

Returns a Data source that stores the last written value, or a null pointer if this port does not keep its last written value.

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

Referenced by RTT::internal::ConnFactory::createAndCheckOutOfBandConnection(), and RTT::internal::ConnFactory::createAndCheckStream().

const std::string& RTT::base::PortInterface::getDescription ( ) const

inlineinherited

Get the documentation of this port.

Returns: A description.

Definition at line 91 of file PortInterface.hpp.

DataFlowInterface * PortInterface::getInterface ( ) const

inherited

Returns the DataFlowInterface this port belongs to or null if it was not added to such an interface.

Definition at line 95 of file PortInterface.cpp.

References RTT::base::PortInterface::iface.

Referenced by RTT::corba::RemoteInputPort::buildRemoteChannelOutput(), RTT::corba::RemoteOutputPort::createConnection(), and RTT::mqueue::MQSendRecv::setupStream().

virtual const internal::ConnectionManager* RTT::base::OutputPortInterface::getManager ( ) const

inlinevirtual

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 142 of file OutputPortInterface.hpp.

const std::string& RTT::base::PortInterface::getName ( ) const

inlineinherited

Get the name of this Port.

Definition at line 77 of file PortInterface.hpp.

Referenced by RTT::DataFlowInterface::addEventPort(), RTT::DataFlowInterface::addLocalEventPort(), RTT::DataFlowInterface::addLocalPort(), RTT::DataFlowInterface::addPort(), RTT::corba::RemoteOutputPort::antiClone(), RTT::corba::RemoteInputPort::antiClone(), RTT::InputPort< T >::antiClone(), RTT::OutputPort< T >::antiClone(), RTT::corba::CorbaFallBackProtocol::buildChannelInput(), RTT::corba::CorbaFallBackProtocol::buildChannelOutput(), RTT::corba::RemoteInputPort::buildRemoteChannelOutput(), RTT::corba::RemoteInputPort::channelReady(), RTT::corba::RemoteOutputPort::clone(), RTT::corba::RemoteInputPort::clone(), RTT::InputPort< T >::clone(), RTT::OutputPort< T >::clone(), RTT::TaskContext::connectPorts(), RTT::base::InputPortInterface::connectTo(), RTT::internal::ConnFactory::createAndCheckConnection(), RTT::internal::ConnFactory::createAndCheckOutOfBandConnection(), RTT::internal::ConnFactory::createAndCheckStream(), RTT::corba::RemoteOutputPort::createConnection(), RTT::internal::ConnFactory::createConnection(), RTT::base::PortInterface::createPortObject(), RTT::internal::ConnFactory::createRemoteConnection(), RTT::corba::CorbaFallBackProtocol::createStream(), RTT::corba::CDataFlowInterface_i::deregisterChannel(), RTT::corba::RemoteOutputPort::disconnect(), and RTT::mqueue::MQSendRecv::setupStream().

ConnID * PortInterface::getPortID ( ) const

virtualinherited

Returns the identity of this port in a ConnID object.

Reimplemented in RTT::corba::RemotePort< base::InputPortInterface >, and RTT::corba::RemotePort< base::OutputPortInterface >.

Definition at line 72 of file PortInterface.cpp.

Referenced by RTT::internal::ConnFactory::createAndCheckConnection(), RTT::internal::ConnFactory::createConnection(), and RTT::internal::ConnectionManager::disconnect().

virtual const types::TypeInfo* RTT::base::PortInterface::getTypeInfo ( ) const

pure virtualinherited

Returns the types::TypeInfo object for the port's type.

Implemented in RTT::OutputPort< T >, RTT::InputPort< T >, RTT::corba::RemotePort< base::InputPortInterface >, and RTT::corba::RemotePort< base::OutputPortInterface >.

Referenced by RTT::corba::CDataFlowInterface_i::_default_POA(), RTT::internal::ConnFactory::createAndCheckOutOfBandConnection(), RTT::internal::ConnFactory::createAndCheckStream(), RTT::internal::ConnFactory::createRemoteConnection(), and RTT::corba::CDataFlowInterface_i::deregisterChannel().

bool PortInterface::isLocal ( ) const

virtualinherited

Returns true if this port is located on this process, and false otherwise.

Definition at line 67 of file PortInterface.cpp.

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

Referenced by RTT::internal::ConnFactory::createAndCheckOutOfBandConnection(), and RTT::internal::ConnFactory::createConnection().

virtual void RTT::base::OutputPortInterface::keepLastWrittenValue ( bool new_flag )

pure virtual

Change the setting for keeping the last written value.

Setting this to false will clear up any unneeded storage. If set, this port can initialize new connections with a data sample and allows real-time data transport of dynamically sized objects over its newly created connections.