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

LogProxy Class Reference [Proxies] #include <playerclient.h> Inherits ClientProxy. List of all members. Detailed Description The LogProxy proxy provides access to a log device. Public Member Functions   LogProxy (PlayerClient *pc, unsigned short index, unsigned char access= 'c')   ~LogProxy () int  GetState () int  SetWriteState (int state) int  SetReadState (int state) int  Rewind () int  SetFilename (const char *fname) virtual void  FillData (player_msghdr_t hdr, const char *buffer) virtual void  Print () Public Attributes int  type int  state Constructor & Destructor Documentation LogProxy::LogProxy (  PlayerClient *  pc, unsigned short  index, unsigned char  access = 'c' )  [inline]   Constructor LogProxy::~LogProxy (   )  [inline]   Destructor Member Function Documentation int LogProxy::GetState (   )    Get the type and current state of the log device. Returns 0 on success, -1 on error. int LogProxy::SetWriteState (  int  state  )    Start/stop (1/0) writing to the log file. Returns 0 on success, -1 on error. int LogProxy::SetReadState (  int  state  )    Start/stop (1/0) reading from the log file. Returns 0 on success, -1 on error. int LogProxy::Rewind (   )    Rewind the log file. Returns 0 on success, -1 on error. int LogProxy::SetFilename (  const char *  fname  )    Set the name of the logfile to write to. Returns 0 on success, -1 on error. virtual void LogProxy::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. virtual void LogProxy::Print (   )  [virtual]   All proxies SHOULD provide this method, which should print out, in a human-readable form, the device's current state. Reimplemented from ClientProxy. Member Data Documentation int LogProxy::type   What kind of log device is this? Either PLAYER_LOG_TYPE_READ or PLAYER_LOG_TYPE_WRITE. Call GetState() to fill it. int LogProxy::state   Is logging/playback enabled? Call GetState() to fill it. The documentation for this class was generated from the following file: playerclient.h