Home | History | Annotate | Download | only in parameter 
      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     virtual bool fromXml(const CXmlElement &xmlElement, CXmlSerializingContext &serializingContext);
     48 
     49     // From IXmlSource
     50     virtual void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const;
     51     /// Conversion
     52     // String
     53     bool toBlackboard(const std::string &strValue, uint64_t &uiValue,
     54                       CParameterAccessContext &parameterAccessContext) const;
     55     void fromBlackboard(std::string &strValue, const uint64_t &uiValue,
     56                         CParameterAccessContext &parameterAccessContext) const;
     57     // Integer
     58     bool toBlackboard(uint64_t uiUserValue, uint64_t &uiValue,
     59                       CParameterAccessContext &parameterAccessContext) const;
     60     void fromBlackboard(uint32_t &uiUserValue, uint64_t uiValue,
     61                         CParameterAccessContext &parameterAccessContext) const;
     62     // Access from area configuration
     63     uint64_t merge(uint64_t uiOriginData, uint64_t uiNewData) const;
     64 
     65     // Bit Size
     66     size_t getBitSize() const;
     67 
     68     // Element properties
     69     virtual void showProperties(std::string &strResult) const;
     70 
     71     // CElement
     72     virtual std::string getKind() const;
     73 
     74     /**
     75      * Get the position of the bit within the bit parameter block.
     76      * It corresponds to the "pos" attribute found in the XML file.
     77      *
     78      * @return position of the bit.
     79      */
     80     size_t getBitPos() const { return _bitPos; }
     81 private:
     82     // Instantiation
     83     virtual CInstanceConfigurableElement *doInstantiate() const;
     84     // Max encodable value
     85     uint64_t getMaxEncodableValue() const;
     86     // Biwise mask
     87     uint64_t getMask() const;
     88     // Check data has no bit set outside available range
     89     bool isEncodable(uint64_t uiData) const;
     90 
     91     // Pos in bits
     92     size_t _bitPos{0};
     93     // Size in bits
     94     size_t _uiBitSize{0};
     95     // Max value
     96     uint64_t _uiMax{std::numeric_limits<uint64_t>::max()};
     97 };
     98