#include <InputPortInterface.hpp>

Inheritance diagram for RTT::base::InputPortInterface:

[legend]

Public Member Functions
virtual bool	addConnection (internal::ConnID *port_id, ChannelElementBase::shared_ptr channel, ConnPolicy const &policy)

virtual base::ChannelElementBase::shared_ptr	buildRemoteChannelOutput (base::OutputPortInterface &output_port, types::TypeInfo const *type_info, base::InputPortInterface &input, const ConnPolicy &policy)

virtual void	clear ()=0

virtual bool	connected () const

virtual bool	connectTo (PortInterface *other, ConnPolicy const &policy)

virtual bool	connectTo (PortInterface *other)

virtual bool	createConnection (internal::SharedConnectionBase::shared_ptr shared_connection, ConnPolicy const &policy=ConnPolicy())

virtual void	disconnect ()

virtual bool	disconnect (PortInterface *port)

virtual DataSourceBase *	getDataSource ()=0

ConnPolicy	getDefaultPolicy () const

	InputPortInterface (std::string const &name, ConnPolicy const &default_policy=ConnPolicy())

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

void	signalInterface (bool true_false)

virtual	~InputPortInterface ()

Public Member Functions inherited from RTT::base::PortInterface
virtual PortInterface *	antiClone () const =0

virtual PortInterface *	clone () const =0

virtual bool	connectedTo (PortInterface *port)

virtual Service *	createPortObject ()

virtual bool	createStream (ConnPolicy const &policy)=0

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

const std::string &	getDescription () const

virtual ChannelElementBase *	getEndpoint () const =0

const std::string &	getFullName () const

DataFlowInterface *	getInterface () const

virtual internal::ConnectionManager *	getManager ()

const std::string &	getName () const

virtual internal::ConnID *	getPortID () const

virtual internal::SharedConnectionBase::shared_ptr	getSharedConnection () const

virtual const types::TypeInfo *	getTypeInfo () const =0

virtual bool	isLocal () const

virtual bool	removeConnection (internal::ConnID *cid)

virtual int	serverProtocol () const

void	setInterface (DataFlowInterface *iface)

bool	setName (const std::string &name)

virtual	~PortInterface ()

Protected Member Functions
	InputPortInterface (const InputPortInterface &orig)

void	signal ()

void	traceRead (RTT::FlowStatus status)

Protected Member Functions inherited from RTT::base::PortInterface
	PortInterface (const std::string &name)

Protected Attributes
ConnPolicy	default_policy

bool	msignal_interface

Protected Attributes inherited from RTT::base::PortInterface
internal::ConnectionManager	cmanager

os::MutexRecursive	connection_lock

DataFlowInterface *	iface

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.

Constructor & Destructor Documentation

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

protected

RTT::base::InputPortInterface::InputPortInterface	(	std::string const &	name,
		ConnPolicy const &	default_policy = `ConnPolicy()`
	)

InputPortInterface::~InputPortInterface ( )

virtual

Definition at line 64 of file InputPortInterface.cpp.

Member Function Documentation

bool InputPortInterface::addConnection	(	internal::ConnID *	cid,
		ChannelElementBase::shared_ptr	channel,
		ConnPolicy const &	policy
	)

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, and RTT::corba::RemotePort< base::InputPortInterface >.

Definition at line 101 of file InputPortInterface.cpp.

base::ChannelElementBase::shared_ptr InputPortInterface::buildRemoteChannelOutput	(	base::OutputPortInterface &	output_port,
		types::TypeInfo const *	type_info,
		base::InputPortInterface &	input,
		const ConnPolicy &	policy
	)

virtual

This method is analoguous to the static ConnFactory::buildChannelOutput. It is provided for remote connection building: for these connections, no template can be used and therefore the connection setup should be done based on the types::TypeInfo object

Reimplemented in RTT::corba::RemoteInputPort.

Definition at line 149 of file InputPortInterface.cpp.

virtual void RTT::base::InputPortInterface::clear ( )

pure virtual

Clears the connection. After call to read() will return false after clear() has been called

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

bool InputPortInterface::connected ( ) const

virtual

Returns true if this port is connected

Implements RTT::base::PortInterface.

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

Definition at line 124 of file InputPortInterface.cpp.

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 86 of file InputPortInterface.cpp.

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.