Robot Simulator of the Robotics Group for Self-Organization of Control: Operator Class Reference

# Operator Class Reference

`#include <operator.h>`

Inherits Configurable.

Inherited by BoxRingOperator, LiftUpOperator, LimitOrientationOperator, and PullToPointOperator.

Collaboration diagram for Operator:
[legend]

List of all members.

## Classes
struct | ManipDescr
| description of action (for visualization) More...
## Public Types
enum | ManipType { None, Limit, Move, RemoveOperator }
| type of manipulation of the robot (for display) and or operation RemoveOperator means that the operator should be removed More...
## Public Member Functions
| Operator (const std::string &name, const std::string &revision)
virtual | ~Operator ()
virtual ManipType | observe (OdeAgent *agent, GlobalData &global, ManipDescr &descr)=0
| called every simulation step

## Member Enumeration Documentation

enum ManipType

type of manipulation of the robot (for display) and or operation RemoveOperator means that the operator should be removed

Enumerator:

  None |
  Limit |
  Move |
  RemoveOperator |

## Constructor & Destructor Documentation

Operator | ( | const std::string & | name,
|  | const std::string & | revision |
| ) |  |  | `[inline]`

virtual ~Operator | ( |  | ) | `[inline, virtual]`

## Member Function Documentation

virtual ManipType observe | ( | OdeAgent * | agent,
|  | GlobalData & | global,
|  | ManipDescr & | descr |
| ) |  |  | `[pure virtual]`

called every simulation step

Returns:
  what was done with the robot

Implemented in LimitOrientationOperator, LiftUpOperator, PullToPointOperator, and BoxRingOperator.

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

- operator.h