StateFile Class

Represents a file containing StateRecords.

Inheritance Hierarchy

SystemObject
GSF.IOIsamDataFileBaseStateRecord
GSF.Historian.FilesStateFile

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.218-beta

Syntax

C++

JavaScript

Copy

[ToolboxBitmapAttribute(typeof(StateFile))]
public class StateFile : IsamDataFileBase<StateRecord>

<ToolboxBitmapAttribute(GetType(StateFile))>
Public Class StateFile
	Inherits IsamDataFileBase(Of StateRecord)

[ToolboxBitmapAttribute(typeof(StateFile))]
public ref class StateFile : public IsamDataFileBase<StateRecord^>

[<ToolboxBitmapAttribute(typeof(StateFile))>]
type StateFile = 
    class
        inherit IsamDataFileBase<StateRecord>
    end

GSF.Historian.Files.StateFile = function();

Type.createClass(
	'GSF.Historian.Files.StateFile',
	GSF.IO.IsamDataFileBase`1);

View Source

The StateFile type exposes the following members.

Constructors

	Name	Description
	StateFile	Initializes a new instance of the StateFile class.

Top

Properties

	Name	Description
	AutoSaveInterval	Gets or sets the interval in milliseconds at which the records loaded in memory are to be persisted to disk. (Inherited from IsamDataFileBaseT)
	Enabled	Gets or sets a boolean value that indicates whether the file is currently enabled. (Inherited from IsamDataFileBaseT)
	FileAccessMode	Gets or sets the FileAccess value to use when opening the file. (Inherited from IsamDataFileBaseT)
	FileData	Gets the underlying FileStream of the file. (Inherited from IsamDataFileBaseT)
	FileDataLock	Gets the locking object for the FileData stream. (Inherited from IsamDataFileBaseT)
	FileName	Gets or sets the name of the file. (Inherited from IsamDataFileBaseT)
	IsCorrupt	Gets a boolean value that indicates whether the file data on disk is corrupt. (Inherited from IsamDataFileBaseT)
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from IsamDataFileBaseT)
	IsOpen	Gets a boolean value that indicates whether the file is open. (Inherited from IsamDataFileBaseT)
	LoadOnOpen	Gets or sets a boolean value that indicates whether records are to be loaded automatically in memory when the file is opened. (Inherited from IsamDataFileBaseT)
	LoadWaitHandle	Gets wait handle for loading data. (Inherited from IsamDataFileBaseT)
	MemoryUsage	Gets the approximate memory consumption (in KB) of the file. (Inherited from IsamDataFileBaseT)
	Name	Gets the unique identifier of the file. (Inherited from IsamDataFileBaseT)
	PersistSettings	Gets or sets a boolean value that indicates whether the file settings are to be saved to the config file. (Inherited from IsamDataFileBaseT)
	RecordsInMemory	Gets the number of file records loaded in memory. (Inherited from IsamDataFileBaseT)
	RecordsOnDisk	Gets the number of file records on the disk. (Inherited from IsamDataFileBaseT)
	ReloadOnModify	Gets or sets a boolean value that indicates whether records loaded in memory are to be re-loaded when the file is modified on disk. (Inherited from IsamDataFileBaseT)
	SaveOnClose	Gets or sets a boolean value that indicates whether records loaded in memory are to be persisted to disk when the file is closed. (Inherited from IsamDataFileBaseT)
	SaveWaitHandle	Gets wait handle for saving data. (Inherited from IsamDataFileBaseT)
	SettingsCategory	Gets or sets the category under which the file settings are to be saved to the config file if the PersistSettings property is set to true. (Inherited from IsamDataFileBaseT)
	Status	Gets the descriptive status of the file. (Inherited from IsamDataFileBaseT)

Top

Methods

	Name	Description
	Close	Closes the file. (Inherited from IsamDataFileBaseT)
	CreateNewRecord	Creates a new StateRecord with the specified recordIndex. (Overrides IsamDataFileBaseTCreateNewRecord(Int32))
	Dispose	Releases all the resources used by the file. (Inherited from IsamDataFileBaseT)
	Dispose(Boolean)	Releases the unmanaged resources used by the file and optionally releases the managed resources. (Inherited from IsamDataFileBaseT)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases the unmanaged resources before the file is reclaimed by GC. (Inherited from IsamDataFileBaseT)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetRecordSize	Gets the binary size of a StateRecord. (Overrides IsamDataFileBaseTGetRecordSize)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Initializes the file. (Inherited from IsamDataFileBaseT)
	Load	Loads records from disk into memory. (Inherited from IsamDataFileBaseT)
	LoadSettings	Loads saved settings of the file from the config file if the PersistSettings property is set to true. (Inherited from IsamDataFileBaseT)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnDataLoaded	Raises the DataLoaded event. (Inherited from IsamDataFileBaseT)
	OnDataLoading	Raises the DataLoading event. (Inherited from IsamDataFileBaseT)
	OnDataSaved	Raises the DataSaved event. (Inherited from IsamDataFileBaseT)
	OnDataSaving	Raises the DataSaving event. (Inherited from IsamDataFileBaseT)
	OnFileModified	Raises the FileModified event. (Inherited from IsamDataFileBaseT)
	Open	Opens the file. (Inherited from IsamDataFileBaseT)
	Read	Reads file records from disk if records were not loaded in memory otherwise returns the records in memory. (Inherited from IsamDataFileBaseT)
	Read(Int32)	Reads specified file record from disk if records were not loaded in memory otherwise returns the record in memory. (Inherited from IsamDataFileBaseT)
	Save	Saves records loaded in memory to disk. (Inherited from IsamDataFileBaseT)
	SaveSettings	Saves settings of the file to the config file if the PersistSettings property is set to true. (Inherited from IsamDataFileBaseT)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	Write(IEnumerableT)	Writes specified records to disk if records were not loaded in memory otherwise updates the records in memory. (Inherited from IsamDataFileBaseT)
	Write(Int32, T)	Writes specified record to disk if records were not loaded in memory otherwise updates the record in memory. (Inherited from IsamDataFileBaseT)

Top

Events

	Name	Description
	DataLoaded	Occurs when data has been read from disk into memory. (Inherited from IsamDataFileBaseT)
	DataLoading	Occurs when data is being read from disk into memory. (Inherited from IsamDataFileBaseT)
	DataSaved	Occurs when data has been saved from memory onto disk. (Inherited from IsamDataFileBaseT)
	DataSaving	Occurs when data is being saved from memory onto disk. (Inherited from IsamDataFileBaseT)
	Disposed	Occurs when the class has been disposed. (Inherited from IsamDataFileBaseT)
	FileModified	Occurs when file data on the disk is modified. (Inherited from IsamDataFileBaseT)

Top

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)

Top

Reference

GSF.Historian.Files Namespace

StateRecord