mauve::runtime::WithHook Struct Reference

Objects with hooks. More...

#include <WithHook.hpp>

Inheritance diagram for mauve::runtime::WithHook:

Protected Member Functions
virtual void	cleanup_hook ()
	Hook function called when cleaning the shell. More...
virtual bool	configure_hook ()
	Hook function called when configuring the shell. More...

Detailed Description

Objects with hooks.

Member Function Documentation

virtual void mauve::runtime::WithHook::cleanup_hook ( )

inlineprotectedvirtual

Hook function called when cleaning the shell.

Redefine this function in Shell subclasses to specify the behavior of your shell when being cleaned up.

Reimplemented in mauve::ros::PublisherCore< T, ROS_T >, mauve::ros::SubscriberComponentCore< T, ROS_T >, mauve::runtime::Architecture, and mauve::ros::SubscriberCore< ROS_T, T >.

virtual bool mauve::runtime::WithHook::configure_hook ( )

inlineprotectedvirtual

Hook function called when configuring the shell.

Redefine this function in Shell subclasses to specify the behavior of your shell when being configured.

Returns

true if configure succeeds

Reimplemented in mauve::ros::PublisherCore< T, ROS_T >, mauve::ros::RosShell< T, U >, mauve::runtime::SharedDataCore< T >, mauve::runtime::Architecture, mauve::base::PeriodicStateMachine< SHELL, CORE >, mauve::ros::SubscriberCore< ROS_T, T >, mauve::ros::SubscriberComponentCore< T, ROS_T >, and mauve::ros::RosAbstractShell.