calculation_job Class Reference

Inheritance diagram for calculation_job:

Collaboration diagram for calculation_job:

Public Member Functions
	calculation_job (int value, std::atomic< int > &result)
VoidResult	execute () override
	Execute the job.
std::string	get_name () const override
	Get the name of the job (for logging/debugging)
int	get_priority () const override
	Get the priority of the job (higher = more important)
Public Member Functions inherited from kcenon::common::interfaces::IJob
virtual	~IJob ()=default
virtual	~IJob ()=default

Private Attributes
int	value_
std::atomic< int > &	result_

Detailed Description

Example job implementation

Examples

executor_example.cpp.

Definition at line 217 of file executor_example.cpp.

Constructor & Destructor Documentation

calculation_job()

calculation_job::calculation_job ( int value, std::atomic< int > & result )

inline

Examples

executor_example.cpp.

Definition at line 219 of file executor_example.cpp.

        : value_(value), result_(result) {}

Member Function Documentation

execute()

VoidResult calculation_job::execute ( )

inlineoverridevirtual

Execute the job.

Returns

VoidResult indicating success or failure

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

Examples

executor_example.cpp.

Definition at line 222 of file executor_example.cpp.

                                  {
        try {
            // Simulate some work
            std::this_thread::sleep_for(10ms);
            result_ += value_ * value_;
            return VoidResult(std::monostate{});
        } catch (const std::exception& e) {
            return VoidResult(
                error_info(1, e.what(), "calculation_job"));
        }
    }

References result_, and value_.

get_name()

std::string calculation_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 234 of file executor_example.cpp.

                                        {
        return "calculation_job_" + std::to_string(value_);
    }

References value_.

get_priority()

int calculation_job::get_priority ( ) const

inlineoverridevirtual

Get the priority of the job (higher = more important)

Returns

Job priority (default: 0)

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

Examples

executor_example.cpp.

Definition at line 238 of file executor_example.cpp.

                                      {
        return value_; // Higher values = higher priority
    }

References value_.

Member Data Documentation

result_

std::atomic<int>& calculation_job::result_

private

Examples

executor_example.cpp.

Definition at line 244 of file executor_example.cpp.

Referenced by execute().

value_

int calculation_job::value_

private

Examples

executor_example.cpp.

Definition at line 243 of file executor_example.cpp.

Referenced by execute(), get_name(), and get_priority().

---

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

• examples/executor_example.cpp