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
38using std::string;
39
40CStringParameter::CStringParameter(const string &strName, const CTypeElement *pTypeElement)
41    : base(strName, pTypeElement)
42{
43}
44
45CInstanceConfigurableElement::Type CStringParameter::getType() const
46{
47    return EStringParameter;
48}
49
50size_t CStringParameter::getFootPrint() const
51{
52    return getSize();
53}
54
55size_t CStringParameter::getSize() const
56{
57    return static_cast<const CStringParameterType *>(getTypeElement())->getMaxLength() + 1;
58}
59
60// Used for simulation and virtual subsystems
61void CStringParameter::setDefaultValues(CParameterAccessContext &parameterAccessContext) const
62{
63    // Write blackboard
64    CParameterBlackboard *pBlackboard = parameterAccessContext.getParameterBlackboard();
65
66    pBlackboard->writeString("", getOffset());
67}
68
69// Actual parameter access (tuning)
70bool CStringParameter::doSetValue(const string &strValue, size_t offset,
71                                  CParameterAccessContext &parameterAccessContext) const
72{
73    if (strValue.length() >= getSize()) {
74        using std::to_string;
75        parameterAccessContext.setError("Can not set a string of length " +
76                                        to_string(strValue.length()) + ": maximum length is " +
77                                        std::to_string(getSize() - 1));
78
79        return false;
80    }
81
82    // Write blackboard
83    CParameterBlackboard *pBlackboard = parameterAccessContext.getParameterBlackboard();
84
85    pBlackboard->writeString(strValue, offset);
86
87    return true;
88}
89
90void CStringParameter::doGetValue(string &strValue, size_t offset,
91                                  CParameterAccessContext &parameterAccessContext) const
92{
93    parameterAccessContext.getParameterBlackboard()->readString(strValue, offset);
94}
95