docs/html/ITask_8cpp_source.html

#include "ITask.hpp"


#include "../../objects/FrequencySpectrum.hpp"

#include "../../objects/Signal.hpp"


namespace echomap

{


WorkerResult ITask::execute(const std::stop_token& stop_token){

    if (stop_token.stop_requested())

        throw std::runtime_error("Stop requested");


    return execute_work();

}


WorkerResult ITask::operator()()

{

    return execute({});

}


} // namespace echomap

FrequencySpectrum.hpp
FrequencySpectrum specification.

ITask.hpp
Task description interface specification.

Signal.hpp
Audio signal class specification.

echomap::ITask::operator()
WorkerResult operator()()
Alias for execute with a vacuous stop token.
Definition ITask.cpp:25

echomap::ITask::execute_work
virtual WorkerResult execute_work()=0
Execute the work and produce a WorkerResult.

echomap::ITask::execute
WorkerResult execute(const std::stop_token &stop_token)
Execute the work, subject to the given token, and produce a WorkerResult.
Definition ITask.cpp:18

echomap
The main EchoMap outermost namespace for all non-exported symbols.
Definition ActionController.hpp:20

echomap::WorkerResult
std::variant< ErrorResult, DFTResult, DownsampleResult, LoadProjectResult, LoadSignalFileResult > WorkerResult
Issued once an ITask has completed its Worker cycle.
Definition WorkerResult.hpp:27

std::runtime_error

std::stop_token::stop_requested
T stop_requested(T... args)

std::stop_token