HeartbeatComponentPlugin Class Reference

#include <RobotAPI/libraries/RobotAPIComponentPlugins/HeartbeatComponentPlugin.h>

Inheritance diagram for HeartbeatComponentPlugin:

Public Member Functions
void	heartbeat ()
	Sends out a heartbeat using the default config. More...
void	heartbeatOnChannel (const std::string &channelName)
	Sends out a heartbeat for a subchannel. More...
void	signUp (const armarx::core::time::Duration &warning, const armarx::core::time::Duration &error, const std::vector< std::string > &aliases={}, const std::string &description="")
	register component to heartbeat More...
void	signUp (const RobotHealthHeartbeatArgs &args)
	register component to heartbeat, possibly with different component name More...
void	signUp (const std::string &channelName, const armarx::core::time::Duration &warning, const armarx::core::time::Duration &error, const std::vector< std::string > &aliases={}, const std::string &description="")
	register component to heartbeat More...
void	signUp (const std::string &channelName="", const std::vector< std::string > &aliases={}, const std::string &description="")
	register component to heartbeat More...
Public Member Functions inherited from ManagedIceObjectPlugin
ManagedIceObject &	parent ()
template<class T >
T &	parent ()
const ManagedIceObject &	parent () const
template<class T >
const T &	parent () const
template<class T >
bool	parentDerives () const
virtual	~ManagedIceObjectPlugin ()=default

Protected Member Functions
void	postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
void	postOnConnectComponent () override
void	postOnInitComponent () override
void	preOnInitComponent () override
Protected Member Functions inherited from ComponentPlugin
virtual void	componentPropertiesUpdated (const std::set< std::string > &changedProperties)
	ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
Protected Member Functions inherited from ManagedIceObjectPlugin
template<class PluginT , class... ParamsT>
PluginT *	addPlugin (const std::string prefix="", ParamsT &&... params)
template<class PluginT , class... ParamsT>
void	addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&... params)
template<class PluginT , class... ParamsT>
void	addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&... params)
void	addPluginDependency (ManagedIceObjectPlugin *dependedOn)
void	addPluginDependency (std::experimental::observer_ptr< ManagedIceObjectPlugin > dependedOn)
std::string	makePropertyName (const std::string &name)
	ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
virtual void	postOnDisconnectComponent ()
virtual void	postOnExitComponent ()
const std::string &	prefix () const
virtual void	preOnConnectComponent ()
virtual void	preOnDisconnectComponent ()
virtual void	preOnExitComponent ()

Detailed Description

Definition at line 33 of file HeartbeatComponentPlugin.h.

Member Function Documentation

heartbeat()

void heartbeat

(

)

Sends out a heartbeat using the default config.

Definition at line 80 of file HeartbeatComponentPlugin.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

heartbeatOnChannel()

void heartbeatOnChannel

(

const std::string &

channelName

)

Sends out a heartbeat for a subchannel.

Note: You must call configureHeartbeatChannel(...) first to register the channel config!

Parameters

channel

Identifier of the heartbeat channel

Definition at line 95 of file HeartbeatComponentPlugin.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( PropertyDefinitionsPtr &  properties )

overrideprotectedvirtual

Reimplemented from ComponentPlugin.

Definition at line 138 of file HeartbeatComponentPlugin.cpp.

Here is the call graph for this function:

postOnConnectComponent()

void postOnConnectComponent ( )

overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 132 of file HeartbeatComponentPlugin.cpp.

postOnInitComponent()

void postOnInitComponent ( )

overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 122 of file HeartbeatComponentPlugin.cpp.

Here is the call graph for this function:

preOnInitComponent()

void preOnInitComponent ( )

overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 110 of file HeartbeatComponentPlugin.cpp.

signUp() [1/4]

void signUp	(	const armarx::core::time::Duration &	warning,
		const armarx::core::time::Duration &	error,
		const std::vector< std::string > &	aliases = {},
		const std::string &	description = ""
	)

register component to heartbeat

Definition at line 44 of file HeartbeatComponentPlugin.cpp.

Here is the call graph for this function:

signUp() [2/4]

void signUp

(

const RobotHealthHeartbeatArgs &

args

)

register component to heartbeat, possibly with different component name

Definition at line 59 of file HeartbeatComponentPlugin.cpp.

Here is the call graph for this function:

signUp() [3/4]

void signUp	(	const std::string &	channelName,
		const armarx::core::time::Duration &	warning,
		const armarx::core::time::Duration &	error,
		const std::vector< std::string > &	aliases = {},
		const std::string &	description = ""
	)

register component to heartbeat

Definition at line 26 of file HeartbeatComponentPlugin.cpp.

Here is the call graph for this function:

signUp() [4/4]

void signUp	(	const std::string &	channelName = "",
		const std::vector< std::string > &	aliases = {},
		const std::string &	description = ""
	)

register component to heartbeat

Definition at line 14 of file HeartbeatComponentPlugin.cpp.

Here is the caller graph for this function:

---

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

• RobotAPI/libraries/RobotAPIComponentPlugins/HeartbeatComponentPlugin.h
• RobotAPI/libraries/RobotAPIComponentPlugins/HeartbeatComponentPlugin.cpp