C/C++ SDK / C++ layer · Jobs / kroys::FileJob

kroys::FileJob

An import or export job (worker thread).

Kindclass

Headerkroys/plugin.hpp

Members7

DECLARATION

Declaration

Declared in kroys/plugin.hpp.

plugin.hpp

class FileJob

REFERENCE

Members

Constructors

#explicit FileJob(const KroysFileJob* job);

Wraps the host's job.

constructor

Methods

#[[nodiscard]] std::string SourcePath() const;

The file to convert.

method

#[[nodiscard]] std::string OutputPath() const;

Write the result here.

method

#[[nodiscard]] bool Cancelled() const;

Thread-safe; call from Run.

methodwraps KroysTaskJob::IsCancelled

#void Progress(float fraction) const;

Thread-safe: progress 0..1.

methodwraps KroysFileJob::SetProgress

#void Warning(const std::string& message) const;

Thread-safe: a warning in the task's diagnostics.

methodwraps KroysFileJob::Warning

#Result Error(const std::string& message) const;

Thread-safe: fails the job with a message.

methodwraps KroysFileJob::Error

Signatures

explicit FileJob(const KroysFileJob* job);
[[nodiscard]] std::string SourcePath() const;
[[nodiscard]] std::string OutputPath() const;
[[nodiscard]] bool Cancelled() const;
void Progress(float fraction) const;
void Warning(const std::string& message) const;
Result Error(const std::string& message) const;

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.