Time.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2018 Istituto Italiano di Tecnologia (IIT)
 * Copyright (C) 2006-2010 RobotCub Consortium
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms of the
 * BSD-3-Clause license. See the accompanying LICENSE file for details.
 */

#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 {
namespace 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, std::string localPortName = "");

YARP_OS_API void useCustomClock(Clock* clock);

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();

#ifndef YARP_NO_DEPRECATED // Since YARP 3.0.0

YARP_DEPRECATED
YARP_OS_API void turboBoost();
#endif

} // namespace Time
} // namespace os
} // namespace yarp

#endif // YARP_OS_TIME_H