Everything a stage execution needs, independent of any HTTP/CLI front end. More...

#include <stages.hpp>

Collaboration diagram for reusex::pipeline::StageContext:

[legend]

Public Member Functions
bool	is_cancelled () const noexcept
	True when a cancel token is present and set.

Public Attributes
std::filesystem::path	project
	Path to the .rux project the stage reads and writes.
JobStage	stage = JobStage::clouds
	Which stage to run.
std::string	parameters
	Stage parameters as a JSON object (empty string = all defaults).
const std::atomic_bool *	cancel_token = nullptr
	Cooperative cancellation flag, owned by the caller. May be null.
std::string	job_id
	Identifier of the job driving this run, or empty for a direct call.

Detailed Description

Everything a stage execution needs, independent of any HTTP/CLI front end.

Definition at line 112 of file stages.hpp.

Member Function Documentation

◆ is_cancelled()

bool reusex::pipeline::StageContext::is_cancelled ( ) const

noexcept

True when a cancel token is present and set.

Member Data Documentation

◆ cancel_token

const std::atomic_bool* reusex::pipeline::StageContext::cancel_token = nullptr

Cooperative cancellation flag, owned by the caller. May be null.

Definition at line 122 of file stages.hpp.

◆ job_id

std::string reusex::pipeline::StageContext::job_id

Identifier of the job driving this run, or empty for a direct call.

Recorded into the stage's pipeline_log.parameters under "job_id" so the durable history can be joined back to the job that caused it (#265).

Definition at line 126 of file stages.hpp.

◆ parameters

std::string reusex::pipeline::StageContext::parameters

Stage parameters as a JSON object (empty string = all defaults).

Keys mirror the option-struct fields of the underlying algorithm; unknown keys are ignored. The same string is persisted into pipeline_log.parameters.

Definition at line 120 of file stages.hpp.

◆ project

std::filesystem::path reusex::pipeline::StageContext::project

Path to the .rux project the stage reads and writes.

Definition at line 114 of file stages.hpp.

◆ stage

JobStage reusex::pipeline::StageContext::stage = JobStage::clouds

Which stage to run.

Definition at line 116 of file stages.hpp.

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

libs/reusex/include/pipeline/stages.hpp

Public Member Functions

Public Attributes