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 <stdint.h> 33 34 #include "TypeElement.h" 35 36 #include <string> 37 #include <limits> 38 39 class CParameterAccessContext; 40 41 class CBitParameterType : public CTypeElement 42 { 43 public: 44 CBitParameterType(const std::string &strName); 45 46 // From IXmlSink 47 bool fromXml(const CXmlElement &xmlElement, 48 CXmlSerializingContext &serializingContext) override; 49 50 // From IXmlSource 51 void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const override; 52 /// Conversion 53 // String 54 bool toBlackboard(const std::string &strValue, uint64_t &uiValue, 55 CParameterAccessContext ¶meterAccessContext) const; 56 void fromBlackboard(std::string &strValue, const uint64_t &uiValue, 57 CParameterAccessContext ¶meterAccessContext) const; 58 // Integer 59 bool toBlackboard(uint64_t uiUserValue, uint64_t &uiValue, 60 CParameterAccessContext ¶meterAccessContext) const; 61 void fromBlackboard(uint32_t &uiUserValue, uint64_t uiValue, 62 CParameterAccessContext ¶meterAccessContext) const; 63 // Access from area configuration 64 uint64_t merge(uint64_t uiOriginData, uint64_t uiNewData) const; 65 66 // Bit Size 67 size_t getBitSize() const; 68 69 // Element properties 70 void showProperties(std::string &strResult) const override; 71 72 // CElement 73 std::string getKind() const override; 74 75 /** 76 * Get the position of the bit within the bit parameter block. 77 * It corresponds to the "pos" attribute found in the XML file. 78 * 79 * @return position of the bit. 80 */ getBitPos()81 size_t getBitPos() const { return _bitPos; } 82 private: 83 // Instantiation 84 CInstanceConfigurableElement *doInstantiate() const override; 85 // Max encodable value 86 uint64_t getMaxEncodableValue() const; 87 // Biwise mask 88 uint64_t getMask() const; 89 90 // Pos in bits 91 size_t _bitPos{0}; 92 // Size in bits 93 size_t _uiBitSize{0}; 94 // Max value 95 uint64_t _uiMax{std::numeric_limits<uint64_t>::max()}; 96 }; 97