Files
PX4-Autopilot/src/lib/parameters/ParamLayer.h
T
Thomas Debrunner f0dd9fa445 param: Add contained-params-bitset export interface to the param layers
Allows for efficient looping over the contained data
2023-05-31 07:45:20 +02:00

73 lines
2.6 KiB
C++

/****************************************************************************
*
* Copyright (c) 2023 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#pragma once
#include <px4_platform_common/atomic_bitset.h>
#include "atomic_transaction.h"
#include "param.h"
#include <stdlib.h>
class ParamLayer
{
public:
static constexpr param_t PARAM_COUNT = sizeof(px4::parameters) / sizeof(param_info_s);
ParamLayer(ParamLayer *parent = nullptr) : _parent(parent) {}
ParamLayer(const ParamLayer &) = delete;
ParamLayer &operator=(const ParamLayer &) = delete;
ParamLayer(ParamLayer &&) = delete;
ParamLayer &operator=(ParamLayer &&) = delete;
virtual bool store(param_t param, param_value_u value) = 0;
virtual bool contains(param_t param) const = 0;
virtual px4::AtomicBitset<PARAM_COUNT> containedAsBitset() const = 0;
virtual param_value_u get(param_t param) const = 0;
virtual void reset(param_t param) = 0;
virtual void refresh(param_t param) = 0;
virtual int size() const = 0;
virtual int byteSize() const = 0;
protected:
ParamLayer *const _parent;
};