blob: c73673b629ec53a31f09c063cfa53d855e5d7047 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2009-2010, Google, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
#ifndef __TMUTAMT_H__
#define __TMUTAMT_H__
/**
* \file
* \brief C++ API: time unit amount object.
*/
#include "unicode/utypes.h"
#if U_SHOW_CPLUSPLUS_API
#if !UCONFIG_NO_FORMATTING
#include "unicode/measure.h"
#include "unicode/tmunit.h"
U_NAMESPACE_BEGIN
/**
* Express a duration as a time unit and number. Patterned after Currency.
* @see TimeUnitAmount
* @see TimeUnitFormat
* @stable ICU 4.2
*/
class U_I18N_API TimeUnitAmount: public Measure {
public:
/**
* Construct TimeUnitAmount object with the given number and the
* given time unit.
* @param number a numeric object; number.isNumeric() must be true
* @param timeUnitField the time unit field of a time unit
* @param status the input-output error code.
* If the number is not numeric or the timeUnitField
* is not valid,
* then this will be set to a failing value:
* U_ILLEGAL_ARGUMENT_ERROR.
* @stable ICU 4.2
*/
TimeUnitAmount(const Formattable& number,
TimeUnit::UTimeUnitFields timeUnitField,
UErrorCode& status);
/**
* Construct TimeUnitAmount object with the given numeric amount and the
* given time unit.
* @param amount a numeric amount.
* @param timeUnitField the time unit field on which a time unit amount
* object will be created.
* @param status the input-output error code.
* If the timeUnitField is not valid,
* then this will be set to a failing value:
* U_ILLEGAL_ARGUMENT_ERROR.
* @stable ICU 4.2
*/
TimeUnitAmount(double amount, TimeUnit::UTimeUnitFields timeUnitField,
UErrorCode& status);
/**
* Copy constructor
* @stable ICU 4.2
*/
TimeUnitAmount(const TimeUnitAmount& other);
/**
* Assignment operator
* @stable ICU 4.2
*/
TimeUnitAmount& operator=(const TimeUnitAmount& other);
/**
* Clone.
* @return a polymorphic clone of this object. The result will have the same class as returned by getDynamicClassID().
* @stable ICU 4.2
*/
virtual TimeUnitAmount* clone() const override;
/**
* Destructor
* @stable ICU 4.2
*/
virtual ~TimeUnitAmount();
/**
* Equality operator.
* @param other the object to compare to.
* @return true if this object is equal to the given object.
* @stable ICU 4.2
*/
virtual bool operator==(const UObject& other) const;
/**
* Not-equality operator.
* @param other the object to compare to.
* @return true if this object is not equal to the given object.
* @stable ICU 4.2
*/
bool operator!=(const UObject& other) const;
/**
* Return the class ID for this class. This is useful only for comparing to
* a return value from getDynamicClassID(). For example:
* <pre>
* . Base* polymorphic_pointer = createPolymorphicObject();
* . if (polymorphic_pointer->getDynamicClassID() ==
* . erived::getStaticClassID()) ...
* </pre>
* @return The class ID for all objects of this class.
* @stable ICU 4.2
*/
static UClassID U_EXPORT2 getStaticClassID();
/**
* Returns a unique class ID POLYMORPHICALLY. Pure virtual override. This
* method is to implement a simple version of RTTI, since not all C++
* compilers support genuine RTTI. Polymorphic operator==() and clone()
* methods call this method.
*
* @return The class ID for this object. All objects of a
* given class have the same class ID. Objects of
* other classes have different class IDs.
* @stable ICU 4.2
*/
virtual UClassID getDynamicClassID() const override;
/**
* Get the time unit.
* @return time unit object.
* @stable ICU 4.2
*/
const TimeUnit& getTimeUnit() const;
/**
* Get the time unit field value.
* @return time unit field value.
* @stable ICU 4.2
*/
TimeUnit::UTimeUnitFields getTimeUnitField() const;
};
inline bool
TimeUnitAmount::operator!=(const UObject& other) const {
return !operator==(other);
}
U_NAMESPACE_END
#endif /* #if !UCONFIG_NO_FORMATTING */
#endif /* U_SHOW_CPLUSPLUS_API */
#endif // __TMUTAMT_H__
//eof
//
|
