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 "NonCopyable.hpp"
     33 
     34 #include <cstdint>
     35 #include <string>
     36 #include <vector>
     37 
     38 class CParameterBlackboard : private utility::NonCopyable
     39 {
     40 public:
     41     // Size
     42     void setSize(size_t size);
     43     size_t getSize() const;
     44 
     45     // Single parameter access
     46     void writeInteger(const void *pvSrcData, size_t size, size_t offset);
     47     void readInteger(void *pvDstData, size_t size, size_t offset) const;
     48 
     49     void writeString(const std::string &input, size_t offset);
     50     void readString(std::string &output, size_t offset) const;
     51 
     52     void writeBuffer(const void *pvSrcData, size_t size, size_t offset);
     53     void readBuffer(void *pvDstData, size_t size, size_t offset) const;
     54 
     55     /**
     56      * Raw write the blackboard memory.
     57      *
     58      * May be used to write a configurable element's settings
     59      *
     60      * @param[in] bytes the source data bytes vector.
     61      * @param[in] offset the destination offset in the blackboard.
     62      *
     63      * Notes:
     64      *    - This function asserts that the input vector's size + the offset
     65      *      does not exceed the size of the blackboard istelf.
     66      */
     67     void writeBytes(const std::vector<uint8_t> &bytes, size_t offset);
     68 
     69     /**
     70      * Raw read the blackboard memory.
     71      *
     72      * May be used to read a configurable element's settings
     73      *
     74      * @param[out] bytes the destination data bytes vector.
     75      * @param[in] offset the source offset in the blackboard.
     76      *
     77      * Notes:
     78      *    - This function asserts that the output vector's size + the offset
     79      *      does not exceed the size of the blackboard itself.
     80      *    - The user MUST resize the output vector to exactly the number of
     81      *      elements to be read
     82      */
     83     void readBytes(std::vector<uint8_t> &bytes, size_t offset) const;
     84 
     85     // Access from/to subsystems
     86     uint8_t *getLocation(size_t offset);
     87 
     88     // Configuration handling
     89     void restoreFrom(const CParameterBlackboard *pFromBlackboard, size_t offset);
     90     void saveTo(CParameterBlackboard *pToBlackboard, size_t offset) const;
     91 
     92 private:
     93     void assertValidAccess(size_t offset, size_t size) const;
     94 
     95     using Blackboard = std::vector<uint8_t>;
     96     Blackboard mBlackboard;
     97 
     98     Blackboard::iterator atOffset(size_t offset) { return begin(mBlackboard) + offset; }
     99     Blackboard::const_iterator atOffset(size_t offset) const { return begin(mBlackboard) + offset; }
    100 };
    101