QualifiedTime.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_TRANSPORT_LOG_QUALIFIEDTIME_HH_
#define GZ_TRANSPORT_LOG_QUALIFIEDTIME_HH_
 
#include <chrono>
#include <cstdint>
#include <memory>
 
#include <gz/transport/config.hh>
#include <gz/transport/log/Export.hh>
 
namespace gz::transport::log
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_TRANSPORT_VERSION_NAMESPACE {
  //
  class GZ_TRANSPORT_LOG_VISIBLE QualifiedTime
  {
    public: enum class Qualifier : int64_t
    {
      INCLUSIVE = 0,
 
      EXCLUSIVE
    };
 
    using Time = std::chrono::nanoseconds;
 
    public: QualifiedTime(const Time &_time,
                          Qualifier _qualifier = Qualifier::INCLUSIVE);
 
    public: template <typename Rep, typename Period>
    QualifiedTime(const std::chrono::duration<Rep, Period> &_time,
                  Qualifier _qualifier = Qualifier::INCLUSIVE)
      : QualifiedTime(static_cast<const Time &>(_time), _qualifier) { }
 
    public: QualifiedTime(/* Indeterminate */);
 
    public: QualifiedTime(const QualifiedTime &_other);
 
    public: QualifiedTime &operator=(const QualifiedTime &_other);
 
    public: QualifiedTime(QualifiedTime &&_old) = default;  // NOLINT
 
    public: QualifiedTime &operator=(
        QualifiedTime &&) = default;  // NOLINT(build/c++11)
 
    public: bool operator==(const QualifiedTime &_other) const;
 
    public: bool operator!=(const QualifiedTime &_other) const;
 
    public: bool IsIndeterminate() const;
 
    public: const Time *GetTime() const;
 
    public: const Qualifier *GetQualifier() const;
 
    public: void SetTime(const Time &_time,
                         Qualifier _qualifier = Qualifier::INCLUSIVE);
 
    public: void Clear();
 
    public: ~QualifiedTime();
 
    private: class Implementation;
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    private: std::unique_ptr<Implementation, void (*)(Implementation*)> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
  };
 
  class GZ_TRANSPORT_LOG_VISIBLE QualifiedTimeRange
  {
    public: QualifiedTimeRange(
      const QualifiedTime &_begin,
      const QualifiedTime &_end);
 
    public: QualifiedTimeRange(const QualifiedTimeRange &_other);
 
    public: QualifiedTimeRange &operator=(const QualifiedTimeRange &_other);
 
    public: QualifiedTimeRange(QualifiedTimeRange &&_old);  // NOLINT
 
    public: QualifiedTimeRange &operator=(
        QualifiedTimeRange &&) = default;  // NOLINT(build/c++11)
 
    public: bool operator==(const QualifiedTimeRange &_other) const;
 
    public: bool operator!=(const QualifiedTimeRange &_other) const;
 
    public: static QualifiedTimeRange From(const QualifiedTime &_begin);
 
    public: static QualifiedTimeRange Until(const QualifiedTime &_end);
 
    public: static QualifiedTimeRange AllTime();
 
    public: const QualifiedTime &Beginning() const;
 
    public: const QualifiedTime &Ending() const;
 
    public: bool SetBeginning(const QualifiedTime &_begin);
 
    public: bool SetEnding(const QualifiedTime &_end);
 
    public: bool SetRange(const QualifiedTime &_begin,
                          const QualifiedTime &_end);
 
    public: bool Valid() const;
 
    public: ~QualifiedTimeRange();
 
    private: class Implementation;
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::*
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    private: std::unique_ptr<Implementation, void(*)(Implementation*)> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
  };
  }
}
 
#endif