Time.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_TIME_H
#define YARP_OS_TIME_H
 
#include <yarp/os/Clock.h>
#include <yarp/os/NetworkClock.h>
#include <yarp/os/SystemClock.h>
 
#include <string>
 
namespace yarp::os {
 
enum class ShouldUseSystemClock
{
    No = 0,
    Yes = 1
};
 
enum yarpClockType
{
    YARP_CLOCK_UNINITIALIZED = -1,
    YARP_CLOCK_DEFAULT,
    YARP_CLOCK_SYSTEM,
    YARP_CLOCK_NETWORK,
    YARP_CLOCK_CUSTOM
};
 
/*
 * Services related to time -- delay, current time.
 */
namespace Time {
 
YARP_os_API void delay(double seconds);
 
YARP_os_API double now();
 
YARP_os_API void yield();
 
YARP_os_API void useSystemClock();
 
YARP_os_API void useNetworkClock(const std::string& clock, const std::string& localPortName = "");
 
YARP_os_API void useCustomClock(Clock* clock);
 
YARP_os_API bool isClockInitialized();
 
YARP_os_API bool isSystemClock();
 
YARP_os_API bool isNetworkClock();
 
YARP_os_API bool isCustomClock();
 
YARP_os_API yarpClockType getClockType();
 
YARP_os_API std::string clockTypeToString(yarpClockType type);
 
YARP_os_API bool isValid();
 
} // namespace Time
} // namespace yarp::os
 
#endif // YARP_OS_TIME_H