Class holding the force-torque filter settings. More...

#include <ForceTorqueFilter.hpp>

Public Types
using	NodeHandlePtr = std::shared_ptr< ros::NodeHandle >

Public Member Functions
	ForceTorqueFilter ()=default
	Default constructor. More...

	ForceTorqueFilter (const uint16_t sincFilterSize, const uint8_t chopEnable, const uint8_t skipEnable, const uint8_t fastEnable)

uint8_t	getChopEnable () const
	Gets the chopEnable variable. More...

uint8_t	getFastEnable () const
	Gets the fastEnable variable. More...

uint16_t	getSincFilterSize () const
	Gets the sincFilterSize variable. More...

uint8_t	getSkipEnable () const
	Gets the skipEnable variable. More...

bool	load (const std::string &key, NodeHandlePtr nh)
	Loads the force torque filter from the parameter server. More...

void	print () const
	Prints the existing Filter settings. More...

void	setChopEnable (const uint8_t chopEnable)
	Sets the chopEnable variable. More...

void	setFastEnable (const uint8_t fastEnable)
	Sets the fastEnable variable. More...

void	setSincFilterSize (const uint16_t sincFilterSize)
	Sets the sincFilterSize variable. More...

void	setSkipEnable (const uint8_t skipEnable)
	Sets the skipEnable variable. More...

	~ForceTorqueFilter ()=default

Private Attributes
uint8_t	chopEnable_
	The chopEnable flag. More...

uint8_t	fastEnable_
	The fastEnable flag. More...

uint16_t	sincFilterSize_
	The sincFilterSize variable. More...

uint8_t	skipEnable_
	The skipEnable flag. More...

Detailed Description

Class holding the force-torque filter settings.

Definition at line 17 of file ForceTorqueFilter.hpp.

Member Typedef Documentation

using rokubimini::configuration::ForceTorqueFilter::NodeHandlePtr = std::shared_ptr<ros::NodeHandle>

Definition at line 20 of file ForceTorqueFilter.hpp.

Constructor & Destructor Documentation

rokubimini::configuration::ForceTorqueFilter::ForceTorqueFilter ( )

default

Default constructor.

rokubimini::configuration::ForceTorqueFilter::ForceTorqueFilter	(	const uint16_t	sincFilterSize,
		const uint8_t	chopEnable,
		const uint8_t	skipEnable,
		const uint8_t	fastEnable
	)

Definition at line 7 of file ForceTorqueFilter.cpp.

rokubimini::configuration::ForceTorqueFilter::~ForceTorqueFilter ( )

default

Member Function Documentation

uint8_t rokubimini::configuration::ForceTorqueFilter::getChopEnable ( ) const

inline

Gets the chopEnable variable.

Returns: The chopEnable value.

Definition at line 87 of file ForceTorqueFilter.hpp.

uint8_t rokubimini::configuration::ForceTorqueFilter::getFastEnable ( ) const

inline

Gets the fastEnable variable.

Returns: The fastEnable value.

Definition at line 135 of file ForceTorqueFilter.hpp.

uint16_t rokubimini::configuration::ForceTorqueFilter::getSincFilterSize ( ) const

inline

Gets the sincFilterSize variable.

Returns: The sincFilterSize value.

Definition at line 63 of file ForceTorqueFilter.hpp.

uint8_t rokubimini::configuration::ForceTorqueFilter::getSkipEnable ( ) const

inline

Gets the skipEnable variable.

Returns: The skipEnable value.

Definition at line 111 of file ForceTorqueFilter.hpp.

bool rokubimini::configuration::ForceTorqueFilter::load	(	const std::string &	key,
		NodeHandlePtr	nh
	)

Loads the force torque filter from the parameter server.

Parameters

key	The key to search in the parameter server.
nh	The ROS NodeHandle to access the parameter server.

Returns: True if the force torque filter was loaded successfully.

Definition at line 13 of file ForceTorqueFilter.cpp.

void rokubimini::configuration::ForceTorqueFilter::print ( ) const

Prints the existing Filter settings.

Definition at line 52 of file ForceTorqueFilter.cpp.

void rokubimini::configuration::ForceTorqueFilter::setChopEnable ( const uint8_t chopEnable )

inline

Sets the chopEnable variable.

Parameters

chopEnable The value to set.

Definition at line 99 of file ForceTorqueFilter.hpp.

void rokubimini::configuration::ForceTorqueFilter::setFastEnable ( const uint8_t fastEnable )

inline

Sets the fastEnable variable.

Parameters

fastEnable The value to set.

Definition at line 147 of file ForceTorqueFilter.hpp.

void rokubimini::configuration::ForceTorqueFilter::setSincFilterSize ( const uint16_t sincFilterSize )

inline

Sets the sincFilterSize variable.

Parameters

sincFilterSize The value to set.

Definition at line 75 of file ForceTorqueFilter.hpp.

void rokubimini::configuration::ForceTorqueFilter::setSkipEnable ( const uint8_t skipEnable )

inline

Sets the skipEnable variable.

Parameters

skipEnable The value to set.

Definition at line 123 of file ForceTorqueFilter.hpp.

Member Data Documentation

uint8_t rokubimini::configuration::ForceTorqueFilter::chopEnable_

private

The chopEnable flag.

Definition at line 175 of file ForceTorqueFilter.hpp.

uint8_t rokubimini::configuration::ForceTorqueFilter::fastEnable_

private

The fastEnable flag.

Definition at line 191 of file ForceTorqueFilter.hpp.

uint16_t rokubimini::configuration::ForceTorqueFilter::sincFilterSize_

private

The sincFilterSize variable.

Definition at line 167 of file ForceTorqueFilter.hpp.

uint8_t rokubimini::configuration::ForceTorqueFilter::skipEnable_

private

The skipEnable flag.

Definition at line 183 of file ForceTorqueFilter.hpp.

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation