Firmware
Public Member Functions | Protected Member Functions | List of all members
ModuleParams Class Reference

C++ base class for modules/classes using configuration parameters. More...

Inheritance diagram for ModuleParams:
ListNode< ModuleParams *> Battery BlockLocalPositionEstimator CollisionPrevention Commander DataLinkLoss Ekf2 events::SendEvent FailureDetector FixedwingPositionControl FlightTask FollowTarget Geofence GpsFailure Heater launchdetection::CatapultLaunchMethod launchdetection::LaunchDetector load_mon::LoadMon Loiter ManualSmoothingXY ManualSmoothingZ Mavlink Mission Module MulticopterAttitudeControl MulticopterPositionControl Navigator ObstacleAvoidance OSDatxxxx PositionControl PrecLand PX4Accelerometer PX4Gyroscope RCLoss RTL runwaytakeoff::RunwayTakeoff Sensors Sih Simulator StraightLine TAP_ESC WeatherVane WindEstimatorModule

Public Member Functions

 ModuleParams (ModuleParams *parent)
 
void setParent (ModuleParams *parent)
 Sets the parent module. More...
 
 ModuleParams (const ModuleParams &)=delete
 
ModuleParamsoperator= (const ModuleParams &)=delete
 
 ModuleParams (ModuleParams &&)=delete
 
ModuleParamsoperator= (ModuleParams &&)=delete
 
- Public Member Functions inherited from ListNode< ModuleParams *>
void setSibling (ModuleParams * sibling)
 
const ModuleParamsgetSibling () const
 

Protected Member Functions

virtual void updateParams ()
 Call this method whenever the module gets a parameter change notification. More...
 
virtual void updateParamsImpl ()
 The implementation for this is generated with the macro DEFINE_PARAMETERS()
 

Additional Inherited Members

- Protected Attributes inherited from ListNode< ModuleParams *>
ModuleParams_sibling
 

Detailed Description

C++ base class for modules/classes using configuration parameters.

Member Function Documentation

§ setParent()

void ModuleParams::setParent ( ModuleParams parent)
inline

Sets the parent module.

This is typically not required, only in cases where the parent cannot be set via constructor.

§ updateParams()

virtual void ModuleParams::updateParams ( )
inlineprotectedvirtual

Call this method whenever the module gets a parameter change notification.

It will automatically call updateParams() for all children, which then call updateParamsImpl().

Reimplemented in PositionControl, FlightTaskAutoMapper2, and FlightTaskAutoMapper.


The documentation for this class was generated from the following file: