1.5.2 OcaProgram

Class Hierarchy:

OcaRoot : OcaDataset : OcaProgram

class OcaProgram : OcaDataset

A Program. Child of OcaDataset. Execution: A program executes in a task. Tasks may be explicitly created by OcaTaskManager2, or they may be implicitly created at execution time. The execution task may be explicitly specified, by giving its task ID, or automatically created by the device. In either case, the given task ID parameter will be updated by the Run() or Schedule() method call to reflect the task actually assigned to the run. Once a task is set up, subscribing controllers will receive notifications about changes in its status from OcaTaskManager2. As well, running tasks can be controlled using OcaTaskManager2 methods. Running and scheduling methods are as follows:

  • Run(…) starts execution, then returns immediately.

  • Schedule(…) schedules execution, then returns immediately.

  • RunWait(…) starts execution, but does not return until execution terminates.

  • ScheduleWait(…) schedules execution, but does not return until execution termiantes.

If execution is invoked via Run(…) or Schedule(…), OcaTaskManager2 will raise a CommandSetTerminated event when execution terminates. If execution is invoked via RunWait(…) or ScheduleWait(…), termination information is returned by the method, and no such event is raised.

Properties:

static const OcaClassID ClassID = "1.5.2"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This is a class property instead of an object property. This property will be overridden by each descendant class, in order to specify that class’s ClassID.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 1

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 1.2.

OcaList<OcaProgramRunMode> SupportedRunModes

List of runmodes the task supports.

This property has id 3.1.

Properties inherited from 1.5 OcaDataset:

Methods:

OcaStatus GetSupportedRunModes(OcaList<OcaProgramRunMode> &RunModes)

Gets the list of run modes this program supports.

This method has id 3.1.

OcaStatus SetSupportedRunModes(OcaList<OcaProgramRunMode> RunModes)

Sets the list of run modes this program supports.

This method has id 3.2.

Methods inherited from 1.5 OcaDataset: