UMPS::Modules::IProcess Class Reference

A module is typically comprised of multiple processes. This defines the essential qualities that constitute a process in UMPS. More...

#include "umps/modules/process.hpp"

Inheritance diagram for UMPS::Modules::IProcess:

Public Member Functions
	IProcess ()
	Constructor.
virtual std::string	getName () const noexcept
virtual void	operator() ()
	Starts the process. More...
virtual void	start ()=0
	Starts the process.
virtual void	stop ()=0
	Stops the process.
virtual bool	isRunning () const noexcept=0
void	setStopCallback (const std::function< void()> &callback)
	Sets the stop callback if this process needs to stop the program.
void	issueStopCommand ()
	Issues the stop command by calling the callback. More...
virtual	~IProcess ()
	Destructor.

Detailed Description

A module is typically comprised of multiple processes. This defines the essential qualities that constitute a process in UMPS.

Copyright

Ben Baker (University of Utah) distributed under the MIT license.

Member Function Documentation

getName()

virtual std::string UMPS::Modules::IProcess::getName ( ) const

virtualnoexcept

Returns

The name of the process.

Reimplemented in UMPS::ProxyServices::Command::ReplierProcess, and UMPS::ProxyBroadcasts::Heartbeat::PublisherProcess.

isRunning()

virtual bool UMPS::Modules::IProcess::isRunning ( ) const

pure virtualnoexcept

Returns

True indicates the process is running.

Implemented in UMPS::ProxyServices::Command::ReplierProcess, and UMPS::ProxyBroadcasts::Heartbeat::PublisherProcess.

issueStopCommand()

void UMPS::Modules::IProcess::issueStopCommand

(

)

Issues the stop command by calling the callback.

Note

By default this will do nothing unless setStopCallback() was called.

operator()()

virtual void UMPS::Modules::IProcess::operator() ( )

virtual

Starts the process.

Note

By default this just calls start.

---

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

• include/umps/modules/process.hpp