tests/auto/xmlpatternssdk/TestSuiteResult.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  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