1 /* 2 * Copyright (c) 2011-2016, 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 #include "ErrorContext.hpp" 34 #include <string> 35 36 class CParameterBlackboard; 37 38 class CParameterAccessContext : public utility::ErrorContext 39 { 40 public: 41 CParameterAccessContext(std::string &strError, CParameterBlackboard *pParameterBlackboard, 42 bool bValueSpaceIsRaw, bool bOutputRawFormatIsHex, 43 size_t offsetBase = 0); 44 CParameterAccessContext(std::string &strError, CParameterBlackboard *pParameterBlackboard, 45 size_t offsetBase = 0); 46 CParameterAccessContext(std::string &strError); 47 virtual ~CParameterAccessContext() = default; 48 49 // ParameterBlackboard 50 CParameterBlackboard *getParameterBlackboard(); 51 void setParameterBlackboard(CParameterBlackboard *pBlackboard); 52 53 // Value interpretation as Real or Raw 54 void setValueSpaceRaw(bool bIsRaw); 55 bool valueSpaceIsRaw() const; 56 57 /** @return true if setting serialization is requested, 58 * false if structure serialization 59 */ serializeSettings()60 virtual bool serializeSettings() const { return false; } 61 62 /** 63 * Assigns Output Raw Format for user get value interpretation. 64 * 65 * @param[in] bIsHex "true" for hexadecimal, "false" for decimal 66 * 67 */ 68 void setOutputRawFormat(bool bIsHex); 69 /** 70 * Returns Output Raw Format for user get value interpretation. 71 * 72 * @return "true" for hexadecimal, "false" for decimal 73 * 74 */ 75 bool outputRawFormatIsHex() const; 76 77 // Automatic synchronization to HW 78 void setAutoSync(bool bAutoSync); 79 bool getAutoSync() const; 80 81 // Base offset for blackboard access 82 void setBaseOffset(size_t baseOffset); 83 size_t getBaseOffset() const; 84 85 private: 86 // Blackboard 87 CParameterBlackboard *_pParameterBlackboard{nullptr}; 88 // Value space 89 bool _bValueSpaceIsRaw{false}; 90 // Output Raw Format 91 bool _bOutputRawFormatIsHex{false}; 92 // Automatic synchronization to HW 93 bool _bAutoSync{true}; 94 // Base offset where parameters are stored in configuration blackboards 95 size_t _uiBaseOffset{0}; 96 }; 97