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 "parameter_export.h"
33
34#include "ConfigurableElement.h"
35#include "TypeElement.h"
36
37#include <list>
38#include <string>
39
40class IMapper;
41class CParameterBlackboard;
42class CParameterAccessContext;
43
44class PARAMETER_EXPORT CInstanceConfigurableElement : public CConfigurableElement
45{
46public:
47    enum Type
48    {
49        EBitParameter,
50        EBitParameterBlock,
51        EParameter,
52        EStringParameter,
53        EParameterBlock,
54        EComponent
55    };
56
57    CInstanceConfigurableElement(const std::string &strName, const CTypeElement *pTypeElement);
58
59    // Instantiated type
60    const CTypeElement *getTypeElement() const;
61
62    virtual bool getMappingData(const std::string &strKey, const std::string *&pStrValue) const;
63
64    /**
65     * Returns the mapping data associated to the type element of the current
66     * InstanceConfigurableElement, as a formatted std::string
67     *
68     * @return A std::string containing the formatted mapping
69     */
70    std::string getFormattedMapping() const override;
71
72    // From CElement
73    virtual std::string getKind() const;
74    std::string getXmlElementName() const override;
75
76    // Syncer to/from HW
77    void setSyncer(ISyncer *pSyncer);
78    void unsetSyncer();
79
80    // Type
81    virtual Type getType() const = 0;
82
83    // Mapping execution
84    bool map(IMapper &mapper, std::string &strError);
85
86    // Element properties
87    virtual void showProperties(std::string &strResult) const;
88
89    // Scalar or Array?
90    bool isScalar() const;
91
92    // Array Length
93    size_t getArrayLength() const;
94
95    virtual void structureToXml(CXmlElement &xmlElement,
96                                CXmlSerializingContext &serializingContext) const;
97
98protected:
99    // Syncer
100    virtual ISyncer *getSyncer() const;
101    // Syncer set (descendant)
102    virtual void fillSyncerSetFromDescendant(CSyncerSet &syncerSet) const;
103
104    /**
105     * Performs the sync if the AutoSync is enabled.
106     * If AutoSync is disabled, any call to sync will returns true, even if synchronization has not
107     * been done. It will happen when the AutoSync will be switched back on.
108     *
109     * @param[in,out] parameterAccessContext Parameter access context object
110     *
111     * @return true if the synchronization succeded or if the AutoSync is off, false otherwise.
112     */
113    bool sync(CParameterAccessContext &parameterAccessContext) const;
114
115    // Check parameter access path well formed for leaf elements
116    static bool checkPathExhausted(CPathNavigator &pathNavigator,
117                                   utility::ErrorContext &errorContext);
118
119private:
120    // Type Element
121    const CTypeElement *_pTypeElement;
122
123    // Sync to HW
124    ISyncer *_pSyncer{nullptr};
125};
126