Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute. More...

Namespaces
	base

	corba

	detail

	dev

	extras

	internal

	marsh

	mqueue

	os
	OS Abstractions such as Mutexes, Semaphores and Threads.

	plugin

	scripting

	types

Classes
class	Activity
	An Activity executes a RunnableInterface object in a (periodic) thread. More...

class	Alias

struct	ArgumentDescription
	Description of one Argument of a Command. More...

class	Attribute

class	CleanupHandle

class	CmdFunctionWrapper

class	ComponentFactories

class	ComponentFactoryLoader

class	ComponentLoader

class	ConfigurationInterface
	A class for keeping track of Attribute, Constant and Property objects of a TaskContext. It allows plugins and remote components to browse the attributes and properties of a TaskContext. More...

class	ConnPolicy

class	Constant

class	DataFlowInterface

class	ExecutionEngine

struct	FakeAnalogDevice

class	FakeDigitalDevice

class	file_parse_exception

struct	finder

struct	get_capacity

struct	get_size

class	Handle
	The Handle holds the information, and allows manipulation, of a connection between a internal::Signal Handler function and the Signal itself. More...

class	InputPort

struct	invalid_handle_exception

class	Logger

class	Marshalling

struct	name_not_found_exception

struct	no_asynchronous_operation_exception

struct	non_lvalue_args_exception

class	Operation

class	OperationCaller

class	OperationInterface
	Holds all exported operations of a component and is able to produce callers for these operations. More...

class	OperationInterfacePart

class	OutputPort

class	parse_exception

class	Property
	A property represents a named value of any type with a description. More...

class	PropertyBag
	A container for holding references to properties. More...

struct	RemoveMsg

class	ScopedHandle

class	Scripting

class	SendHandle
	The SendHandle is used to collect the result values of an asynchronous invocation. The template argument Signature must have the same type as the method being invoked. More...

class	Service

class	ServiceRequester

class	TaskContext

class	TriggerSlaveActivity

struct	wrong_number_of_args_exception

struct	wrong_types_of_args_exception

Typedefs
typedef TaskContext (	ComponentLoaderSignature) (std::string instance_name)

typedef std::map< std::string, ComponentLoaderSignature >	FactoryMap

typedef long	msecs

typedef long long	nsecs

typedef long long	psecs

typedef std::basic_ostringstream< char, std::char_traits< char >, RTT::os::rt_allocator< char > >	rt_ostringstream
	Real-time allocatable, dynamically-size output string stream. More...

typedef std::basic_string< char, std::char_traits< char >, RTT::os::rt_allocator< char > >	rt_string
	Real-time allocatable, dynamically-sized string. More...

typedef double	Seconds

typedef long	secs

typedef boost::shared_ptr< Service >	ServicePtr

typedef long	usecs

Enumerations
enum	BufferPolicy { UnspecifiedBufferPolicy, PerConnection, PerInputPort, PerOutputPort, Shared }

enum	ExecutionThread { OwnThread, ClientThread }

enum	FlowStatus { NoData = 0, OldData = 1, NewData = 2 }

enum	LoggerLevel { Never = 0, Fatal, Critical, Error, Warning, Info, Debug, RealTime }

enum	SendStatus { CollectFailure = -2, SendFailure = -1, SendNotReady = 0, SendSuccess = 1 }

enum	WriteStatus { WriteSuccess = 0, WriteFailure = 1, NotConnected = 2 }

Functions
bool	connectPeers (TaskContext A, TaskContext B)

bool	connectPorts (TaskContext A, TaskContext B)

bool	copyProperties (PropertyBag &target, const PropertyBag &source)

void	deleteProperties (PropertyBag &target)

void	deletePropertyBag (PropertyBag &target)

static Logger::LogFunction	endlog ()

static Logger::LogFunction	endlog (LoggerLevel ll)

PropertyBase *	findProperty (const PropertyBag &bag, const std::string &nameSequence, const std::string &separator)

void	flattenPropertyBag (PropertyBag &target, const std::string &separator)

static Logger::LogFunction	flushlog ()

vector< string >	listProperties (const PropertyBag &source, const std::string &separator)

vector< string >	listPropertyDescriptions (const PropertyBag &source, const std::string &separator)

static Logger &	log ()

static Logger &	log (LoggerLevel ll)

std::string	makeString (const RTT::rt_string &str)
	convert from real-time string to std::string More...

nsecs	msecs_to_nsecs (const msecs ms)

psecs	msecs_to_psecs (const msecs ms)

Seconds	msecs_to_Seconds (const msecs ns)

usecs	msecs_to_usecs (const msecs ms)

static Logger::LogFunction	nlog ()

psecs	nsecs_to_psecs (const nsecs ns)

Seconds	nsecs_to_Seconds (const nsecs ns)

std::ostream &	operator<< (std::ostream &os, const BufferPolicy &bp)

std::ostream &	operator<< (std::ostream &os, FlowStatus fs)

std::ostream &	operator<< (std::ostream &os, SendStatus fs)

std::ostream &	operator<< (std::ostream &os, WriteStatus fs)

std::ostream &	operator<< (std::ostream &os, const ConnPolicy &cp)

std::ostream &	operator<< (std::ostream &os, const PropertyBag &bag)

template<typename T >
std::ostream &	operator<< (std::ostream &os, Property< T > &p)

bool	operator== (const PropertyBag &a, const PropertyBag &b)

static bool	operator== (const ConnPolicy &, const ConnPolicy &)

std::istream &	operator>> (std::istream &is, BufferPolicy &bp)

std::istream &	operator>> (std::istream &is, FlowStatus &fs)

std::istream &	operator>> (std::istream &is, SendStatus &fs)

std::istream &	operator>> (std::istream &is, WriteStatus &fs)

std::istream &	operator>> (std::istream &is, PropertyBag &bag)

OperatorRepository::shared_ptr	operators ()

Seconds	psecs_to_Seconds (const psecs ps)

bool	refreshProperties (const PropertyBag &target, const PropertyBag &source, bool allprops)

bool	refreshProperty (const PropertyBag &target, const PropertyBase &source)

bool	refreshProperty (PropertyBag &target, const PropertyBag &source, const std::string &name, const std::string &separator)

bool	removeProperty (PropertyBag &bag, const std::string &path, const std::string &separator)

msecs	Seconds_to_msecs (const Seconds s)

nsecs	Seconds_to_nsecs (const Seconds s)

psecs	Seconds_to_psecs (const Seconds s)

usecs	Seconds_to_usecs (const Seconds s)

msecs	secs_to_msecs (const secs s)

nsecs	secs_to_nsecs (const secs s)

psecs	secs_to_psecs (const secs s)

usecs	secs_to_usecs (const secs s)

bool	storeProperty (PropertyBag &bag, const std::string &path, base::PropertyBase *item, const std::string &separator)

bool	updateOrRefreshProperty (PropertyBase source, PropertyBase target, bool update)

bool	updateProperties (PropertyBag &target, const PropertyBag &source)

bool	updateProperty (PropertyBag &target, const PropertyBag &source, const std::string &name, const std::string &separator)

nsecs	usecs_to_nsecs (const usecs us)

psecs	usecs_to_psecs (const usecs us)

Seconds	usecs_to_Seconds (const usecs ns)

Variables
char const *	default_comp_path_build

const long	MSECS_IN_SECS = 1000

const long	NSECS_IN_MSECS = 1000 * USECS_IN_MSECS

const long	NSECS_IN_SECS = 1000 * USECS_IN_SECS

const long	NSECS_IN_USECS = 1000

const long	PSECS_IN_MSECS = 1000 * NSECS_IN_MSECS

const long	PSECS_IN_NSECS = 1000

const long long	PSECS_IN_SECS = 1000LL * NSECS_IN_SECS

const long	PSECS_IN_USECS = 1000 * NSECS_IN_USECS

static std::vector< TransportPlugin * >	Transports

static std::vector< TypekitPlugin * >	Typekits

const long	USECS_IN_MSECS = 1000

const long	USECS_IN_SECS = 1000 * MSECS_IN_SECS

Detailed Description

Contains TaskContext, Activity, OperationCaller, Operation, Property, InputPort, OutputPort, Attribute.

The Real-Time Toolkit is documented in The Orocos Real-Time Toolkit Online Manual

Typedef Documentation

typedef TaskContext*(* RTT::ComponentLoaderSignature) (std::string instance_name)

This signature defines how a component can be instantiated.

Definition at line 61 of file Component.hpp.

typedef std::map<std::string,ComponentLoaderSignature> RTT::FactoryMap

Definition at line 62 of file Component.hpp.

typedef long RTT::msecs

milliseconds as a signed long.

Definition at line 61 of file os/Time.hpp.

typedef long long RTT::nsecs

nanoseconds as a signed long long.

Definition at line 69 of file os/Time.hpp.

typedef long long RTT::psecs

picoseconds as a signed long long

Definition at line 73 of file os/Time.hpp.

typedef std::basic_ostringstream<char, std::char_traits<char>, RTT::os::rt_allocator<char> > RTT::rt_ostringstream

Real-time allocatable, dynamically-size output string stream.

Definition at line 53 of file rt_string.hpp.

typedef std::basic_string<char, std::char_traits<char>, RTT::os::rt_allocator<char> > RTT::rt_string

Real-time allocatable, dynamically-sized string.

Definition at line 50 of file rt_string.hpp.

typedef double RTT::Seconds

Seconds are stored as a double precision float.

Definition at line 53 of file os/Time.hpp.

typedef long RTT::secs

seconds as a signed long.

Definition at line 57 of file os/Time.hpp.

typedef boost::shared_ptr<Service> RTT::ServicePtr

Definition at line 86 of file rtt-fwd.hpp.

typedef long RTT::usecs

microseconds as a signed long.

Definition at line 65 of file os/Time.hpp.

Enumeration Type Documentation

enum RTT::ExecutionThread

Users can choose if an operation's function is executed in the component's thread (OwnThread) or in the thread of the caller (ClientThread).

Enumerator
OwnThread
ClientThread

Examples:: /tmp/ws/src/rtt/rtt/TaskContext.hpp.

Definition at line 59 of file OperationBase.hpp.

enum RTT::FlowStatus

Returns the status of a data flow read operation. NoData means that the channel is disconnected or never written to. NewData means that the returned data is new data. OldData means that the returned data was already read.

Note: The CORBA transport enforces that FlowStatus values are in-order (no double assignments or negative values).

Enumerator
NoData
OldData
NewData

Definition at line 56 of file FlowStatus.hpp.

enum RTT::LoggerLevel

Enumerate all log-levels from absolute silence to everything.

Warning: If you enable 'RealTime' logging, this may break realtime performance. Use With Care and NOT on production systems.

See also: Logger::allowRealTime()

Enumerator
Never
Fatal
Critical
Error
Warning
Info
Debug
RealTime

Definition at line 345 of file Logger.hpp.

enum RTT::SendStatus

Returns the status of a send() or collect() invocation.

Enumerator
CollectFailure
SendFailure	Returned when the result of the send() could not be collected. This happens when the 'caller' has not been set in the OperationCaller.
SendNotReady	Returned when the send() failed to deliver the operation call to the receiving component. This happens when the operation's component is in FatalError or has a full message queue.
SendSuccess	Returned when the send() succeeded, but the operation has not yet been executed by the receiving component.

Definition at line 53 of file SendStatus.hpp.

enum RTT::WriteStatus

Returns the status of a data flow write operation. WriteSuccess means that the sample could be successfully written into the connection buffer of all (mandatory) channels. WriteFailure means that at least one (mandatory) connection reported an error, e.g. a full buffer. NotConnected means that at least one (mandatory) channel is not connected or the channel is not connected to any output.

Note: The CORBA transport enforces that FlowStatus values are in-order (no double assignments or negative values).

Enumerator
WriteSuccess
WriteFailure
NotConnected

Definition at line 66 of file FlowStatus.hpp.

Function Documentation

RTT_API bool RTT::connectPeers	(	TaskContext *	A,
		TaskContext *	B
	)

Set up the Execution Flow (who knows who) between A and B in both directions. Both will be able to use each other's interface.

See also: TaskContext::connectPeers

Examples:: /tmp/ws/src/rtt/rtt/TaskContext.hpp.

Definition at line 412 of file TaskContext.cpp.

RTT_API bool RTT::connectPorts	(	TaskContext *	A,
		TaskContext *	B
	)

Connect the Data Flow Ports of A and B in both directions, by matching port names.

See also: TaskContext::connectPorts

Examples:: /tmp/ws/src/rtt/rtt/TaskContext.hpp.

Definition at line 408 of file TaskContext.cpp.

static Logger::LogFunction RTT::endlog ( )

inlinestatic

Function to tell the logger that the log message ended. Usage: log() << "Message" << endlog();

Definition at line 362 of file Logger.hpp.

static Logger::LogFunction RTT::endlog ( LoggerLevel ll )

inlinestatic

Function to tell the logger that the log message ended and specify the LoggerLevel of that message Usage: log() << "Error Message" << endlog(Error);

Definition at line 369 of file Logger.hpp.

static Logger::LogFunction RTT::flushlog ( )

inlinestatic

Function to tell the logger that the logs may be flushed. Usage: log() << "Message on line 1" << flushlog();

Definition at line 381 of file Logger.hpp.

static Logger& RTT::log ( )

inlinestatic

Free function in order to access the Logger instance.

Definition at line 350 of file Logger.hpp.

static Logger& RTT::log ( LoggerLevel ll )

inlinestatic

Free function in order to access the Logger instance and set the LoggerLevel of next message.

Definition at line 356 of file Logger.hpp.

std::string RTT::makeString ( const RTT::rt_string & str )

inline

convert from real-time string to std::string

Definition at line 56 of file rt_string.hpp.

nsecs RTT::msecs_to_nsecs ( const msecs ms )

inline

Definition at line 95 of file os/Time.hpp.

psecs RTT::msecs_to_psecs ( const msecs ms )

inline

Definition at line 96 of file os/Time.hpp.

Seconds RTT::msecs_to_Seconds ( const msecs ns )

inline

Definition at line 104 of file os/Time.hpp.

usecs RTT::msecs_to_usecs ( const msecs ms )

inline

Definition at line 94 of file os/Time.hpp.

static Logger::LogFunction RTT::nlog ( )

inlinestatic

Function to tell the logger that a newline may be inserted in the log message. Usage: log() << "Message on line 1" << nlog() << "Message on line 2" << endlog();

Definition at line 375 of file Logger.hpp.

psecs RTT::nsecs_to_psecs ( const nsecs ns )

inline

Definition at line 101 of file os/Time.hpp.

Seconds RTT::nsecs_to_Seconds ( const nsecs ns )

inline

Definition at line 108 of file os/Time.hpp.

std::ostream & RTT::operator<<	(	std::ostream &	os,
		const BufferPolicy &	bp
	)

Definition at line 34 of file BufferPolicy.cpp.

RTT_API std::ostream & RTT::operator<<	(	std::ostream &	os,
		FlowStatus	fs
	)

Definition at line 45 of file FlowStatus.cpp.

RTT_API std::ostream & RTT::operator<<	(	std::ostream &	os,
		SendStatus	fs
	)

Definition at line 46 of file SendStatus.cpp.

RTT_API std::ostream & RTT::operator<<	(	std::ostream &	os,
		WriteStatus	fs
	)

Definition at line 75 of file FlowStatus.cpp.

std::ostream & RTT::operator<<	(	std::ostream &	os,
		const ConnPolicy &	cp
	)

Definition at line 148 of file ConnPolicy.cpp.

template<typename T >

std::ostream& RTT::operator<<	(	std::ostream &	os,
		Property< T > &	p
	)

Definition at line 442 of file Property.hpp.

bool RTT::operator==	(	const PropertyBag &	a,
		const PropertyBag &	b
	)

Definition at line 53 of file property_composition_test.cpp.

static bool RTT::operator==	(	const ConnPolicy &	,
		const ConnPolicy &
	)

static

Definition at line 227 of file corba_test.cpp.

std::istream & RTT::operator>>	(	std::istream &	is,
		BufferPolicy &	bp
	)

Definition at line 47 of file BufferPolicy.cpp.

RTT_API std::istream & RTT::operator>>	(	std::istream &	is,
		FlowStatus &	fs
	)

Definition at line 61 of file FlowStatus.cpp.

RTT_API std::istream & RTT::operator>>	(	std::istream &	is,
		SendStatus &	fs
	)

Definition at line 67 of file SendStatus.cpp.

RTT_API std::istream & RTT::operator>>	(	std::istream &	is,
		WriteStatus &	fs
	)

Definition at line 91 of file FlowStatus.cpp.

OperatorRepository::shared_ptr RTT::operators ( )

This global function provides the short notation for OperatorRepository::Instance()

Definition at line 132 of file Operators.cpp.

Seconds RTT::psecs_to_Seconds ( const psecs ps )

inline

Definition at line 110 of file os/Time.hpp.

msecs RTT::Seconds_to_msecs ( const Seconds s )

inline

Definition at line 103 of file os/Time.hpp.

nsecs RTT::Seconds_to_nsecs ( const Seconds s )

inline

Definition at line 107 of file os/Time.hpp.

psecs RTT::Seconds_to_psecs ( const Seconds s )

inline

Definition at line 109 of file os/Time.hpp.

usecs RTT::Seconds_to_usecs ( const Seconds s )

inline

Definition at line 105 of file os/Time.hpp.

msecs RTT::secs_to_msecs ( const secs s )

inline

Definition at line 89 of file os/Time.hpp.

nsecs RTT::secs_to_nsecs ( const secs s )

inline

Definition at line 91 of file os/Time.hpp.

psecs RTT::secs_to_psecs ( const secs s )

inline

Definition at line 92 of file os/Time.hpp.

usecs RTT::secs_to_usecs ( const secs s )

inline

Definition at line 90 of file os/Time.hpp.

bool RTT::updateOrRefreshProperty	(	PropertyBase *	source,
		PropertyBase *	target,
		bool	update
	)

Definition at line 439 of file PropertyBag.cpp.

nsecs RTT::usecs_to_nsecs ( const usecs us )

inline

Definition at line 98 of file os/Time.hpp.

psecs RTT::usecs_to_psecs ( const usecs us )

inline

Definition at line 99 of file os/Time.hpp.

Seconds RTT::usecs_to_Seconds ( const usecs ns )

inline

Definition at line 106 of file os/Time.hpp.

Variable Documentation

char const* RTT::default_comp_path_build

const long RTT::MSECS_IN_SECS = 1000

Definition at line 75 of file os/Time.hpp.

const long RTT::NSECS_IN_MSECS = 1000 * USECS_IN_MSECS

Definition at line 81 of file os/Time.hpp.

const long RTT::NSECS_IN_SECS = 1000 * USECS_IN_SECS

Definition at line 77 of file os/Time.hpp.

const long RTT::NSECS_IN_USECS = 1000

Definition at line 84 of file os/Time.hpp.

const long RTT::PSECS_IN_MSECS = 1000 * NSECS_IN_MSECS

Definition at line 82 of file os/Time.hpp.

const long RTT::PSECS_IN_NSECS = 1000

Definition at line 87 of file os/Time.hpp.

const long long RTT::PSECS_IN_SECS = 1000LL * NSECS_IN_SECS

Definition at line 78 of file os/Time.hpp.

const long RTT::PSECS_IN_USECS = 1000 * NSECS_IN_USECS

Definition at line 85 of file os/Time.hpp.

std::vector<TransportPlugin*> RTT::Transports

static

Definition at line 50 of file TypekitRepository.cpp.

std::vector<TypekitPlugin*> RTT::Typekits

static

Definition at line 49 of file TypekitRepository.cpp.

const long RTT::USECS_IN_MSECS = 1000

Definition at line 80 of file os/Time.hpp.

const long RTT::USECS_IN_SECS = 1000 * MSECS_IN_SECS

Definition at line 76 of file os/Time.hpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation