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 "Element.h" 33 #include <string> 34 35 class CMappingData; 36 class CInstanceConfigurableElement; 37 38 class CTypeElement : public CElement 39 { 40 public: 41 CTypeElement(const std::string& strName = ""); 42 virtual ~CTypeElement(); 43 44 // Instantiation 45 CInstanceConfigurableElement* instantiate() const; 46 47 // Mapping info 48 virtual bool getMappingData(const std::string& strKey, const std::string*& pStrValue) const; 49 virtual bool hasMappingData() const; 50 51 /** 52 * Returns the mapping associated to the current TypeElement instance 53 * 54 * @return A std::string containing the mapping as a comma separated key value pairs 55 */ 56 virtual std::string getFormattedMapping() const; 57 58 // Element properties 59 virtual void showProperties(std::string& strResult) const; 60 61 // From IXmlSink 62 virtual bool fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext); 63 64 // From IXmlSource 65 virtual void toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const; 66 67 // Scalar or Array? 68 bool isScalar() const; 69 70 // Array Length 71 uint32_t getArrayLength() const; 72 73 /** 74 * Converts size optimized integer input data (int8, int16, int32) to plain int 75 * 76 * @param[in] iSizeOptimizedData the data to convert 77 * 78 * @return the data with int type 79 */ 80 virtual int toPlainInteger(int iSizeOptimizedData) const; 81 82 protected: 83 // Object creation 84 virtual void populate(CElement* pElement) const; 85 private: 86 CTypeElement(const CTypeElement&); 87 CTypeElement& operator=(const CTypeElement&); 88 // Actual instance creation 89 virtual CInstanceConfigurableElement* doInstantiate() const = 0; 90 91 // Mapping data creation and access 92 CMappingData* getMappingData(); 93 94 // For Arrays. 0 means scalar 95 uint32_t _uiArrayLength; 96 97 // Mapping info 98 CMappingData* _pMappingData; 99 }; 100