ComponentInstance.h revision d9526499d6ab53b7d13d1434f748f6f2161c2e0a 
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 "TypeElement.h"
33
34#include <string>
35
36class CComponentType;
37
38class CComponentInstance : public CTypeElement
39{
40public:
41    CComponentInstance(const std::string& strName);
42
43    // Mapping info
44    virtual bool getMappingData(const std::string& strKey, const std::string*& pStrValue) const;
45    virtual bool hasMappingData() const;
46    /**
47     * Returns the mapping associated to the current TypeElement instance
48     *
49     * @return A std::string containing the mapping as a comma separated key value pairs
50     */
51    virtual std::string getFormattedMapping() const;
52
53    // From IXmlSink
54    virtual bool fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
55
56    // CElement
57    virtual std::string getKind() const;
58private:
59    virtual bool childrenAreDynamic() const;
60    virtual CInstanceConfigurableElement* doInstantiate() const;
61    virtual void populate(CElement* pElement) const;
62
63    // Related component type
64    const CComponentType* _pComponentType;
65};
66
67