Initial import from the monolithic Qt.
[profile/ivi/qtxmlpatterns.git] / tests / auto / xmlpatternssdk / TestSuiteResult.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the test suite of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** No Commercial Usage
11 ** This file contains pre-release code and may not be distributed.
12 ** You may use this file in accordance with the terms and conditions
13 ** contained in the Technology Preview License Agreement accompanying
14 ** this package.
15 **
16 ** GNU Lesser General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU Lesser
18 ** General Public License version 2.1 as published by the Free Software
19 ** Foundation and appearing in the file LICENSE.LGPL included in the
20 ** packaging of this file.  Please review the following information to
21 ** ensure the GNU Lesser General Public License version 2.1 requirements
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23 **
24 ** In addition, as a special exception, Nokia gives you certain additional
25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27 **
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
30 **
31 **
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef PatternistSDK_TestSuiteResult_H
43 #define PatternistSDK_TestSuiteResult_H
44
45 #include <QDate>
46 #include <QString>
47
48 #include "TestResult.h"
49
50 QT_BEGIN_HEADER
51
52 QT_BEGIN_NAMESPACE
53
54 namespace QPatternistSDK
55 {
56     /**
57      * @short A collection of TestResult instances.
58      *
59      * A TestSuiteResult gathers all TestResult instances, and provides
60      * the toXML() function which serializes it all into a XQuery Test Suite
61      * result file, conforming to XQTSResult.xsd.
62      *
63      * @ingroup PatternistSDK
64      * @author Frans Englich <frans.englich@nokia.com>
65      */
66     class Q_PATTERNISTSDK_EXPORT TestSuiteResult
67     {
68     public:
69         ~TestSuiteResult();
70
71         TestSuiteResult(const QString &testSuiteVersion,
72                         const QDate &runDate,
73                         const TestResult::List &results);
74
75         /**
76          * Serializes the test results this TestSuiteResult represents,
77          * into XQTS test-suite-result document, conformant to XQTSCatalog.xsd.
78          */
79         void toXML(XMLWriter &receiver) const;
80
81     private:
82         const QString m_testSuiteVersion;
83         const QDate m_runDate;
84         const TestResult::List m_results;
85     };
86 }
87
88 QT_END_NAMESPACE
89
90 QT_END_HEADER
91
92 #endif
93 // vim: et:ts=4:sw=4:sts=4