Inheritance diagram for function_job:

Collaboration diagram for function_job:

Public Member Functions
	function_job (std::function< void()> func, std::string name="function_job")

VoidResult	execute () override
	Execute the job.

std::string	get_name () const override
	Get the name of the job (for logging/debugging)

Public Member Functions inherited from kcenon::common::interfaces::IJob
virtual	~IJob ()=default

virtual int	get_priority () const
	Get the priority of the job (higher = more important)

virtual	~IJob ()=default

virtual int	get_priority () const
	Get the priority of the job.

Private Attributes
std::function< void()>	func_

std::string	name_

Detailed Description

Simple function job wrapper

Examples: executor_example.cpp.

Definition at line 193 of file executor_example.cpp.

Constructor & Destructor Documentation

◆ function_job()

function_job::function_job	(	std::function< void()>	func,
		std::string	name = "function_job" )

inlineexplicit

Examples: executor_example.cpp.

Definition at line 195 of file executor_example.cpp.

196 : func_(std::move(func)), name_(std::move(name)) {}

function_job::name_

std::string name_

Definition executor_example.cpp:211

function_job::func_

std::function< void()> func_

Definition executor_example.cpp:210

Member Function Documentation

◆ execute()

VoidResult function_job::execute ( )

inlineoverridevirtual

Execute the job.

Returns: VoidResult indicating success or failure

Implements kcenon::common::interfaces::IJob.

Examples: executor_example.cpp.

Definition at line 198 of file executor_example.cpp.

                                  {
        try {
            func_();
            return VoidResult(std::monostate{});
        } catch (const std::exception& e) {
            return VoidResult(error_info(1, e.what(), "function_job"));
        }
    }

References func_.

◆ get_name()

std::string function_job::get_name ( ) const

inlineoverridevirtual

Get the name of the job (for logging/debugging)

Returns: Job name

Implements kcenon::common::interfaces::IJob.

Examples: executor_example.cpp.

Definition at line 207 of file executor_example.cpp.

207{ return name_; }

References name_.

Member Data Documentation

◆ func_

std::function<void()> function_job::func_

private

Examples: executor_example.cpp.

Definition at line 210 of file executor_example.cpp.

Referenced by execute().

◆ name_

std::string function_job::name_

private

Examples: executor_example.cpp.

Definition at line 211 of file executor_example.cpp.

Referenced by get_name().

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

examples/executor_example.cpp

Public Member Functions

Private Attributes