IEC_BACNET_SUBSCRIBE_COVP_INFO (STRUCT)¶
TYPE IEC_BACNET_SUBSCRIBE_COVP_INFO : STRUCT
This data structure is used by the Subscribe COV Property service to transport any required service information.
- InOut:
Name
Type
Comment
processIDThis contains a numeric identifier to the subscriber. It is used to identify the process in the COV client device to that this notification is directed.
monitoredObjectIDThis contains the Object_Identifier of the object which value has changed.
fIssueConfirmedNotificationsPresentIf set to True the issueConfirmedNotifications parameter is valid.
issueConfirmedNotificationsThis parameter, of type BOOLEAN, shall transport whether the COV-server device shall issue ConfirmedCOVNotifications (TRUE) or UnconfirmedCOVNotifications (FALSE) when changes occur. This parameter, if present, shall indicate that a subscription or re-subscription is to occur and that the lifetime shall be refreshed to its initial state.
fLifetimePresentIf set to True the lifetime parameter is valid.
lifetimeThis parameter, of type Unsigned, contains the desired lifetime of the subscription in seconds. A value of zero shall not be allowed. A non-zero value shall indicate the number of seconds that may elapse before the subscription shall be automatically cancelled. If both the ‘Issue Confirmed Notifications’ and ‘Lifetime’ parameters are absent, then this shall indicate a cancellation request. If the ‘Issue Confirmed Notifications’ parameter is present then the ‘Lifetime’ parameter shall be present too.
monitoredPropertyThis parameter, of type BACnetPropertyReference, contains the property identifier and optional array index for which a subscription is desired. If COV reporting is supported for a property that has an array datatype, it is a local matter to determine whether to support COV subscriptions for all elements of the array or only for particular elements in the array.
fCovIncrementPresentIf set to True the covIncrement parameter is valid.
covIncrementThis parameter, of type REAL, specifies the minimum change in the monitored property that will cause a COVNotification to be issued to subscriber COV-clients. This parameter is ignored if the datatype of the monitored property is not numeric. If the monitored property is Present_Value, its datatype is numeric, this parameter is not present, and the monitored object has a COV_Increment property, then the COV increment to use is taken from the COV_Increment property of the monitored object. The intent is to allow the subscriber to use a previously established COV increment from another subscription or to allow use of the COV_Increment property in the monitored object.
activeSubscribersContains the number of active subscriptions in the server API database.
This is the number of subscribers to this property (only valid in the service hook as additional information for the user application from the server API, otherwise this parameter is 0 and shall be ignored by the application).