PX4 Firmware
PX4 Autopilot Software http://px4.io
control::BlockParam< T > Class Template Referencefinal

#include <BlockParam.hpp>

Inheritance diagram for control::BlockParam< T >:
Collaboration diagram for control::BlockParam< T >:

Public Member Functions

 BlockParam (Block *block, const char *name, bool parent_prefix=true)
 
 BlockParam (Block *block, const char *name, bool parent_prefix, T &extern_val)
 
 ~BlockParam () override=default
 
 BlockParam (const BlockParam &)=delete
 
BlockParamoperator= (const BlockParam &)=delete
 
 BlockParam (BlockParam &&)=delete
 
BlockParamoperator= (BlockParam &&)=delete
 
get () const
 
bool commit ()
 
bool commit_no_notification ()
 
void set (T val)
 
bool update () override
 
template<>
 BlockParam (Block *block, const char *name, bool parent_prefix)
 
template<>
bool update ()
 
template<>
 BlockParam (Block *block, const char *name, bool parent_prefix)
 
template<>
 BlockParam (Block *block, const char *name, bool parent_prefix)
 
template<>
 BlockParam (Block *block, const char *name, bool parent_prefix, int32_t &extern_val)
 
template<>
 BlockParam (Block *block, const char *name, bool parent_prefix, float &extern_val)
 
template<>
bool update ()
 
- Public Member Functions inherited from control::BlockParamBase
 BlockParamBase (Block *parent, const char *name, bool parent_prefix=true)
 Instantiate a block param base. More...
 
virtual ~BlockParamBase ()=default
 
const char * getName () const
 
- Public Member Functions inherited from ListNode< BlockParamBase *>
void setSibling (BlockParamBase * sibling)
 
const BlockParamBase * getSibling () const
 

Protected Attributes

_val
 
- Protected Attributes inherited from control::BlockParamBase
param_t _handle {PARAM_INVALID}
 
- Protected Attributes inherited from ListNode< BlockParamBase *>
BlockParamBase * _list_node_sibling
 

Detailed Description

template<class T>
class control::BlockParam< T >

Definition at line 74 of file BlockParam.hpp.

Constructor & Destructor Documentation

◆ BlockParam() [1/9]

template<class T>
control::BlockParam< T >::BlockParam ( Block block,
const char *  name,
bool  parent_prefix = true 
)

◆ BlockParam() [2/9]

template<class T>
control::BlockParam< T >::BlockParam ( Block block,
const char *  name,
bool  parent_prefix,
T &  extern_val 
)

◆ ~BlockParam()

template<class T>
control::BlockParam< T >::~BlockParam ( )
overridedefault

◆ BlockParam() [3/9]

template<class T>
control::BlockParam< T >::BlockParam ( const BlockParam< T > &  )
delete

◆ BlockParam() [4/9]

template<class T>
control::BlockParam< T >::BlockParam ( BlockParam< T > &&  )
delete

◆ BlockParam() [5/9]

template<>
control::BlockParam< bool >::BlockParam ( Block block,
const char *  name,
bool  parent_prefix 
)

Definition at line 88 of file BlockParam.cpp.

◆ BlockParam() [6/9]

template<>
control::BlockParam< int32_t >::BlockParam ( Block block,
const char *  name,
bool  parent_prefix 
)

Definition at line 112 of file BlockParam.cpp.

◆ BlockParam() [7/9]

template<>
control::BlockParam< float >::BlockParam ( Block block,
const char *  name,
bool  parent_prefix 
)

Definition at line 120 of file BlockParam.cpp.

◆ BlockParam() [8/9]

template<>
control::BlockParam< int32_t & >::BlockParam ( Block block,
const char *  name,
bool  parent_prefix,
int32_t &  extern_val 
)

Definition at line 128 of file BlockParam.cpp.

◆ BlockParam() [9/9]

template<>
control::BlockParam< float & >::BlockParam ( Block block,
const char *  name,
bool  parent_prefix,
float &  extern_val 
)

Definition at line 136 of file BlockParam.cpp.

Member Function Documentation

◆ commit()

template<class T>
bool control::BlockParam< T >::commit ( )
inline

Definition at line 91 of file BlockParam.hpp.

◆ commit_no_notification()

template<class T>
bool control::BlockParam< T >::commit_no_notification ( )
inline

Definition at line 94 of file BlockParam.hpp.

◆ get()

template<class T>
T control::BlockParam< T >::get ( ) const
inline

Definition at line 88 of file BlockParam.hpp.

Referenced by control::BlockLimitSym::update(), and control::BlockLimit::update().

Here is the caller graph for this function:

◆ operator=() [1/2]

template<class T>
BlockParam& control::BlockParam< T >::operator= ( const BlockParam< T > &  )
delete

◆ operator=() [2/2]

template<class T>
BlockParam& control::BlockParam< T >::operator= ( BlockParam< T > &&  )
delete

◆ set()

template<class T>
void control::BlockParam< T >::set ( val)
inline

Definition at line 96 of file BlockParam.hpp.

◆ update() [1/3]

template<>
bool control::BlockParam< bool >::update ( )
virtual

Implements control::BlockParamBase.

Definition at line 96 of file BlockParam.cpp.

◆ update() [2/3]

template<class T>
bool control::BlockParam< T >::update ( )
inlineoverridevirtual

Implements control::BlockParamBase.

Definition at line 98 of file BlockParam.hpp.

◆ update() [3/3]

template<>
bool control::BlockParam< bool >::update ( )
virtual

Member Data Documentation

◆ _val

template<class T>
T control::BlockParam< T >::_val
protected

Definition at line 101 of file BlockParam.hpp.


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