1.2.22 OcaGroup

Class Hierarchy:

OcaRoot : OcaAgent : OcaGroup

class OcaGroup : OcaAgent

Control aggregator. See [AES70-1(Control Aggregation)] for the normative specification of OcaGroup semantics.

Properties:

OcaString AggregationRule

Aggregation rule of group. Optional; null string if not used. Values are implementation-dependent.

This property has id 3.3.

static const OcaClassID ClassID = "1.2.22"

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

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.

OcaONo GroupControllerONo

Object number of group controller object. Zero value means group is peer to peer group in which a change to any member affects all members.

This property has id 3.2.

OcaList<OcaONo> Members

Object numbers of group members

This property has id 3.1.

OcaString SaturationRule

Saturation rule of group. Optional; null string if not used. Values are implementation-dependent.

This property has id 3.4.

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 GetMembers(OcaList<OcaONo> &Members)

Gets the list of Group members.

This method has id 3.1.

• Members: Output parameter.

OcaStatus SetMembers(OcaList<OcaONo> Members)

Sets the list of Group members.

This method has id 3.2.

• Members: Input parameter.

OcaStatus AddMember(OcaONo Member)

Adds a Member to the Group.

This method has id 3.3.

• Member: Input parameter.

OcaStatus RemoveMember(OcaONo Member)

Removes a Member from the Group.

This method has id 3.4.

• Member: Input parameter.

OcaStatus GetGroupControllerONo(OcaONo &ONo)

Gets the Group Controller object number.

This method has id 3.5.

• ONo: Output parameter.

OcaStatus SetGroupControllerONo(OcaONo ONo)

Sets the Group Controller object number.

This method has id 3.6.

• ONo: Input parameter.

OcaStatus GetAggregationRule(OcaString &Rule)

Gets the value of the AggregationRule property.

This method has id 3.7.

• Rule: Output parameter.

OcaStatus SetAggregationRule(OcaString Rule)

Sets the value of the AggregationRule property.

This method has id 3.8.

• Rule: Input parameter.

OcaStatus GetSaturationRule(OcaString &Rule)

Gets the value of the SaturationRule property.

This method has id 3.9.

• Rule: Output parameter.

OcaStatus SetSaturationRule(OcaString Rule)

Sets the value of the SaturationRule property.

This method has id 3.10.

• Rule: 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 GroupException(OcaGroupExceptionEventData eventData)

Event that is emitted whenever a value-setting operation returns a status other than OK. NOTE. This is an ordinary event that causes a normal Notification message to be emitted. The OCP.1 protocol defines a special type of Notification PDU called ‘Exception’, but that PDU type is only used to signal cancellation of a subscription. This GroupException event uses the normal Notification PDU type, which is called ‘Event’.

This event has id 3.1.