1 /* 2 * Copyright (c) 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 "ConfigurableElement.h" 33 #include <string> 34 35 /** 36 * Base class for all Configurable Elements that can have a Mapping attribute. 37 * 38 * This class acts as an interface: it doesn't implement anything but only 39 * declares getMappingData as pure virtual fonction. 40 */ 41 class CConfigurableElementWithMapping : public CConfigurableElement { 42 public: CConfigurableElementWithMapping(const std::string & strName)43 CConfigurableElementWithMapping(const std::string& strName) : CConfigurableElement(strName) {} ~CConfigurableElementWithMapping()44 virtual ~CConfigurableElementWithMapping() {} 45 46 /** 47 * Get the value associated to a mapping key in the object's mapping 48 * 49 * @param[in] strKey the mapping key 50 * @param[out] pStrValue the associated value 51 * 52 * @return true if @p strKey is found in the object's mapping, false if not 53 */ 54 virtual bool getMappingData(const std::string& strKey, const std::string*& pStrValue) const = 0; 55 }; 56