• OctoMY API
  • OctoMY API Reference
  • C++ Classes
  • OctoMY
  • OpalTask

    • Contents

    OpalTask Class

    Base class for all OPAL task implementations. More...

    Header: #include <OpalTask>
    Since: 1.0
    Inherited By:

    BatchCancelTask, BatchListTask, BatchStatusTask, CaptureWidgetTask, config::ui::ConfigTask, DiagnosticsCollectTask, DirectiveDeleteTask, DirectiveListTask, DirectiveNewTask, DirectivePauseTask, DirectiveResumeTask, face::OpalEvaluateExpressionTask, face::OpalLoweringCompareTask, face::OpalLoweringExplainTask, face::OpalSheetCompileStatusTask, face::OpalSpirvDumpTask, face::OpalValidateExpressionTask, FsChmodTask, FsCopyTask, GotoActivityTask, GraphicsReportTask, help::HelpFindTask, help::HelpListTask, help::HelpOpenTask, help::HelpOutlineTask, help::HelpReadTask, help::HelpSearchTask, ListActivitiesTask, LLVMShadeGetSourceTask, LLVMShadeRunTask, MonitorStatusTask, octomy::trove::opal::TroveAnswerAuthTask, octomy::trove::opal::TroveCancelTask, octomy::trove::opal::TroveContinueTask, octomy::trove::opal::TroveDispatchTask, octomy::trove::opal::TroveEnqueueTask, octomy::trove::opal::TroveFinalizeTask, octomy::trove::opal::TroveListTask, octomy::trove::opal::TroveStatusTask, octomy::trove::opal::TroveSwitchModelTask, octomy::trove::opal::TroveSyncTask, ScreenshotCopyTask, ScreenshotSaveTask, SerialCloseTask, SerialCreateConnectionTask, SerialDeleteConnectionTask, SerialDripfeedAdvanceTask, SerialDripfeedCancelTask, SerialDripfeedFileTask, SerialDripfeedPauseTask, SerialDripfeedResumeTask, SerialDripfeedStartTask, SerialDripfeedStatusTask, SerialGetConnectionTask, SerialGetStatusTask, SerialListConnectionsTask, SerialListPortsTask, SerialOpenTask, SerialReadLogTask, SerialSendAndWaitTask, SerialSendBytesTask, SerialSendLineTask, SerialUpdateConnectionTask, ThreadListRunawayTask, and WatchdogStatusTask

    Public Functions

    virtual OpalStepPresentation present(const QVariantMap &args, const OpalReferenceNamer &namer) const

    Detailed Description

    An OpalTask is a named, self-contained unit of work. It acquires all state and resources it needs from its name and parameters alone (Android Intent model).

    Subclasses must implement execute() which is called on a background thread by the OpalTaskRuntime.

    See also OpalTaskResult, OpalTaskParams, OpalTaskContext, and OpalTaskRegistry.

    Member Function Documentation

    [virtual] OpalStepPresentation OpalTask::present(const QVariantMap &args, const OpalReferenceNamer &namer) const

    Returns what a plan step of this task shows for args: the row label and the tooltip lines (opal-task-presentation §OTP-2.2).

    The default builds it from the parameter descriptors: the Inline arguments make the label, and every given argument makes a tooltip line. namer gives the display name of a reference argument. Override the function for a label that is not a list of values, and call the default for the tooltip. It is pure: it reads args and calls namer, never a document, a widget or a setting.

    See also OpalStepPresenter.