A symmetric limiter/ saturation. More...

#include <BlockLimitSym.hpp>

Inheritance diagram for control::BlockLimitSym:

Collaboration diagram for control::BlockLimitSym:

Public Member Functions
	BlockLimitSym (SuperBlock parent, const char name)

virtual	~BlockLimitSym ()=default

float	update (float input)

float	getMax ()

Public Member Functions inherited from control::Block
	Block (SuperBlock parent, const char name)

virtual	~Block ()=default

	Block (const Block &)=delete

Block &	operator= (const Block &)=delete

	Block (Block &&)=delete

Block &	operator= (Block &&)=delete

void	getName (char *name, size_t n)

virtual void	updateParams ()

virtual void	setDt (float dt)

float	getDt ()

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

const Block *	getSibling () const

Protected Attributes
control::BlockParamFloat	_max

Protected Attributes inherited from control::Block
const char *	_name

SuperBlock *	_parent

float	_dt {0.0f}

List< BlockParamBase * >	_params

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

Additional Inherited Members
Protected Member Functions inherited from control::Block
virtual void	updateParamsSubclass ()

SuperBlock *	getParent ()

List< BlockParamBase * > &	getParams ()

Detailed Description

A symmetric limiter/ saturation.

Same as limiter but with only a max, is used for upper limit of +max, and lower limit of -max

Definition at line 63 of file BlockLimitSym.hpp.

Constructor & Destructor Documentation

◆ BlockLimitSym()

control::BlockLimitSym::BlockLimitSym	(	SuperBlock *	parent,
		const char *	name
	)

inline

Definition at line 67 of file BlockLimitSym.hpp.

◆ ~BlockLimitSym()

virtual control::BlockLimitSym::~BlockLimitSym ( )

virtualdefault

Member Function Documentation

◆ getMax()

float control::BlockLimitSym::getMax ( )

inline

Definition at line 74 of file BlockLimitSym.hpp.

Referenced by control::blockLimitSymTest(), blockLimitSymTest(), and update().

Here is the caller graph for this function:

◆ update()

float control::BlockLimitSym::update ( float input )

Definition at line 48 of file BlockLimitSym.cpp.

References _max, control::BlockParam< T >::get(), and getMax().

Referenced by control::blockLimitSymTest(), blockLimitSymTest(), control::BlockIntegral::update(), and control::BlockIntegralTrap::update().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _max

control::BlockParamFloat control::BlockLimitSym::_max

protected

Definition at line 77 of file BlockLimitSym.hpp.

Referenced by update().

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

src/lib/controllib/BlockLimitSym.hpp
src/lib/controllib/BlockLimitSym.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members