RobotLib  1
A set of software wrappers for Rovio, Roomba and NXT robots written in C#.
 All Classes Namespaces Functions Variables Enumerations Properties Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Rovio.API.MovementComponent Class Reference

A base class for all movement commands. More...

Inheritance diagram for Rovio.API.MovementComponent:
Rovio.Component Rovio.API.Movement Rovio.API.Movement.ManualDriveComponent Rovio.API.Movement.MCUReportComponent Rovio.API.Movement.ReportComponent Rovio.API.Movement.TuningParametersComponent

Public Member Functions

 MovementComponent (Robot _robot)
 The constructor.
 
virtual string Request (string value)
 Request and parse the movement command.
 
- Public Member Functions inherited from Rovio.Component
 Component (Robot _robot)
 The constructor.
 
virtual void Update ()
 The Update function that manually refreshes the state of a given component (e.g. when AutoUpdate = false)
 

Protected Member Functions

string GetParameter (string value)
 Parse the specific parameter and return its value.
 

Protected Attributes

string report
 Stores the latest response from the robot. Usefull for commands supporting multiple fields in the response.
 
- Protected Attributes inherited from Rovio.Component
Robot robot
 The robot class, accessible by all dervied classes.
 

Additional Inherited Members

- Public Attributes inherited from Rovio.Component
bool AutoUpdate = true
 Automatic update option for methods requesting more than one piece of information.
 

Detailed Description

A base class for all movement commands.

Constructor & Destructor Documentation

Rovio.API.MovementComponent.MovementComponent ( Robot  _robot)

The constructor.

Member Function Documentation

string Rovio.API.MovementComponent.GetParameter ( string  value)
protected

Parse the specific parameter and return its value.

virtual string Rovio.API.MovementComponent.Request ( string  value)
virtual

Request and parse the movement command.

Parameters
valueaction value
Returns
response from the robot

Member Data Documentation

string Rovio.API.MovementComponent.report
protected

Stores the latest response from the robot. Usefull for commands supporting multiple fields in the response.


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