Orocos Real-Time Toolkit  2.9.0
Public Member Functions | List of all members
RTT::types::RealTimeTypekitPlugin Class Reference

This interface defines the types of the realTime package. More...

#include <rtt/typekit/RealTimeTypekit.hpp>

Inheritance diagram for RTT::types::RealTimeTypekitPlugin:
RTT::types::TypekitPlugin

Public Member Functions

virtual std::string getName ()
 Each plugin must have a unique name. More...
 
virtual bool loadTypes ()
 Implement this method to add types to the Orocos type system. More...
 
virtual bool loadOperators ()
 Implement this method to load Scripting operators on types, such as '+', '*', ... More...
 
virtual bool loadConstructors ()
 Implement this method to load Scripting constructors of types, such as in C++. More...
 
virtual bool loadGlobals ()
 Implement this function to add global variables to the type system. More...
 

Detailed Description

This interface defines the types of the realTime package.

Definition at line 52 of file RealTimeTypekit.hpp.

Member Function Documentation

std::string RTT::types::RealTimeTypekitPlugin::getName ( )
virtual

Each plugin must have a unique name.

This name is used globally in the process to identify this instance.

Implements RTT::types::TypekitPlugin.

Definition at line 49 of file RealTimeTypekit.cpp.

References ORO_TYPEKIT_PLUGIN.

bool RTT::RealTimeTypekitPlugin::loadConstructors ( )
virtual

Implement this method to load Scripting constructors of types, such as in C++.

Default constructors (which take no arguments) need not to be added.

See also
The TypeInfo class for adding a constructor to a type
The TypeConstructor class for the interface of a constructor.
The newConstructor utility function for creating a new constructor object.
The RealTimeTypekit for an implementation example.

Implements RTT::types::TypekitPlugin.

Definition at line 217 of file RealTimeTypekitConstructors.cpp.

References RTT::types::TypeInfoRepository::Instance(), and RTT::types::newConstructor().

bool RTT::RealTimeTypekitPlugin::loadGlobals ( )
virtual
bool RTT::RealTimeTypekitPlugin::loadOperators ( )
virtual

Implement this method to load Scripting operators on types, such as '+', '*', ...

See also
The OperatorRepository for adding the Operators
The UnaryOp, BinaryOp and DotOp classes for the interface of an operation.
The newUnaryOperator, newBinaryOperator and newDotOperator functions for creating new operator objects.
The RealTimeTypekit for an implementation example.

Implements RTT::types::TypekitPlugin.

Definition at line 107 of file RealTimeTypekitOperators.cpp.

References RTT::types::OperatorRepository::Instance(), RTT::types::newBinaryOperator(), and RTT::types::newUnaryOperator().

bool RTT::RealTimeTypekitPlugin::loadTypes ( )
virtual

Implement this method to add types to the Orocos type system.

See also
The TypeRepository for adding the types.
The TypeInfo class for the interface of a 'type'
The TemplateTypeInfo class for easy addition of new user types in scripting, XML,...
The TypeInfoName class for only 'name' addition of a user type
The TemplateIndexTypeInfo for adding container types.
The RealTimeTypekit for an implementation example.

Implements RTT::types::TypekitPlugin.

Definition at line 60 of file RealTimeTypekitTypes.cpp.

References RTT::types::TypeInfoRepository::Instance(), RTT::types::loadOrocosTypes(), and RTT::types::loadStdTypes().


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