7.5 LogbookType

The LogbookType Object provides access to the Encoder’s fault buffer.

The LogEntries array Variable consists of LogEntryDataType structure elements. The array is limited to the maximum size specified by the LogbookSize Property. The array contains LogEntryDataType elements for events and starts with the most recent event (the element with the most recent EventComing timestamp). If the Server maintains different fault situations in its fault buffer (see [PDP] 6.3.8.3 Fault Buffer Mechanism), faults (events) which are still present after an acknowledge generate a new entry in the actual fault situation causing more than one entry with the same EventNumber for one event.

The LogbookSize Property contains the maximum length of the LogEntries array. The actual length of the array may be smaller.

Clients must lock the parent EncoderChannelType Object before invoking a Method of the LogbookType Object.

7.5.1 DeleteLogbook Method

The DeleteLogbook Method clears the LogEntries array and resets the fault buffer of the Encoder Object. The security constraints defined in chapter 6.6 apply.

Signature

	DeleteLogbook (
	);

The Method Result Codes (defined in Call Service) are defined in Table 23.

7.5.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] EventTypeEnumeration 		EventType,
		[in] 0:Int32					EventCode,
		[in] 0:Duration				EventAppearanceInterval,
	[out] LogEntryDataType[] 		FilteredLogEntries
	);

The Method Result Codes (defined in Call Service) are defined in Table 24.

7.5.3 GetCurrentFaultSituation Method

The GetCurrentFaultSituation Method returns all log entries which occurred since the last acknowledge as LogEntries array. Starting with the most recent one, all log entries without valid EventAcknowledged timestamp are returned. Method invocation shall be possible for all users (read-only).

Signature

	GetCurrentFaultSituation (
		[out] LogEntryDataType[] 	CurrentLogEntries
	);
	

The Method Result Codes (defined in Call Service) are defined in Table 25.

7.5.4 GetHistoricFaultSituation Method

The GetHistoricFaultSituation Method returns a LogEntries array with valid EventGoing field. Method invocation shall be possible for all users (read-only).

Signature

	GetHistoricFaultSituation (
		[in]  0:Byte				FaultSituationNumber,	
	[out] LogEntryDataType[] 	HistoricLogEntries
	);
	

The Method Result Codes (defined in Call Service) are defined in Table 26.

7.5.5 GetActiveDiagnosis Method

The GetActiveDiagnosis Method returns a LogEntries array containing log entries belonging to the current fault situation (log entries with FaultSituationNumber equal to 0) with valid EventComing timestamp, but with missing EventGoing timestamp. The method returns a subset of the entries returned by the GetCurrentFaultSituation Method. Method invocation shall be possible for all users (read-only).

Signature

	GetActiveDiagnosis (
		[out] LogEntryDataType[] 	ActiveDiagnosis
	);
	

The Method Result Codes (defined in Call Service) are defined in Table 25.

The Server might provide the Client with information about new incidents by sending LogbookEventType Events.