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