1.2.18 OcaCounterNotifier

Class Hierarchy:

OcaRoot : OcaAgent : OcaCounterNotifier

class OcaCounterNotifier : OcaAgent

Notifier for an OCA counter. Observes the value of the counter and emits a CounterUpdate notification when specified criteria are met. An OCA counter wishing to notify controllers of its changing value can designate one or more notifier objects to which the controllers may subscribe. See the definition of the OcaCounter datatype for additional detail. Notification criteria are as follows:

• Threshold. The counter value meets a certain comparison condition. A selection of comparison operators is available. The Operator property is the comparison operator to use for Threshold.

• Period. The value of the** Period** parameter, if nonzero, is a the time interval for the recurrent timed emission of CounterUpdate events. Such events are emitted regardless of the counter’s value.

• CountIncrement. An CounterUpdate event is emitted every time the counter value changes by an amount equal to or greater than the value of this parameter.

** For combinations of (1), (2), and (3), the criteria are applied as follows: if (1) is specified and not satisfied, then no observation is emitted. else if (2) is specified and satisfied or (3) is specified and satisfied, then an observation is emitted. end end Regardless of filter parameter values, a notification is always emitted when a counter is explicitly reset using a **Reset() method. An OcaCounterNotifier instance and the counter it observes are bound at the time the OcaCounterNotifier instance is constructed. For static devices, construction will occur during manufacture, or possibly during a subsequent hardware configuration step. For reconfigurable devices, construction might be done by online controllers as part of device configuration activity.

Properties:

static const OcaClassID ClassID = "1.2.18"

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

OcaCounterNotifierFilterParameters FilterParameters

Conditions for emission of the Observation event

This property has id 3.1.

Properties inherited from 1.2 OcaAgent:

• OcaClassID OcaRoot::ClassID

• OcaClassVersionNumber OcaRoot::ClassVersion

• OcaBoolean OcaRoot::Lockable

• OcaLockState OcaRoot::LockState

• OcaONo OcaRoot::ObjectNumber

• OcaString OcaRoot::Role

• OcaClassID OcaAgent::ClassID

• OcaClassVersionNumber OcaAgent::ClassVersion

• OcaString OcaAgent::Label

• OcaONo OcaAgent::Owner

Methods:

OcaStatus GetLastUpdate(OcaList<OcaCounterUpdate> &Notifications)

Returns the payload of the most recent CounterUpdate event emitted by this object.

This method has id 3.1.

• Notifications: Output parameter.

OcaStatus GetFilterParameters(OcaCounterNotifierFilterParameters &Parameters)

Returns this notifier’s set of filter parameters.

This method has id 3.2.

• Parameters: Output parameter.

OcaStatus SetFilterParameters(OcaCounterNotifierFilterParameters Parameters)

Sets this notifier’s set of filter parameters.

This method has id 3.3.

• Parameters: Input parameter.

Methods inherited from 1.2 OcaAgent:

• OcaAgent::GetClassIdentification

• OcaAgent::GetLockable

• OcaAgent::GetLockState

• OcaAgent::GetRole

• OcaAgent::SetLockNoWrite

• OcaAgent::SetLockNoReadWrite

• OcaAgent::Unlock

• OcaAgent::GetLabel

• OcaAgent::GetOwner

• OcaAgent::GetPath

• OcaAgent::SetLabel

Events:

void CounterUpdate(OcaCounterUpdateEventData eventData)

Event raised when filter conditions are met.

This event has id 3.1.