Firmware
px4_module_params.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2018 PX4 Development Team. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 
40 #pragma once
41 
42 #include <containers/List.hpp>
43 
44 #include "px4_param.h"
45 
46 class ModuleParams : public ListNode<ModuleParams *>
47 {
48 public:
49 
50  ModuleParams(ModuleParams *parent)
51  {
52  setParent(parent);
53  }
54 
59  void setParent(ModuleParams *parent)
60  {
61  if (parent) {
62  parent->_children.add(this);
63  }
64  }
65 
66  virtual ~ModuleParams() = default;
67 
68  // Disallow copy construction and move assignment.
69  ModuleParams(const ModuleParams &) = delete;
70  ModuleParams &operator=(const ModuleParams &) = delete;
71  ModuleParams(ModuleParams &&) = delete;
72  ModuleParams &operator=(ModuleParams &&) = delete;
73 
74 protected:
79  virtual void updateParams()
80  {
81  for (const auto &child : _children) {
82  child->updateParams();
83  }
84 
86  }
87 
91  virtual void updateParamsImpl() {}
92 
93 private:
95  List<ModuleParams *> _children;
96 };
An intrusive linked list.
Definition: List.hpp:45
C++ Parameter class.
Definition: List.hpp:59
C++ base class for modules/classes using configuration parameters.
Definition: px4_module_params.h:46
void setParent(ModuleParams *parent)
Sets the parent module.
Definition: px4_module_params.h:59
virtual void updateParamsImpl()
The implementation for this is generated with the macro DEFINE_PARAMETERS()
Definition: px4_module_params.h:91
virtual void updateParams()
Call this method whenever the module gets a parameter change notification.
Definition: px4_module_params.h:79