summaryrefslogtreecommitdiffstats
path: root/parameter/ConfigurableElementWithMapping.h
diff options
context:
space:
mode:
authorDavid Wagner <david.wagner@intel.com>2014-03-05 10:55:15 +0100
committerMattijs Korpershoek <mattijsx.korpershoek@intel.com>2014-06-24 11:51:18 +0200
commit01c7495e66caea59165316bc025a69cce1383311 (patch)
treef7a7b1732f69dfd118f4dc0dc0021eb2b0d13bff /parameter/ConfigurableElementWithMapping.h
parentc4dd2ae2f070333da2917a93e30b3557caa38760 (diff)
downloadexternal_parameter-framework-01c7495e66caea59165316bc025a69cce1383311.zip
external_parameter-framework-01c7495e66caea59165316bc025a69cce1383311.tar.gz
external_parameter-framework-01c7495e66caea59165316bc025a69cce1383311.tar.bz2
Support context mapping at Subsystem level
BZ: 176942 Add a class (ConfigurableMappingElement) handling the mapping; to be derived by all classes that can contain mapping. ConfigurableMappingElement derives from ConfigurableElement. Until now, the only child of ConfigurableElement that could have mapping was InstanceConfigurableElement (through TypeElement, that contains all information related to its type). Now, both InstanceConfigurableElement and Subsystem derive from ConfigurableMappingElement. That way, Subsystem XML elements can now have a "Mapping" attribute, propagated to all Elements in the tree. The Subsystem.xsd schema is updated in that regard. Only context mapping is relevant at the Subsystem-level (as opposed to instantiation mapping). If an instantiation mapping is set in the Subsystem, it is silently ignored. Change-Id: I3c09959bc5e3d18c5a4d354e498d69cc5489a247 Signed-off-by: David Wagner <david.wagner@intel.com> Signed-off-by: Mattijs Korpershoek <mattijsx.korpershoek@intel.com>
Diffstat (limited to 'parameter/ConfigurableElementWithMapping.h')
-rw-r--r--parameter/ConfigurableElementWithMapping.h55
1 files changed, 55 insertions, 0 deletions
diff --git a/parameter/ConfigurableElementWithMapping.h b/parameter/ConfigurableElementWithMapping.h
new file mode 100644
index 0000000..d241cea
--- /dev/null
+++ b/parameter/ConfigurableElementWithMapping.h
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2014, Intel Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation and/or
+ * other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#pragma once
+
+#include "ConfigurableElement.h"
+#include <string>
+
+/**
+ * Base class for all Configurable Elements that can have a Mapping attribute.
+ *
+ * This class acts as an interface: it doesn't implement anything but only
+ * declares getMappingData as pure virtual fonction.
+ */
+class CConfigurableElementWithMapping : public CConfigurableElement {
+public:
+ CConfigurableElementWithMapping(const string& strName) : CConfigurableElement(strName) {}
+ virtual ~CConfigurableElementWithMapping() {}
+
+ /**
+ * Get the value associated to a mapping key in the object's mapping
+ *
+ * @param[in] strKey the mapping key
+ * @param[out] pStrValue the associated value
+ *
+ * @return true if @p strKey is found in the object's mapping, false if not
+ */
+ virtual bool getMappingData(const std::string& strKey, const std::string*& pStrValue) const = 0;
+};