1.2 OcaAgent

Class Hierarchy:

OcaRoot : OcaAgent

class OcaAgent : OcaRoot

Abstract base class for defining agents.

Properties:

static const OcaClassID ClassID = "1.2"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 1.1.

static const OcaClassVersionNumber ClassVersion = 3

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.

OcaString Label

User-specified label.

This property has id 2.1.

const OcaONo Owner

Object number of block that contains this agent. Readonly.

This property has id 2.2.

Properties inherited from 1 OcaRoot:

Methods:

OcaStatus GetLabel(OcaString &Label)

Gets the value of the Label property.

This method has id 2.1.

  • Label: Output parameter.

OcaStatus SetLabel(OcaString Label)

Sets the value of the Label property.

This method has id 2.2.

  • Label: Input parameter.

OcaStatus GetOwner(OcaONo &Owner)

Gets the value of the Owner property.

This method has id 2.3.

  • Owner: Output parameter.

OcaStatus GetPath(OcaRolePath &RolePath, OcaONoPath &ONoPath)

Returns Role Path and ONo Path from the Root Block to this object. The return value indicates whether the operation succeeded.

This method has id 2.4.

Methods inherited from 1 OcaRoot: