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 "ParameterType.h"
     33 
     34 #include <list>
     35 #include <string>
     36 
     37 class CEnumParameterType : public CParameterType
     38 {
     39 public:
     40     CEnumParameterType(const std::string& strName);
     41 
     42     // From IXmlSink
     43     virtual bool fromXml(const CXmlElement& xmlElement, CXmlSerializingContext& serializingContext);
     44 
     45     // From IXmlSource
     46     virtual void toXml(CXmlElement& xmlElement, CXmlSerializingContext& serializingContext) const;
     47 
     48     /// Conversion
     49     // String
     50     virtual bool toBlackboard(const std::string& strValue, uint32_t& uiValue, CParameterAccessContext& parameterAccessContext) const;
     51     virtual bool fromBlackboard(std::string& strValue, const uint32_t& uiValue, CParameterAccessContext& parameterAccessContext) const;
     52     // Integer
     53     virtual bool toBlackboard(int32_t iUserValue, uint32_t& uiValue, CParameterAccessContext& parameterAccessContext) const;
     54     virtual bool fromBlackboard(int32_t& iUserValue, uint32_t uiValue, CParameterAccessContext& parameterAccessContext) const;
     55 
     56     // Default value handling (simulation only)
     57     virtual uint32_t getDefaultValue() const;
     58 
     59     // Element properties
     60     virtual void showProperties(std::string& strResult) const;
     61 
     62     // CElement
     63     virtual std::string getKind() const;
     64 private:
     65     // Returns true if children dynamic creation is to be dealt with
     66     virtual bool childrenAreDynamic() const;
     67     // Check std::string is a number
     68     static bool isNumber(const std::string& strValue);
     69 
     70     // Literal - numerical conversions
     71     bool getLiteral(int32_t iNumerical, std::string& strLiteral) const;
     72     bool getNumerical(const std::string& strLiteral, int& iNumerical) const;
     73 
     74     // Numerical validity
     75     bool isValid(int iNumerical, CParameterAccessContext& parameterAccessContext) const;
     76 
     77     // Range validity
     78     bool checkValueAgainstRange(const std::string& strValue, int64_t value, CParameterAccessContext& parameterAccessContext, bool bHexaValue, bool bConversionSucceeded) const;
     79 };
     80