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] EventTypeEnumeration EventType,
[in] 0:Int32 EventCode,
[in] 0:Duration EventAppearanceInterval,
[out] LogEntryDataType[] FilteredLogEntries
);
|
Argument |
Description |
|
LogbookFilterOptions |
Parameter allowing to restrict 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. Passing “UNSPECIFIED” means “don’t care”. |
|
EventCode |
Restricts the returned logbook entries to those with the EventCode field equal to this parameter (See Table 69 fault codes). Passing 0 means “don’t care”. |
|
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 24.
Table 24 – Possible Method Result Codes
|
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 EventCode passed may be unknown. |
|
Bad_Locked |
The parent EncoderChannelType Object is locked by a different Client’s Session. |
|
Bad_RequiresLock |
The parent EncoderChannelType Object is not locked. Clients must lock the parent EncoderChannelType Object before invoking a Method. |
|
Bad_UnexpectedError |
The Server is not able to execute the function because an unexpected error occurred. The Device might be temporarily unavailable or unreachable due to network failure. |