• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 <stdint.h>
33 #include <vector>
34 
35 #include "InstanceConfigurableElement.h"
36 
37 class CParameterAccessContext;
38 class CConfigurationAccessContext;
39 
40 class CBaseParameter : public CInstanceConfigurableElement
41 {
42 public:
43     CBaseParameter(const std::string &strName, const CTypeElement *pTypeElement);
44 
45     // XML configuration settings parsing/composing
46     virtual bool serializeXmlSettings(
47         CXmlElement &xmlConfigurationSettingsElementContent,
48         CConfigurationAccessContext &configurationAccessContext) const;
49 
50     // Check element is a parameter
51     virtual bool isParameter() const;
52 
53     // Boolean access
54     virtual bool access(bool &bValue, bool bSet,
55                         CParameterAccessContext &parameterAccessContext) const;
56     virtual bool access(std::vector<bool> &abValues, bool bSet,
57                         CParameterAccessContext &parameterAccessContext) const;
58 
59     // Integer Access
60     virtual bool access(uint32_t &uiValue, bool bSet,
61                         CParameterAccessContext &parameterAccessContext) const;
62     virtual bool access(std::vector<uint32_t> &auiValues, bool bSet,
63                         CParameterAccessContext &parameterAccessContext) const;
64 
65     // Signed Integer Access
66     virtual bool access(int32_t &iValue, bool bSet,
67                         CParameterAccessContext &parameterAccessContext) const;
68     virtual bool access(std::vector<int32_t> &aiValues, bool bSet,
69                         CParameterAccessContext &parameterAccessContext) const;
70 
71     // Double Access
72     virtual bool access(double &dValue, bool bSet,
73                         CParameterAccessContext &parameterAccessContext) const;
74     virtual bool access(std::vector<double> &adValues, bool bSet,
75                         CParameterAccessContext &parameterAccessContext) const;
76 
77     // String Access
78     // This one is not virtual because it is very generic. You can think if it
79     // as the client saying: "I don't care about the type, here's the value as
80     // a string - convert it yourself". Then, string-to-anything and
81     // anything-to-string methods are used to convert it into a suitable type.
82     bool access(std::string &strValue, bool bSet,
83                 CParameterAccessContext &parameterAccessContext) const;
84     virtual bool access(std::vector<std::string> &astrValues, bool bSet,
85                         CParameterAccessContext &parameterAccessContext) const;
86 
87     void structureToXml(CXmlElement &xmlElement,
88                         CXmlSerializingContext &serializingContext) const override final;
89 
90 protected:
91     // Parameter Access
92     virtual bool accessValue(CPathNavigator &pathNavigator, std::string &strValue, bool bSet,
93                              CParameterAccessContext &parameterAccessContext) const;
94 
95     // Actual value access (to be implemented by derived)
96     virtual bool doSetValue(const std::string &strValue, size_t offset,
97                             CParameterAccessContext &parameterAccessContext) const = 0;
98     virtual void doGetValue(std::string &strValue, size_t offset,
99                             CParameterAccessContext &parameterAccessContext) const = 0;
100 
101     /**
102      * Append the parameter path to the error.
103      *
104      * @param[in,out] parameterAccessContext Parameter Access Context object.
105      */
106     void appendParameterPathToError(CParameterAccessContext &parameterAccessContext) const;
107 
108 private:
109     std::string logValue(CParameterAccessContext &context) const override;
110 };
111