Time.hpp

Go to the documentation of this file.

#ifndef OMG_DDS_CORE_TIME_HPP_
#define OMG_DDS_CORE_TIME_HPP_

/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Corp.
 * Copyright 2010, Real-Time Innovations, Inc.
 * All rights reserved.
 *
 * 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.
 */

#include <dds/core/types.hpp>

namespace dds
{
namespace core
{
class Duration;
class Time;
}
}

class OMG_DDS_API dds::core::Time
{
public:
    static const Time invalid();       // {-1, 0xffffffff}

public:
    static const Time from_microsecs(int64_t microseconds);
    static const Time from_millisecs(int64_t milliseconds);
    static const Time from_secs(double seconds);

public:
    Time();
    explicit Time(int64_t sec, uint32_t nanosec = 0);

public:
    int64_t sec() const;

    void    sec(int64_t s);

    uint32_t nanosec() const;

    void    nanosec(uint32_t ns);

public:
    int compare(const Time& that) const;

    bool operator >(const Time& that) const;

    bool operator >=(const Time& that) const;

    bool operator !=(const Time& that) const;

    bool operator ==(const Time& that) const;
    bool operator <=(const Time& that) const;
    bool operator <(const Time& that) const;

public:
    Time& operator+=(const Duration& a_ti);
    Time& operator-=(const Duration& a_ti);

public:
    int64_t to_millisecs() const;

    int64_t to_microsecs() const;

    double to_secs() const;

private:
    int64_t sec_;
    uint32_t nsec_;
};

// Time arithmetic operators.
const dds::core::Time OMG_DDS_API operator +(const dds::core::Time& lhs,      const dds::core::Duration& rhs);

const dds::core::Time OMG_DDS_API operator +(const dds::core::Duration& lhs,  const dds::core::Time& rhs);

const dds::core::Time OMG_DDS_API operator -(const dds::core::Time& lhs,      const dds::core::Duration& rhs);


#endif /* OMG_DDS_CORE_TIME_HPP_ */