YARP
Yet Another Robot Platform
yarp::dev::CartesianEventParameters Struct Reference

Structure for configuring a cartesian event. More...

#include <yarp/dev/CartesianControl.h>

Public Attributes

std::string type
 The signature of the event as specified by the user. More...
 
double motionOngoingCheckPoint
 The user specifies the motion check-point that raises a "motion-ongoing" event through this parameter which must be in the range [0,1]. More...
 

Detailed Description

Structure for configuring a cartesian event.

Definition at line 37 of file CartesianControl.h.

Member Data Documentation

◆ motionOngoingCheckPoint

double yarp::dev::CartesianEventParameters::motionOngoingCheckPoint

The user specifies the motion check-point that raises a "motion-ongoing" event through this parameter which must be in the range [0,1].

Definition at line 56 of file CartesianControl.h.

◆ type

std::string yarp::dev::CartesianEventParameters::type

The signature of the event as specified by the user.

Available events are:

  • "motion-onset": beginning of motion/new target received.
  • "motion-done": end of motion.
  • "motion-ongoing": a motion check-point is attained.
  • "closing": the server is being shut down.
  • "*": a tag for all-events.

Definition at line 49 of file CartesianControl.h.


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