YARP  2.3.68+225-20170329.5+gitb0d3289
Yet Another Robot Platform
yarp::os::Ping Class Reference

Measure performance of a YARP port. More...

#include <yarp/os/Ping.h>

Public Member Functions

 Ping (const char *target=YARP_NULLPTR)
 
bool setTarget (const char *target)
 
void connect ()
 
void sample ()
 
void clear ()
 
ConnectResult getLastConnect ()
 
ConnectResult getAverageConnect ()
 
void report ()
 

Static Public Member Functions

static ConstString renderTime (double t, int space, int decimal)
 

Private Attributes

ConstString target
 
ConnectResult lastConnect
 
ConnectResult accumConnect
 

Detailed Description

Measure performance of a YARP port.

Can also be partially used for non-YARP ports with a compatible protocol.

Definition at line 120 of file Ping.h.

Constructor & Destructor Documentation

◆ Ping()

yarp::os::Ping::Ping ( const char *  target = YARP_NULLPTR)
inline

Definition at line 122 of file Ping.h.

Member Function Documentation

◆ clear()

void yarp::os::Ping::clear ( )
inline

Definition at line 137 of file Ping.h.

◆ connect()

void Ping::connect ( )

Definition at line 27 of file Ping.cpp.

◆ getAverageConnect()

ConnectResult yarp::os::Ping::getAverageConnect ( )
inline

Definition at line 146 of file Ping.h.

◆ getLastConnect()

ConnectResult yarp::os::Ping::getLastConnect ( )
inline

Definition at line 142 of file Ping.h.

◆ renderTime()

ConstString Ping::renderTime ( double  t,
int  space,
int  decimal 
)
static

Definition at line 70 of file Ping.cpp.

◆ report()

void Ping::report ( )

Definition at line 50 of file Ping.cpp.

◆ sample()

void Ping::sample ( )

Definition at line 126 of file Ping.cpp.

◆ setTarget()

bool yarp::os::Ping::setTarget ( const char *  target)
inline

Definition at line 128 of file Ping.h.

Member Data Documentation

◆ accumConnect

ConnectResult yarp::os::Ping::accumConnect
private

Definition at line 156 of file Ping.h.

◆ lastConnect

ConnectResult yarp::os::Ping::lastConnect
private

Definition at line 156 of file Ping.h.

◆ target

ConstString yarp::os::Ping::target
private

Definition at line 155 of file Ping.h.


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