clockdomain.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <cstdint>
#include <promeki/function.h>
#include <promeki/namespace.h>
#include <promeki/string.h>
#include <promeki/stringregistry.h>
#include <promeki/list.h>
#include <promeki/enums_clock.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class Metadata;
 
class ClockDomain {
        public:
                using ID = StringRegistry<"ClockDomain">::Item;
 
                using IDList = ::promeki::List<ID>;
 
                struct Data;
 
                static const ID Synthetic;
 
                static const ID SystemMonotonic;
 
                static const ID Ptp;
 
                using WallClockProvider = ::promeki::Function<int64_t()>;
 
                static ID registerDomain(const String &name, const String &description,
                                         const ClockEpoch &epoch = ClockEpoch::Correlated);
 
                static void setDomainMetadata(const ID &id, const Metadata &metadata);
 
                static void setNowProvider(const ID &id, WallClockProvider provider);
 
                static int64_t nowUtcNs(const ID &id);
 
                static bool hasNowProvider(const ID &id);
 
                static IDList registeredIDs();
 
                static ClockDomain lookup(const String &name);
 
                ClockDomain() = default;
 
                ClockDomain(const ID &id);
 
                bool isValid() const;
 
                ID id() const;
 
                const String &name() const;
 
                const String &description() const;
 
                const ClockEpoch &epoch() const;
 
                const Metadata &metadata() const;
 
                bool isCrossStreamComparable() const;
 
                bool isCrossMachineComparable() const;
 
                int64_t nowUtcNs() const;
 
                bool hasNowProvider() const;
 
                String toString() const;
 
                const Data *data() const { return d; }
 
                bool operator==(const ClockDomain &other) const { return d == other.d; }
 
                bool operator!=(const ClockDomain &other) const { return d != other.d; }
 
        private:
                const Data        *d = nullptr;
                static const Data *lookupData(const ID &id);
};
 
PROMEKI_NAMESPACE_END
 
PROMEKI_FORMAT_VIA_TOSTRING(promeki::ClockDomain);
 
#endif // PROMEKI_ENABLE_CORE