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 "ParameterType.h"
33 
34 #include <string>
35 
36 class CEnumParameterType : public CParameterType
37 {
38 public:
39     CEnumParameterType(const std::string &strName);
40 
41     // From IXmlSink
42     virtual bool fromXml(const CXmlElement &xmlElement, CXmlSerializingContext &serializingContext);
43 
44     // From IXmlSource
45     virtual void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const;
46 
47     /// Conversion
48     // String
49     virtual bool toBlackboard(const std::string &strValue, uint32_t &uiValue,
50                               CParameterAccessContext &parameterAccessContext) const;
51     virtual bool fromBlackboard(std::string &strValue, const uint32_t &uiValue,
52                                 CParameterAccessContext &parameterAccessContext) const;
53     // Integer
54     virtual bool toBlackboard(int32_t iUserValue, uint32_t &uiValue,
55                               CParameterAccessContext &parameterAccessContext) const;
56     virtual bool fromBlackboard(int32_t &iUserValue, uint32_t uiValue,
57                                 CParameterAccessContext &parameterAccessContext) const;
58 
59     // Default value handling (simulation only)
60     virtual uint32_t getDefaultValue() const;
61 
62     // Element properties
63     virtual void showProperties(std::string &strResult) const;
64 
65     // CElement
66     virtual std::string getKind() const;
67 
68 private:
69     // Specialized version of toBlackboard in case the access context is in raw
70     // value space
71     bool toBlackboardFromRaw(const std::string &strUserValue, uint32_t &uiValue,
72                              CParameterAccessContext &parameterAccessContext) const;
73 
74     // Returns true if children dynamic creation is to be dealt with
75     virtual bool childrenAreDynamic() const;
76 
77     // Literal - numerical conversions
78     bool getLiteral(int32_t iNumerical, std::string &strLiteral) const;
79     bool getNumerical(const std::string &strLiteral, int &iNumerical) const;
80 
81     // Numerical validity
82     bool checkValueAgainstSpace(int32_t iNumerical) const;
83 
84     int32_t getMin() const;
85     int32_t getMax() const;
86 };
87