yarp::os::NetworkClock Class Reference

#include <yarp/os/NetworkClock.h>

Inheritance diagram for yarp::os::NetworkClock:

Classes
class	Private

Public Member Functions
	NetworkClock ()
virtual	~NetworkClock ()
bool	open (const std::string &clockSourcePortName, std::string localPortName="")
double	now () override
	Return the current time in seconds, relative to an arbitrary starting point. More...
void	delay (double seconds) override
	Wait for a certain number of seconds. More...
bool	isValid () const override
	Check if time is valid (non-zero). More...
Public Member Functions inherited from yarp::os::Clock
virtual	~Clock ()
	Destructor. More...

Detailed Description

Definition at line 21 of file NetworkClock.h.

Constructor & Destructor Documentation

NetworkClock()

NetworkClock::NetworkClock

(

)

Definition at line 130 of file NetworkClock.cpp.

~NetworkClock()

NetworkClock::~NetworkClock ( )

virtual

Definition at line 135 of file NetworkClock.cpp.

Member Function Documentation

delay()

void NetworkClock::delay ( double  seconds )

overridevirtual

Wait for a certain number of seconds.

This may be fractional.

Parameters

seconds

the duration of the delay, in seconds

Implements yarp::os::Clock.

Definition at line 192 of file NetworkClock.cpp.

isValid()

bool NetworkClock::isValid ( ) const

overridevirtual

Check if time is valid (non-zero).

For example, for a network clock, if no timestamp has yet been received, this method will return false.

Implements yarp::os::Clock.

Definition at line 216 of file NetworkClock.cpp.

now()

double NetworkClock::now ( )

overridevirtual

Return the current time in seconds, relative to an arbitrary starting point.

Returns

the time in seconds

Implements yarp::os::Clock.

Definition at line 184 of file NetworkClock.cpp.

open()

bool NetworkClock::open	(	const std::string &	clockSourcePortName,
		std::string	localPortName = ""
	)

Definition at line 141 of file NetworkClock.cpp.

---

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

• src/libYARP_os/src/yarp/os/NetworkClock.h
• src/libYARP_os/src/yarp/os/NetworkClock.cpp