7.2.2 GetFilteredLogbookEntries Method
The GetFilteredLogbookEntries Method returns a LogEntries array matching the filter criteria. Method invocation shall be possible for all users (read-only).
Signature
GetFilteredLogbookEntries (
[in] 0:Byte LogbookFilterOptions,
[in] 0:Byte FaultSituationNumber
[in] PtEventTypeEnumeration EventType,
[in] PtEventClassEnumeration EventClass,
[in] 0:Int32 VendorEventCode
[in] 0:Duration EventAppearanceInterval,
[out] PtLogEntryDataType[] FilteredLogEntries
);
| Argument | Description |
| LogbookFilterOptions | Parameter restricting the returned logbook entries to those having valid EventGoing and/or EventAcknowledged timestamps. If set to 1 ("GOING" filter), only logbook entries with valid EventGoing timestamp are returned. If set to 2 ("ACKNOWLEDGED" filter), only entries with valid EventAcknowledged timestamp are returned. If set to 3, the logic applied is "AND": only logbook entries meeting both filter criteria are returned. Set to 0 if no filtering shall be applied. If a value greater than 3 is passed, the Method Result Code shall be set to Bad_InvalidArgument. |
| FaultSituationNumber | Restricts the returned logbook entries to those with the FaultSituationNumber field equal to this parameter. Passing 255 means "don't care". |
| EventType | Restricts the returned logbook entries to those with the EventType field equal to this parameter. It is encoded as PtEventTypeEnumeration. Passing "UNSPECIFIED" means "don't care". |
| EventClass | Restricts the returned logbook entries to those with the EventClass field equal to this parameter. It is encoded as PtEventClassEnumeration. Passing "UNSPECIFIED" means "don't care". |
| VendorEventCode | Restricts the returned logbook entries to those with the VendorEventCode field equal to this parameter. Passing -1 means "don't care" and does not restrict to entries with the VendorEventCode field set to -1. |
| EventAppearanceInterval | Time interval encoded as 0:Duration defined in [OPC 10000-3]. Restricts the returned logbook entries to those appearing within a timespan from the past up to now. The EventComing field of the logbook entries is used for checking this filter. Passing 0 means "don't care". |
| FilteredLogEntries | Array containing the logbook entries matching all filter criteria passed with the first 5 parameters. An empty array is returned if no logbook entry matches the filter criteria. |
The Method Result Codes (defined in Call Service) are defined in Table 40.
| Result Code | Description |
| Good | The Method execution was successful. |
| Bad_InvalidArgument | The Server is unable to execute the Method due to invalid arguments. For instance, the EventClass passed may be unknown. |
| Bad_UnexpectedError | The Server cannot execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure. |