OCL::HelloWorld Class Reference

List of all members.

Public Member Functions

 HelloWorld (std::string name)

Protected Member Functions

std::string mymethod ()
bool sayWorld (const std::string &word)
void updateHook ()

Protected Attributes

Name-Value parameters

std::string attribute
std::string constant
bool flag
std::string property
Input-Output ports

RTT::InputPort< std::string > bufferport
RTT::OutputPort< std::string > outport

Detailed Description

Every component inherits from the 'RTTTaskContext' class. This base class allow a user to add a primitive to the interface and contain an RTT::ExecutionEngine which executes application code.

Definition at line 34 of file HelloWorld.cpp.

Constructor & Destructor Documentation

OCL::HelloWorld::HelloWorld ( std::string  name  )  [inline]

This example sets the interface up in the Constructor of the component.

Definition at line 111 of file HelloWorld.cpp.

Member Function Documentation

std::string OCL::HelloWorld::mymethod (  )  [inline, protected]

An operation we want to add to our interface.

Definition at line 82 of file HelloWorld.cpp.

bool OCL::HelloWorld::sayWorld ( const std::string &  word  )  [inline, protected]

This one is executed in our own thread.

Definition at line 89 of file HelloWorld.cpp.

void OCL::HelloWorld::updateHook (  )  [inline, protected]

Definition at line 96 of file HelloWorld.cpp.

Member Data Documentation

std::string OCL::HelloWorld::attribute [protected]

Attributes are aliased to class variables.

Definition at line 56 of file HelloWorld.cpp.

RTT::InputPort<std::string> OCL::HelloWorld::bufferport [protected]

This RTT::InputPort buffers incoming data.

Definition at line 76 of file HelloWorld.cpp.

std::string OCL::HelloWorld::constant [protected]

Constants are aliased, but can only be changed from the component itself.

Definition at line 61 of file HelloWorld.cpp.

bool OCL::HelloWorld::flag [protected]

Attribute that you can toggle to influence what is printed in updateHook()

Definition at line 52 of file HelloWorld.cpp.

RTT::OutputPort<std::string> OCL::HelloWorld::outport [protected]

We publish our data through this RTT::OutputPort

Definition at line 72 of file HelloWorld.cpp.

std::string OCL::HelloWorld::property [protected]

Properties take a name, a value and a description and are suitable for XML.

Definition at line 46 of file HelloWorld.cpp.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Author(s): OCL Development Team
autogenerated on Fri Jan 11 09:50:53 2013