1.5.2.1 OcaCommandSet

Class Hierarchy:

OcaRoot : OcaDataset : OcaProgram : OcaCommandSet

class OcaCommandSet : OcaProgram

A command set. Child of OcaProgram.

Properties:

static const OcaClassID ClassID = "1.5.2.1"

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 = 2

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<OcaCommand> Commands

The commands in the commandSet.

This property has id 4.1.

Properties inherited from 1.5.2 OcaProgram:

Methods:

OcaStatus GetCommands(OcaList<OcaCommand> &Commands)

Gets the list of commands in the commandset.

This method has id 4.1.

OcaStatus SetCommands(OcaList<OcaCommand> Commands)

Sets the list of commands in the commandset.

This method has id 4.2.

OcaStatus GetCommand(OcaUint16 Index, OcaCommand &Command)

Gets the command designated by the Index parameter.

This method has id 4.3.

OcaStatus SetCommand(OcaUint16 Index, OcaCommand Command)

Replaces the command designated by the Index parameter.

This method has id 4.4.

OcaStatus InsertCommand(OcaUint16 Index, OcaCommand Command)

Inserts a command into the CommandSet after the command with the given Index value.

This method has id 4.5.

OcaStatus DeleteCommand(OcaUint16 Index)

Removes command with the given Index value from the commandset.

This method has id 4.6.

  • Index: Input parameter.

OcaStatus Clear()

Removes all commands from the command set.

This method has id 4.7.

Methods inherited from 1.5.2 OcaProgram: