1 /*
2  * Copyright (c) 2011-2014, Intel Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #pragma once
31 
32 #include "Element.h"
33 #include <map>
34 #include <string>
35 #include "SelectionCriterionTypeInterface.h"
36 
37 class CSelectionCriterionType : public CElement, public ISelectionCriterionTypeInterface
38 {
39     typedef std::map<std::string, int>::const_iterator NumToLitMapConstIt;
40 
41 public:
42     CSelectionCriterionType(bool bIsInclusive);
43 
44     // From ISelectionCriterionTypeInterface
45     virtual bool addValuePair(int iValue, const std::string& strValue);
46     /**
47      * Retrieve the numerical value from the std::string representation of the criterion type.
48      *
49      * @param[in] strValue: criterion type value represented as a stream. If the criterion is
50      *                      inclusive, it supports more than one criterion type value delimited
51      *                      by the "|" symbol.
52      * @param[out] iValue: criterion type value represented as an integer.
53      *
54      * @return true if integer value retrieved from the std::string one, false otherwise.
55      */
56     virtual bool getNumericalValue(const std::string& strValue, int& iValue) const;
57     virtual bool getLiteralValue(int iValue, std::string& strValue) const;
58     virtual bool isTypeInclusive() const;
59 
60     // Value list
61     std::string listPossibleValues() const;
62 
63     // Formatted state
64     virtual std::string getFormattedState(int iValue) const;
65 
66     /**
67       * Export to XML
68       *
69       * @param[in] xmlElement The XML element to export to
70       * @param[in] serializingContext The serializing context
71       *
72       */
73     virtual void toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const;
74 
75     // From CElement
76     virtual std::string getKind() const;
77 private:
78     /**
79      * Retrieve the numerical value from the std::string representation of the criterion type.
80      *
81      * @param[in] strValue: criterion type value represented as a stream. If the criterion is
82      *                      inclusive, it expects only one criterion type value.
83      * @param[out] iValue: criterion type value represented as an integer.
84      *
85      * @return true if integer value retrieved from the std::string one, false otherwise.
86      */
87     bool getAtomicNumericalValue(const std::string& strValue, int& iValue) const;
88     bool _bInclusive;
89     std::map<std::string, int> _numToLitMap;
90 
91     static const std::string _strDelimiter; /**< Inclusive criterion type delimiter. */
92 };
93 
94