HelloWorld Class Reference

Every component inherits from the 'TaskContext' class. More...

List of all members.

Public Member Functions

 HelloWorld (std::string name)
 This example sets the interface up in the Constructor of the component.

Protected Attributes

Name-Value parameters

Property< std::string > property
 Properties take a name, a value and a description and are suitable for XML.
Attribute< std::string > attribute
 Attributes take a name and contain changing values.
Constant< std::string > constant
 Constants take a name and contain a constant value.
Input-Output ports

DataPort< std::string > dataport
 DataPorts share data among readers and writers.
BufferPort< std::string > bufferport
 BufferPorts buffer data among readers and writers.

Method



Method< std::string(void)> method
 Methods take a number of arguments and return a value.
std::string mymethod ()
 The method function is executed by the method object:

Command



Command< bool(std::string)> command
 Commands take a number of arguments and return true or false.
bool mycommand (std::string arg)
 The command function executed by the receiver.
bool mycomplete (std::string arg)
 The completion condition checked by the sender.

Event



Event< void(std::string)> event
 The event takes a payload which is distributed to anonymous receivers.
Handle h
 Stores the connection between 'event' and 'mycallback'.
void mycallback (std::string data)
 An event callback (or subscriber) function.

Detailed Description

Every component inherits from the 'TaskContext' class.

This base class allow a user to add a primitive to the interface and contain an ExecutionEngine which executes application code.

Definition at line 35 of file HelloWorld.cpp.


Member Data Documentation

BufferPort<std::string> bufferport [protected]

BufferPorts buffer data among readers and writers.

A reader reads the data in a FIFO way.

Definition at line 71 of file HelloWorld.cpp.

Referenced by HelloWorld::HelloWorld().

Command<bool(std::string)> command [protected]

Commands take a number of arguments and return true or false.

They are asynchronous and executed in the thread of the receiver.

Definition at line 103 of file HelloWorld.cpp.

Referenced by HelloWorld::HelloWorld().

DataPort<std::string> dataport [protected]

DataPorts share data among readers and writers.

A reader always reads the most recent data.

Definition at line 66 of file HelloWorld.cpp.

Referenced by HelloWorld::HelloWorld().

Event<void(std::string)> event [protected]

The event takes a payload which is distributed to anonymous receivers.

Distribution can happen synchronous and asynchronous.

Definition at line 134 of file HelloWorld.cpp.

Referenced by HelloWorld::HelloWorld().

Method<std::string(void)> method [protected]

Methods take a number of arguments and return a value.

The are executed in the thread of the caller.

Definition at line 83 of file HelloWorld.cpp.

Referenced by HelloWorld::HelloWorld().


The documentation for this class was generated from the following file:
Generated on Thu Dec 23 15:05:29 2010 for OrocosComponentLibrary by  doxygen 1.6.3