Home FAQ Player Stage Gazebo Contrib Documentation Publications Contributors Users Project Download Bugs/Feedback Mailing lists Radish Old news Old stuff

BlinkenlightProxy Class Reference [Proxies] #include <playerclient.h> Inherits ClientProxy. List of all members. Detailed Description The BlinkenlightProxy class is used to enable and disable a flashing indicator light, and to set its period, via a blinkenlight device Public Member Functions   BlinkenlightProxy (PlayerClient *pc, unsigned short index, unsigned char access= 'c') virtual  ~BlinkenlightProxy () void  FillData (player_msghdr_t hdr, const char *buffer) void  Print ()   Print out the current status. int  SetLight (bool enable, int period_ms) Public Attributes bool  enable   true: indicator light enabled, false: disabled. int  period_ms Constructor & Destructor Documentation BlinkenlightProxy::BlinkenlightProxy (  PlayerClient *  pc, unsigned short  index, unsigned char  access = 'c' )  [inline]   Constructor. Leave the access field empty to start unconnected. virtual BlinkenlightProxy::~BlinkenlightProxy (   )  [inline, virtual] Member Function Documentation void BlinkenlightProxy::FillData (  player_msghdr_t  hdr, const char *  buffer )  [virtual]   All proxies must provide this method. It is used internally to parse new data when it is received. Reimplemented from ClientProxy. void BlinkenlightProxy::Print (   )  [virtual]   Print out the current status. Reimplemented from ClientProxy. int BlinkenlightProxy::SetLight (  bool  enable, int  period_ms )    Set the state of the indicator light. A period of zero means the light will be unblinkingly on or off. Returns 0 on success, else -1. Member Data Documentation bool BlinkenlightProxy::enable   true: indicator light enabled, false: disabled. int BlinkenlightProxy::period_ms   The current period (one whole on/off cycle) of the blinking light. If the period is zero and the light is enabled, the light is on. The documentation for this class was generated from the following file: playerclient.h