1 /*
2  * Copyright (c) 2011-2015, 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 "SelectionCriterionType.h"
34 #include "SelectionCriterionInterface.h"
35 #include <log/Logger.h>
36 #include <NonCopyable.hpp>
37 
38 #include <string>
39 
40 class CSelectionCriterion : public CElement,
41                             public ISelectionCriterionInterface,
42                             private utility::NonCopyable
43 {
44 public:
45     CSelectionCriterion(const std::string &strName, const CSelectionCriterionType *pType,
46                         core::log::Logger &logger);
47 
48     /// From ISelectionCriterionInterface
49     // State
50     virtual void setCriterionState(int iState);
51     virtual int getCriterionState() const;
52     // Name
53     virtual std::string getCriterionName() const;
54     // Type
55     virtual const ISelectionCriterionTypeInterface *getCriterionType() const;
56     // Modified status
57     bool hasBeenModified() const;
58     void resetModifiedStatus();
59 
60     /// Match methods
61     bool is(int iState) const;
62     bool isNot(int iState) const;
63     bool includes(int iState) const;
64     bool excludes(int iState) const;
65 
66     /// User request
67     std::string getFormattedDescription(bool bWithTypeInfo, bool bHumanReadable) const;
68 
69     /// From CElement
70     virtual std::string getKind() const;
71 
72     /**
73       * Export to XML
74       *
75       * @param[in] xmlElement The XML element to export to
76       * @param[in] serializingContext The serializing context
77       *
78       */
79     virtual void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const;
80 
81 private:
82     // Current state
83     int _iState{0};
84     // Type
85     const CSelectionCriterionType *_pType;
86 
87     /** Counter to know how many modifications have been applied to this criterion */
88     uint32_t _uiNbModifications{0};
89 
90     /** Application logger */
91     core::log::Logger &_logger;
92 };
93