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 #include "StringParameter.h"
31 #include "StringParameterType.h"
32 #include "ParameterAccessContext.h"
33 #include "ConfigurationAccessContext.h"
34 #include "ParameterBlackboard.h"
35 
36 #define base CBaseParameter
37 
38 using std::string;
39 
CStringParameter(const string & strName,const CTypeElement * pTypeElement)40 CStringParameter::CStringParameter(const string& strName, const CTypeElement* pTypeElement) : base(strName, pTypeElement)
41 {
42 }
43 
getType() const44 CInstanceConfigurableElement::Type CStringParameter::getType() const
45 {
46     return EStringParameter;
47 }
48 
getFootPrint() const49 uint32_t CStringParameter::getFootPrint() const
50 {
51     return getSize();
52 }
53 
getSize() const54 uint32_t CStringParameter::getSize() const
55 {
56     return static_cast<const CStringParameterType*>(getTypeElement())->getMaxLength() + 1;
57 }
58 
59 // Used for simulation and virtual subsystems
setDefaultValues(CParameterAccessContext & parameterAccessContext) const60 void CStringParameter::setDefaultValues(CParameterAccessContext& parameterAccessContext) const
61 {
62     // Write blackboard
63     CParameterBlackboard* pBlackboard = parameterAccessContext.getParameterBlackboard();
64 
65     pBlackboard->writeString("", getOffset());
66 }
67 
68 // Actual parameter access (tuning)
doSetValue(const string & strValue,uint32_t uiOffset,CParameterAccessContext & parameterAccessContext) const69 bool CStringParameter::doSetValue(const string& strValue, uint32_t uiOffset, CParameterAccessContext& parameterAccessContext) const
70 {
71     if (strValue.length() >= getSize()) {
72 
73         parameterAccessContext.setError("Maximum length exceeded");
74 
75         return false;
76     }
77 
78     // Write blackboard
79     CParameterBlackboard* pBlackboard = parameterAccessContext.getParameterBlackboard();
80 
81     pBlackboard->writeString(strValue, uiOffset);
82 
83     return true;
84 }
85 
doGetValue(string & strValue,uint32_t uiOffset,CParameterAccessContext & parameterAccessContext) const86 void CStringParameter::doGetValue(string& strValue, uint32_t uiOffset, CParameterAccessContext& parameterAccessContext) const
87 {
88     parameterAccessContext.getParameterBlackboard()->readString(strValue, uiOffset);
89 }
90