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 "Parameter.h"
     33 
     34 class CArrayParameter : public CParameter
     35 {
     36 public:
     37     CArrayParameter(const std::string& strName, const CTypeElement* pTypeElement);
     38 
     39     // Instantiation, allocation
     40     virtual uint32_t getFootPrint() const;
     41 
     42     // XML configuration settings parsing
     43     virtual bool serializeXmlSettings(CXmlElement& xmlConfigurationSettingsElementContent, CConfigurationAccessContext& configurationAccessContext) const;
     44 
     45     // Value access
     46     // Boolean
     47     virtual bool accessAsBooleanArray(std::vector<bool>& abValues, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     48     // Integer
     49     virtual bool accessAsIntegerArray(std::vector<uint32_t>& auiValues, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     50     // Signed Integer Access
     51     virtual bool accessAsSignedIntegerArray(std::vector<int32_t>& aiValues, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     52     // Double Access
     53     virtual bool accessAsDoubleArray(std::vector<double>& adValues, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     54     // String Access
     55     virtual bool accessAsStringArray(std::vector<std::string>& astrValues, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     56 
     57 protected:
     58     // User set/get
     59     virtual bool accessValue(CPathNavigator& pathNavigator, std::string& strValue, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     60     virtual void logValue(std::string& strValue, CErrorContext& errorContext) const;
     61     // Used for simulation and virtual subsystems
     62     virtual void setDefaultValues(CParameterAccessContext& parameterAccessContext) const;
     63 
     64     // Element properties
     65     virtual void showProperties(std::string& strResult) const;
     66 private:
     67     // Array length
     68     uint32_t getArrayLength() const;
     69     // Common set value processing
     70     bool setValues(uint32_t uiStartIndex, uint32_t uiBaseOffset, const std::string& strValue, CParameterAccessContext& parameterAccessContext) const;
     71     // Log / get values common
     72     void getValues(uint32_t uiBaseOffset, std::string& strValues, CParameterAccessContext& parameterAccessContext) const;
     73     // Index retrieval from user set/get request
     74     bool getIndex(CPathNavigator& pathNavigator, uint32_t& uiIndex, CParameterAccessContext& parameterAccessContext) const;
     75 
     76     /// Value access
     77     // Generic Access
     78     template <typename type>
     79     bool accessValues(std::vector<type>& values, bool bSet, CParameterAccessContext& parameterAccessContext) const;
     80     template <typename type>
     81     bool setValues(const std::vector<type>& values, CParameterAccessContext& parameterAccessContext) const;
     82     template <typename type>
     83     bool getValues(std::vector<type>& values, CParameterAccessContext& parameterAccessContext) const;
     84     template <typename type>
     85     bool doSet(type value, uint32_t uiOffset, CParameterAccessContext& parameterAccessContext) const;
     86     template <typename type>
     87     bool doGet(type& value, uint32_t uiOffset, CParameterAccessContext& parameterAccessContext) const;
     88 };
     89