RTT::ConnectionFactory< T > Class Template Reference

Builds Connections (buffers or data objects) between the ports of tasks. More...

#include <rtt/ConnectionFactory.hpp>

List of all members.

Public Member Functions
BufferConnection< T > *	createBuffer (int size, const T &initial_value=T(), ConnectionTypes::ConnectionType type=ConnectionTypes::lockfree)
	Create an empty Buffered data connection.
DataConnection< T > *	createDataObject (const T &initial_value=T(), ConnectionTypes::ConnectionType type=ConnectionTypes::lockfree)
	Create an empty unbuffered data connection.

---

Detailed Description

template<class T>
class RTT::ConnectionFactory< T >

Builds Connections (buffers or data objects) between the ports of tasks.

Parameters:

T

The contents type of the buffers or data objects.

Definition at line 58 of file ConnectionFactory.hpp.

---

Member Function Documentation

template<class T >

BufferConnection< T > * RTT::ConnectionFactory< T >::createBuffer	(	int	size,
		const T &	initial_value = T(),
		ConnectionTypes::ConnectionType	type = ConnectionTypes::lockfree
	)			[inline]

Create an empty Buffered data connection.

Parameters:

	size	The maximum capacity of the connnection's buffer
	initial_value	The initial value of all elements within the buffer. Use this parameter if the data uses dynamic memory or requires an initial state.
	type	The connection type: lock based or lock-free. The latter is highly advised.

Returns:

a new connection object

See also:

BufferInterface for a look at the internal buffer structure

ReadBufferPort, WriteBufferPort, BufferPort for ports to which this connection can be attached.

Definition at line 112 of file ConnectionFactory.hpp.

References RTT::ConnectionTypes::lockfree.

template<class T >

DataConnection< T > * RTT::ConnectionFactory< T >::createDataObject	(	const T &	initial_value = T(),
		ConnectionTypes::ConnectionType	type = ConnectionTypes::lockfree
	)			[inline]

Create an empty unbuffered data connection.

Parameters:

	initial_value	The initial value of all elements within the buffer. Use this parameter if the data uses dynamic memory or requires an initial state.
	type	The connection type: lock based or lock-free. The latter is highly advised.

Returns:

a new connection object

See also:

DataObjectInterface for a look at the internal data sharing structure

ReadDataPort, WriteDataPort for ports to which this connection can be attached.

Definition at line 126 of file ConnectionFactory.hpp.

References RTT::ConnectionTypes::lockfree.

Referenced by RTT::DataPort< T >::createConnection(), and RTT::WriteDataPort< T >::createConnection().

---

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

• rtt/ConnectionFactory.hpp