RunTimeLog Class

Represents a persisted run-time log that tracks last start, stop and running times.

Inheritance Hierarchy

SystemObject
GSF.IORunTimeLog

Namespace: GSF.IO
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

public class RunTimeLog : ISupportLifecycle, IDisposable, 
	IProvideStatus

Public Class RunTimeLog
	Implements ISupportLifecycle, IDisposable, IProvideStatus

public ref class RunTimeLog : ISupportLifecycle, 
	IDisposable, IProvideStatus

type RunTimeLog = 
    class
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
    end

GSF.IO.RunTimeLog = function();

Type.createClass(
	'GSF.IO.RunTimeLog',
	null,
	GSF.ISupportLifecycle,
	IDisposable,
	GSF.IProvideStatus);

The RunTimeLog type exposes the following members.

Constructors

	Name	Description
	RunTimeLog	Creates a new run-time log.

Properties

	Name	Description
	Enabled	Gets or sets a boolean value that indicates whether the run-time log is enabled.
	FileName	Gets or sets the file name for the run-time log; file name can be set with a relative path.
	IsDisposed	Gets a flag that indicates whether the object has been disposed.
	RunningTime	Gets last known running-time (10-second resolution).
	StartTime	Gets last known start-time.
	Status	Gets the current status details about RunTimeLog.
	StopTime	Gets last known stop-time.
	UpTime	Gets the up-time calculation for run-time log, i.e., RunningTime - StartTime (10-second resolution).

Methods

	Name	Description
	Dispose	Releases all the resources used by the RunTimeLog object.
	Dispose(Boolean)	Releases the unmanaged resources used by the RunTimeLog object and optionally releases the managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases the unmanaged resources before the RunTimeLog object is reclaimed by GC. (Overrides ObjectFinalize)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Initialize the run-time log.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnProcessException	Raises ProcessException event.
	ReadLog	Reads the run-time log.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WriteLog	Writes the run-time log - times are in a human readable format.

Events

	Name	Description
	Disposed	Raised after the run-time log has been properly disposed.
	ProcessException	Event is raised when there is an exception encountered while processing run-time log.

Fields

	Name	Description
	DateTimeFormat	Date-time format used by RunTimeLog.
	LastRunningTimeKey	Log file key name for last running time used by RunTimeLog.
	LastStartTimeKey	Log file key name for last start time used by RunTimeLog.
	LastStopTimeKey	Log file key name for last stop time used by RunTimeLog.

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)