Index

Class OcaAgent

ClassID: 1.2

extends OcaRoot

Abstract base class for defining agents.

Properties

static readonly OcaClassID ClassID = 1.2

Level: 1 Index: 1

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.

static readonly OcaClassVersionNumber ClassVersion = 2

Level: 1 Index: 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.

OcaString Label

Level: 2 Index: 1

User-specified label.

OcaONo Owner

Level: 2 Index: 2

Object number of block that contains this agent.

Properties inherited from OcaRoot

readonly OcaONo ObjectNumber

readonly OcaBoolean Lockable

readonly OcaString Role

Methods

OcaAgent::GetLabel ( ) → ( OcaString Label)

Level: 2 Index: 1

Gets the value of the Label property. The return value indicates whether the property was successfully retrieved.

OcaAgent::SetLabel ( OcaString Label )

Level: 2 Index: 2

Sets the value of the Label property. The return value indicates whether the property was successfully set.

OcaAgent::GetOwner ( ) → ( OcaONo owner)

Level: 2 Index: 3

Gets the value of the Owner property. The return value indicates whether the property was successfully retrieved.

OcaAgent::GetPath ( ) → ( OcaNamePath NamePath, OcaONoPath ONoPath)

Level: 2 Index: 4

Returns path from the given object down to root. The return value indicates whether the operation succeeded. Added in version 2.

Methods inherited from OcaRoot

OcaRoot::GetClassIdentification ( ) → ( OcaClassIdentification ClassIdentification)

OcaRoot::GetLockable ( ) → ( OcaBoolean lockable)

OcaRoot::LockTotal ( )

OcaRoot::Unlock ( )

OcaRoot::GetRole ( ) → ( OcaString Role)

OcaRoot::LockReadonly ( )