Task Agent Datatypes

OcaTaskGenericState

enum OcaTaskGenericState : uint8_t

States of OcaTask object. State values shall change as a result of the object’s having received a Command or encountering processing events (e.g. completion).

enumerator None = 0: No (invalid) encoding.

enumerator Idle = 1: Task is ready to be initialized.

enumerator Ready = 2: Task is initialized.

enumerator Running = 3: Task is executing.

enumerator Ended = 4: Execution has terminated. Success or failure is indicated elsewhere.

OcaTaskOperationalState

struct OcaTaskOperationalState

Operational state of task: generic state + task-specific details

OcaTaskGenericState Generic: Generic state of this Task Agent.

OcaList<OcaTypedBlob> Details: Device-specific state details (optional)

OcaGenericEndState

enum OcaGenericEndState : uint8_t

Reasons why a Commandset terminated

enumerator CompletedNormally = 1: Commandset terminated normally

enumerator CompletedAbnormally = 2: Commandset terminated in an orderly but exceptional manner.

enumerator Interrupted = 3: Commandset execution was interrupted by controller action and did not complete.

enumerator Failed = 4: Commandset encountered an error and did not complete.

OcaProgramResult

struct OcaProgramResult

Execution result of a Program.

OcaGenericEndState EndState: Completed normally, completed abnormally, aborted, or failed

OcaList<OcaTypedBlob> Data: Program-specific return info - may be null.

OcaCommandResult

struct OcaCommandResult

Execution result of a Command in a Commandset.

OcaStatus Status: Status code returned by command method. nb This field replaces the previous field EndState as of AES70-2024.

OcaList<OcaLongBlob> Data: Command-specific return info - may be null. nb Datatype changed from OcaBlob to OcaList<OcaLongBlob> in AES70-2024.

OcaCommandSetResult

struct OcaCommandSetResult

Execution result of a Commandset

OcaGenericEndState EndState: Completed normally, completed abnormally, aborted, or failed

OcaList<OcaCommandResult> CommandResults: One entry per (successfully or unsuccessfully) executed command. Unexecuted commands are not in the list.

OcaProgramRunMode

using OcaProgramRunMode = OcaBitSet16 : Two-bit bitset that specifies run mode: Bit 1: ExecutionOrder 0 = sequential, 1 = arbitrary // execution order of steps Bit 2: RollBackOnError 0 = no rollback, 1 = rollback Thus, the RunMode value for simple sequential execution with no rollback mechanism shall be 0b00.