1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_EXT_CORE_SC_TIME_HH__
31#define __SYSTEMC_EXT_CORE_SC_TIME_HH__
32
33#include <stdint.h>
34
35#include <iostream>
36
37#include "../dt/int/sc_nbdefs.hh"
38
39namespace sc_core
40{
41
42enum sc_time_unit {
43    SC_FS = 0,
44    SC_PS,
45    SC_NS,
46    SC_US,
47    SC_MS,
48    SC_SEC
49};
50
51class sc_time
52{
53  public:
54    sc_time();
55    sc_time(double, sc_time_unit);
56    sc_time(const sc_time &);
57
58    // Nonstandard
59    sc_time(double, const char *);
60
61    // Deprecated
62    sc_time(double, bool);
63    sc_time(sc_dt::uint64, bool);
64
65    sc_time &operator = (const sc_time &);
66
67    sc_dt::uint64 value() const;
68    double to_double() const;
69    double to_seconds() const;
70    const std::string to_string() const;
71
72    bool operator == (const sc_time &) const;
73    bool operator != (const sc_time &) const;
74    bool operator < (const sc_time &) const;
75    bool operator <= (const sc_time &) const;
76    bool operator > (const sc_time &) const;
77    bool operator >= (const sc_time &) const;
78
79    sc_time &operator += (const sc_time &);
80    sc_time &operator -= (const sc_time &);
81    sc_time &operator *= (double);
82    sc_time &operator /= (double);
83
84    void print(std::ostream & =std::cout) const;
85
86    // Deprecated
87    static sc_time from_value(sc_dt::uint64);
88    static sc_time from_seconds(double);
89    static sc_time from_string(const char *str);
90
91  private:
92    uint64_t val;
93};
94
95const sc_time operator + (const sc_time &, const sc_time &);
96const sc_time operator - (const sc_time &, const sc_time &);
97
98const sc_time operator * (const sc_time &, double);
99const sc_time operator * (double, const sc_time &);
100const sc_time operator / (const sc_time &, double);
101double operator / (const sc_time &, const sc_time &);
102
103std::ostream &operator << (std::ostream &, const sc_time &);
104
105extern const sc_time SC_ZERO_TIME;
106
107void sc_set_time_resolution(double, sc_time_unit);
108sc_time sc_get_time_resolution();
109const sc_time &sc_max_time();
110
111// Deprecated
112void sc_set_default_time_unit(double, sc_time_unit);
113sc_time sc_get_default_time_unit();
114
115// Nonstandard
116class sc_time_tuple
117{
118  public:
119    sc_time_tuple() : _value(), _unit(SC_SEC), _set(false) {}
120    sc_time_tuple(const sc_time &);
121
122    bool has_value() const;
123    sc_dt::uint64 value() const;
124    // Normalized unit.
125    sc_time_unit unit() const { return _unit; }
126    // Normalized unit symbol.
127    const char *unit_symbol() const;
128
129    operator sc_time() const { return sc_time(to_double(), _unit); }
130
131    double to_double() const; // Relative to the normalized unit.
132    std::string to_string() const;
133
134  private:
135    sc_dt::uint64 _value;
136    sc_time_unit _unit;
137    bool _set;
138};
139
140} // namespace sc_core
141
142#endif  //__SYSTEMC_EXT_CORE_SC_TIME_HH__
143