EventReader Class

This class provides functionality to read monitoring events from monitoring session log folders. Instances of subclasses of class MonitorEvent represent each event.

Inheritance Hierarchy

System.Object
ntervalZero.MaxRT.wRTOS.Monitor.EventReader

Namespace: IntervalZero.MaxRT.wRTOS.Monitor
Assembly: IntervalZero.MaxRT.wRTOS (in IntervalZero.MaxRT.wRTOS.dll) Version: 1.0.0.0 (File version: 1.1.0)

Syntax

Copy

public class EventReader : IDisposable

The EventReader class exposes the following members.

Constructors

	Name	Description
	EventReader	This constructor prepares this instance to read event data from the most recent monitoring session folder. To read event data from a different folder, use constructor EventReader (string).
	EventReader (String)	This constructor prepares this instance to read event data from the monitoring session stored in the specified folder.

Properties

	Name	Description
	FirstTimeStamp	This property will return the first timestamp within the session. If the index has not been built yet it will return 0.
	IsIndexBuilding	Public API to tell if the Index is currently being built
	LastTimeStamp	This property will return the last timestamp within the session. If the Index has not been built yet it will return 0.
	MaxCore	This property holds the highest processor number seen in the current session's event data.
	PIDToPathname	This is a read-only property that returns a Dictionary that maps a real-time PID to the absolute pathname of the process's main module (i.e., the RTSS application).
	SessionVersion	This is the version of the monitoring session data that is being read. Depending on the value returned by this property, various properties in subclasses of class MonitorEvent may be defined or undefined. See the documentation for each property for information about which fields are defined for which monitoring session versions.

Methods

	Name	Description
	CloseData	Closes the unmanaged OS handles used to access the contents of monitoring event session folders. This must be called by the client after all calls to method ReadEvents have finished and no more calls to ReadEvents will be made.
	DeleteSession	Deletes the contents of the current Session. Once called this object will also be disposed of and cannot be used further. A new object should be instantiated.
	Dispose	Public implementation of dispose,
	GetEventReader	This method opens a monitor session file (.monx) or a monitor event file (.mev), which opens the Event Reader session.
	GetProcessPathnameByPID	Returns the absolute pathname of the main module (the RTSS file) of the real-time process having the process ID specified by parameter pid.
	ReadEvents	This method returns an array of MonitorEvents containing no more than the specified number of elements.
	ResetToStart	Resets the event reader so the next call to EventReader.ReadEvents returns event(s) from the start of the monitoring session.

Events

	Name	Description
	IndexFinishedBuilding	This event will be set once upon completion of the index being constructed. This event will only be set once and only if the index is not already constructed for the opened session.