1.2.8 OcaEventHandler

Class Hierarchy:

OcaRoot → OcaAgent → OcaEventHandler

class OcaEventHandler : OcaAgent

Base class for event handler objects. This class applies to controllers that subscribe to events and receive notifications for them. Controller developers can derive from this class and add specific callback methods that perform processing and/or have specific event data structures.

Properties:

static const OcaClassID ClassID = "1.2.8"

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 3.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 3.2.

Properties inherited from OcaAgent:

• OcaString OcaAgent::Label

• OcaONo OcaAgent::Owner

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus OnEvent(OcaBlob Context, OcaEventData eventData)

Generic empty callback method for events. Application developers can override this method in a derived class to add behavior.

This method has id 3.1.

Parameters

• OcaBlob Context – Input parameter.

• OcaEventData eventData – Input parameter.

Methods inherited from OcaAgent:

• OcaAgent::GetLabel(Label)

• OcaAgent::SetLabel(Label)

• OcaAgent::GetOwner(owner)

• OcaAgent::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()