1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 //
43 //  W A R N I N G
44 //  -------------
45 //
46 // This file is not part of the Qt API.  It exists purely as an
47 // implementation detail.  This header file may change from version to
48 // version without notice, or even be removed.
49 //
50 // We mean it.
51 
52 #ifndef Patternist_DayTimeDuration_H
53 #define Patternist_DayTimeDuration_H
54 
55 #include "qabstractduration_p.h"
56 #include "qitem_p.h"
57 
58 QT_BEGIN_HEADER
59 
60 QT_BEGIN_NAMESPACE
61 
62 namespace QPatternist
63 {
64     /**
65      * @short Implements the value instance of the @c xs:dayTimeDuration type.
66      *
67      * @author Frans Englich <frans.englich@nokia.com>
68      * @ingroup Patternist_xdm
69      */
70     class DayTimeDuration : public AbstractDuration
71     {
72     public:
73 
74         typedef QExplicitlySharedDataPointer<DayTimeDuration> Ptr;
75 
76         /**
77          * Creates an instance from the lexical representation @p string.
78          */
79         static DayTimeDuration::Ptr fromLexical(const QString &string);
80 
81         static DayTimeDuration::Ptr fromComponents(const bool isPositive,
82                                                    const DayCountProperty days,
83                                                    const HourProperty hours,
84                                                    const MinuteProperty minutes,
85                                                    const SecondProperty seconds,
86                                                    const MSecondProperty mseconds);
87         /**
88          * Creates a DayTimeDuration that has the value expressed in seconds @p secs
89          * and milli seconds @p msecs. The signedness of @p secs communicates
90          * whether this DayTimeDuration is positive or negative. @p msecs must always
91          * be positive.
92          */
93         static DayTimeDuration::Ptr fromSeconds(const SecondCountProperty secs,
94                                                 const MSecondProperty msecs = 0);
95 
96         virtual ItemType::Ptr type() const;
97         virtual QString stringValue() const;
98 
99         /**
100          * @returns always 0.
101          */
102         virtual YearProperty years() const;
103 
104         /**
105          * @returns always 0.
106          */
107         virtual MonthProperty months() const;
108         virtual DayCountProperty days() const;
109         virtual HourProperty hours() const;
110         virtual MinuteProperty minutes() const;
111         virtual MSecondProperty mseconds() const;
112         virtual SecondProperty seconds() const;
113 
114         /**
115          * @returns the value of this xs:dayTimeDuration
116          * in milli seconds.
117          * @see <a href="http://www.w3.org/TR/xpath-functions/#dt-dayTimeDuration">XQuery 1.0
118          * and XPath 2.0 Functions and Operators, 10.3.2.2 Calculating the value of a
119          * xs:dayTimeDuration from the lexical representation</a>
120          */
121         virtual Value value() const;
122 
123         /**
124          * Creates a DayTimeDuration containing the value @p val. @p val is
125          * expressed in milli seconds.
126          *
127          * If @p val is zero, is CommonValues::DayTimeDurationZero returned.
128          */
129         virtual Item fromValue(const Value val) const;
130 
131     protected:
132         friend class CommonValues;
133 
134         DayTimeDuration(const bool isPositive,
135                         const DayCountProperty days,
136                         const HourProperty hours,
137                         const MinuteProperty minutes,
138                         const SecondProperty seconds,
139                         const MSecondProperty mseconds);
140 
141     private:
142         const DayCountProperty  m_days;
143         const HourProperty      m_hours;
144         const MinuteProperty    m_minutes;
145         const SecondProperty    m_seconds;
146         const MSecondProperty   m_mseconds;
147     };
148 }
149 
150 QT_END_NAMESPACE
151 
152 QT_END_HEADER
153 
154 #endif
155