Click or drag to resize

IntercomFile Class

Represents a file containing IntercomRecords.
Inheritance Hierarchy
SystemObject
  GSF.IOIsamDataFileBaseIntercomRecord
    GSF.Historian.FilesIntercomFile

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.207-beta
Syntax
[ToolboxBitmapAttribute(typeof(IntercomFile))]
public class IntercomFile : IsamDataFileBase<IntercomRecord>
View Source

The IntercomFile type exposes the following members.

Constructors
 NameDescription
Public methodIntercomFile Initializes a new instance of the IntercomFile class.
Top
Properties
 NameDescription
Public propertyAutoSaveInterval Gets or sets the interval in milliseconds at which the records loaded in memory are to be persisted to disk.
(Inherited from IsamDataFileBaseT)
Public propertyEnabled Gets or sets a boolean value that indicates whether the file is currently enabled.
(Inherited from IsamDataFileBaseT)
Public propertyFileAccessMode Gets or sets the FileAccess value to use when opening the file.
(Inherited from IsamDataFileBaseT)
Protected propertyFileData Gets the underlying FileStream of the file.
(Inherited from IsamDataFileBaseT)
Protected propertyFileDataLock Gets the locking object for the FileData stream.
(Inherited from IsamDataFileBaseT)
Public propertyFileName Gets or sets the name of the file.
(Inherited from IsamDataFileBaseT)
Public propertyIsCorrupt Gets a boolean value that indicates whether the file data on disk is corrupt.
(Inherited from IsamDataFileBaseT)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from IsamDataFileBaseT)
Public propertyIsOpen Gets a boolean value that indicates whether the file is open.
(Inherited from IsamDataFileBaseT)
Public propertyLoadOnOpen 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)
Protected propertyLoadWaitHandle Gets wait handle for loading data.
(Inherited from IsamDataFileBaseT)
Public propertyMemoryUsage Gets the approximate memory consumption (in KB) of the file.
(Inherited from IsamDataFileBaseT)
Public propertyName Gets the unique identifier of the file.
(Inherited from IsamDataFileBaseT)
Public propertyPersistSettings Gets or sets a boolean value that indicates whether the file settings are to be saved to the config file.
(Inherited from IsamDataFileBaseT)
Public propertyRecordsInMemory Gets the number of file records loaded in memory.
(Inherited from IsamDataFileBaseT)
Public propertyRecordsOnDisk Gets the number of file records on the disk.
(Inherited from IsamDataFileBaseT)
Public propertyReloadOnModify 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)
Public propertySaveOnClose 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)
Protected propertySaveWaitHandle Gets wait handle for saving data.
(Inherited from IsamDataFileBaseT)
Public propertySettingsCategory 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)
Public propertyStatus Gets the descriptive status of the file.
(Inherited from IsamDataFileBaseT)
Top
Methods
 NameDescription
Public methodClose Closes the file.
(Inherited from IsamDataFileBaseT)
Protected methodCreateNewRecord Creates a new IntercomRecord with the specified recordIndex.
(Overrides IsamDataFileBaseTCreateNewRecord(Int32))
Public methodDispose Releases all the resources used by the file.
(Inherited from IsamDataFileBaseT)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the file and optionally releases the managed resources.
(Inherited from IsamDataFileBaseT)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the file is reclaimed by GC.
(Inherited from IsamDataFileBaseT)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Protected methodGetRecordSize Gets the binary size of a IntercomRecord.
(Overrides IsamDataFileBaseTGetRecordSize)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitialize Initializes the file.
(Inherited from IsamDataFileBaseT)
Public methodLoad Loads records from disk into memory.
(Inherited from IsamDataFileBaseT)
Public methodLoadSettings Loads saved settings of the file from the config file if the PersistSettings property is set to true.
(Inherited from IsamDataFileBaseT)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnDataLoaded Raises the DataLoaded event.
(Inherited from IsamDataFileBaseT)
Protected methodOnDataLoading Raises the DataLoading event.
(Inherited from IsamDataFileBaseT)
Protected methodOnDataSaved Raises the DataSaved event.
(Inherited from IsamDataFileBaseT)
Protected methodOnDataSaving Raises the DataSaving event.
(Inherited from IsamDataFileBaseT)
Protected methodOnFileModified Raises the FileModified event.
(Inherited from IsamDataFileBaseT)
Public methodOpen Opens the file.
(Inherited from IsamDataFileBaseT)
Public methodRead Reads file records from disk if records were not loaded in memory otherwise returns the records in memory.
(Inherited from IsamDataFileBaseT)
Public methodRead(Int32) Reads specified file record from disk if records were not loaded in memory otherwise returns the record in memory.
(Inherited from IsamDataFileBaseT)
Public methodSave Saves records loaded in memory to disk.
(Inherited from IsamDataFileBaseT)
Public methodSaveSettings Saves settings of the file to the config file if the PersistSettings property is set to true.
(Inherited from IsamDataFileBaseT)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWrite(IEnumerableT) Writes specified records to disk if records were not loaded in memory otherwise updates the records in memory.
(Inherited from IsamDataFileBaseT)
Public methodWrite(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
 NameDescription
Public eventDataLoaded Occurs when data has been read from disk into memory.
(Inherited from IsamDataFileBaseT)
Public eventDataLoading Occurs when data is being read from disk into memory.
(Inherited from IsamDataFileBaseT)
Public eventDataSaved Occurs when data has been saved from memory onto disk.
(Inherited from IsamDataFileBaseT)
Public eventDataSaving Occurs when data is being saved from memory onto disk.
(Inherited from IsamDataFileBaseT)
Public eventDisposed Occurs when the class has been disposed.
(Inherited from IsamDataFileBaseT)
Public eventFileModified Occurs when file data on the disk is modified.
(Inherited from IsamDataFileBaseT)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also