1 /*
2  * Copyright (c) 2014-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 #include <string>
34 
35 class CFloatingPointParameterType : public CParameterType
36 {
37 public:
38     CFloatingPointParameterType(const std::string &strName);
39 
40     virtual bool fromXml(const CXmlElement &xmlElement, CXmlSerializingContext &serializingContext);
41     virtual void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const;
42 
43     virtual void handleValueSpaceAttribute(
44         CXmlElement &xmlConfigurableElementSettingsElement,
45         CConfigurationAccessContext &configurationAccessContext) const;
46 
47     virtual bool toBlackboard(const std::string &strValue, uint32_t &uiValue,
48                               CParameterAccessContext &parameterAccessContext) const;
49     virtual bool fromBlackboard(std::string &strValue, const uint32_t &uiValue,
50                                 CParameterAccessContext &parameterAccessContext) const;
51     virtual bool toBlackboard(double dUserValue, uint32_t &uiValue,
52                               CParameterAccessContext &parameterAccessContext) const;
53     virtual bool fromBlackboard(double &dUserValue, uint32_t uiValue,
54                                 CParameterAccessContext &parameterAccessContext) const;
55 
56     virtual void showProperties(std::string &strResult) const;
57 
58     virtual std::string getKind() const;
59 
60 private:
61     typedef CParameterType base;
62 
63     /**
64      * Format an out of range error.
65      *
66      * @param[in] strValue the user provided value
67      * @param[in,out] parameterAccessContext Parameter Access Context
68      */
69     void setOutOfRangeError(const std::string &strValue,
70                             CParameterAccessContext &parameterAccessContext) const;
71 
72     /**
73      * Check value validity against range.
74      *
75      * @param[in] fValue the user interpreted value
76      * @return true if data is valid against range, false otherwise
77      */
78     bool checkValueAgainstRange(float fValue) const;
79     /**
80      * Check value validity against range.
81      *
82      * @param[in] dValue the user interpreted value (as double)
83      * @return true if data is valid against range, false otherwise
84      */
85     bool checkValueAgainstRange(double dValue) const;
86 
87     /** Bounds */
88     float _fMin{std::numeric_limits<float>::lowest()};
89     float _fMax{std::numeric_limits<float>::max()};
90 };
91