#include <BlockParam.hpp>

Inheritance diagram for control::BlockParamBase:

Collaboration diagram for control::BlockParamBase:

Public Member Functions
	BlockParamBase (Block parent, const char name, bool parent_prefix=true)
	Instantiate a block param base. More...

virtual	~BlockParamBase ()=default

virtual bool	update ()=0

const char *	getName () const

Public Member Functions inherited from ListNode< BlockParamBase *>
void	setSibling (BlockParamBase * sibling)

const BlockParamBase *	getSibling () const

Protected Attributes
param_t	_handle {PARAM_INVALID}

Protected Attributes inherited from ListNode< BlockParamBase *>
BlockParamBase *	_list_node_sibling

Detailed Description

Definition at line 54 of file BlockParam.hpp.

Constructor & Destructor Documentation

◆ BlockParamBase()

control::BlockParamBase::BlockParamBase	(	Block *	parent,
		const char *	name,
		bool	parent_prefix = `true`
	)

Instantiate a block param base.

Parameters

parent_prefix Set to true to include the parent name in the parameter name

Definition at line 49 of file BlockParam.cpp.

References _handle, control::blockNameLengthMax, control::Block::getName(), control::Block::getParams(), param_find(), and PARAM_INVALID.

Here is the call graph for this function:

◆ ~BlockParamBase()

virtual control::BlockParamBase::~BlockParamBase ( )

virtualdefault

Member Function Documentation

◆ getName()

const char* control::BlockParamBase::getName ( ) const

inline

Definition at line 66 of file BlockParam.hpp.

References _handle, and param_name().

Here is the call graph for this function:

◆ update()

virtual bool control::BlockParamBase::update ( )

pure virtual

Implemented in control::BlockParam< T >, control::BlockParam< float >, control::BlockParam< T >, control::BlockParam< float >, control::BlockParam< T >, and control::BlockParam< float >.

Referenced by control::Block::updateParams().

Here is the caller graph for this function:

Member Data Documentation

◆ _handle

param_t control::BlockParamBase::_handle {PARAM_INVALID}

protected

Definition at line 69 of file BlockParam.hpp.

Referenced by BlockParamBase(), control::BlockParam< float >::commit(), control::BlockParam< float >::commit_no_notification(), getName(), and control::BlockParam< float >::update().

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

src/lib/controllib/block/BlockParam.hpp
src/lib/controllib/block/BlockParam.cpp

Public Member Functions

Protected Attributes