IJobQueueManager.h

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ImtCore-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QByteArray>
#include <QtCore/QList>
 
// ImtCore includes
#include <imtbase/ICollectionInfo.h>
#include <imtbase/IReferenceCollection.h>
 
 
namespace iprm
{
       class IParamsSet;
       class IOptionsList;
}
 
 
namespace ilog
{
       class IMessageConsumer;
}
 
 
 
namespace imthype
{
 
 
class IJobSchedulerParams;
class IJobOutput;
 
 
class IJobQueueManager: virtual public imtbase::ICollectionInfo
{
public:
       typedef iprm::IParamsSetSharedPtr ParamsPtr;
 
       enum ProcessingStatus
       {
              PS_NONE,
              
              PS_WAITING_FOR_ACCEPTING,
 
              PS_WAITING_FOR_PROCESSING,
 
              PS_RUNNING,
 
              PS_CANCELING,
 
              PS_RETRIEVING_RESULTS,
 
              PS_CANCELED,
 
              PS_REJECTED,
 
              PS_FINISHED
       };
 
       I_DECLARE_ENUM(ProcessingStatus, PS_NONE, PS_WAITING_FOR_ACCEPTING, PS_WAITING_FOR_PROCESSING, PS_RUNNING, PS_CANCELING, PS_RETRIEVING_RESULTS, PS_CANCELED, PS_REJECTED, PS_FINISHED);
 
       struct JobStatusInfo: public NotifierInfo
       {
              ProcessingStatus status;
       };
       static const QByteArray CN_JOB_STATUS_CHANGED;
 
       struct JobProgressInfo : public NotifierInfo
       {
              double progress;
       };
       static const QByteArray CN_JOB_PROGRESS_CHANGED;
 
       typedef NotifierInfo JobResultInfo;
       static const QByteArray CN_JOB_RESULT_CHANGED;
 
       enum JobFlags
       {
              JF_RESUMABLE = 1,
 
              JF_CANCELABLE = 2
       };
 
       virtual const iprm::IOptionsList* GetSupportedTasks() const = 0;
 
       virtual QByteArray GetTaskTypeId(const QByteArray& jobId) const = 0;
 
       virtual iprm::IParamsSetUniquePtr CreateJobParameters(
                            const QByteArray& contextId,
                            const QByteArray& taskTypeId,
                            const iprm::IParamsSet* defaultParamPtr) const = 0;
 
       virtual QByteArray InsertNewJobIntoQueue(
                            const QByteArray& contextId,
                            const QByteArray& typeId,
                            const imtbase::IReferenceCollection& input,
                            const iprm::IParamsSet* jobProcessingParamsPtr,
                            const IJobSchedulerParams* schedulerParamsPtr = nullptr,
                            ilog::IMessageConsumer* logPtr = nullptr) = 0;
 
       virtual bool CancelJob(const QByteArray& jobId) = 0;
 
       virtual bool ResumeJob(const QByteArray& jobId) = 0;
 
       virtual bool RemoveJob(const QByteArray& jobId) = 0;
 
       virtual bool GetJobConfiguration(
                            const QByteArray& jobId,
                            ParamsPtr& processingParamsPtr,
                            imtbase::IReferenceCollection& input) const = 0;
 
       virtual ProcessingStatus GetProcessingStatus(const QByteArray& jobId) const = 0;
 
       virtual bool SetProcessingStatus(const QByteArray& jobId, ProcessingStatus status) = 0;
       
       virtual double GetProgress(const QByteArray& jobId) const = 0;
 
       virtual bool SetProgress(const QByteArray& jobId, double progress) = 0;
 
       virtual bool GetJobResult(const QByteArray& jobId, IJobOutput& result) const = 0;
 
       virtual bool SetJobResult(const QByteArray& jobId, const IJobOutput& result) = 0;
};
 
 
} // namespace imthype
 
 
Q_DECLARE_METATYPE(imthype::IJobQueueManager::JobStatusInfo);
Q_DECLARE_METATYPE(imthype::IJobQueueManager::JobProgressInfo);