rtctk::componentFramework::ThreadActivity Class Reference

Class that handles state machine activities. More...

#include <threadActivity.hpp>

Inheritance diagram for rtctk::componentFramework::ThreadActivity:

Public Types
using	ActivityMethod = std::function<void(StopToken)>
using	SuccessMethod = std::function<void()>
using	FailureMethod = std::function<void(std::exception_ptr)>

Public Member Functions
	ThreadActivity (const std::string &id, ActivityMethod activity, SuccessMethod on_success=nullptr, FailureMethod on_failure=nullptr)
	~ThreadActivity () override
	ThreadActivity (const ThreadActivity &)=delete
ThreadActivity &	operator= (const ThreadActivity &)=delete
void	start (scxml4cpp::Context *c) override
void	stop (scxml4cpp::Context *c) override

Detailed Description

Class that handles state machine activities.

Member Typedef Documentation

ActivityMethod

using rtctk::componentFramework::ThreadActivity::ActivityMethod = std::function<void(StopToken)>

FailureMethod

using rtctk::componentFramework::ThreadActivity::FailureMethod = std::function<void(std::exception_ptr)>

SuccessMethod

using rtctk::componentFramework::ThreadActivity::SuccessMethod = std::function<void()>

Constructor & Destructor Documentation

ThreadActivity() [1/2]

rtctk::componentFramework::ThreadActivity::ThreadActivity	(	const std::string &	id,
		ActivityMethod	activity,
		SuccessMethod	on_success = nullptr,
		FailureMethod	on_failure = nullptr )

~ThreadActivity()

rtctk::componentFramework::ThreadActivity::~ThreadActivity ( )

override

ThreadActivity() [2/2]

rtctk::componentFramework::ThreadActivity::ThreadActivity ( const ThreadActivity & )

delete

Member Function Documentation

operator=()

ThreadActivity & rtctk::componentFramework::ThreadActivity::operator= ( const ThreadActivity & )

delete

start()

void rtctk::componentFramework::ThreadActivity::start ( scxml4cpp::Context * c )

override

stop()

void rtctk::componentFramework::ThreadActivity::stop ( scxml4cpp::Context * c )

override

---

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

• componentFramework/rtcComponent/lib/src/threadActivity.hpp
• componentFramework/rtcComponent/lib/src/threadActivity.cpp