openPDC Historian Help
StateFile Class
NamespacesTVA.Historian.FilesStateFile
Represents a file containing StateRecords.
Declaration Syntax
C#Visual BasicVisual C++
[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^>
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
StateFile()()()
Initializes a new instance of the StateFile class.

StateFile(IContainer)
Initializes a new instance of the StateFile class.

AutoSaveInterval()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
BeginInit()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
CanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Close()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Container
Gets the IContainer that contains the Component.
(Inherited from Component.)
CreateNewRecord(Int32)
Creates a new StateRecord with the specified recordIndex.
(Overrides IsamDataFileBase<(Of <(StateRecord>)>).CreateNewRecord(Int32).)
CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
DataLoaded()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
DataLoading()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
DataSaved()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
DataSaving()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
DesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Dispose(Boolean) (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Dispose()()()
Releases all resources used by the Component.
(Inherited from Component.)
Disposed
Occurs when the component is disposed by a call to the Dispose()()() method.
(Inherited from Component.)
Enabled()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
EndInit()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Events
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
FileAccessMode()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
FileData()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
FileModified()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
FileName()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Finalize()()()
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLifetimeService()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetRecordSize()()()
Gets the binary size of a StateRecord.
(Overrides IsamDataFileBase<(Of <(StateRecord>)>).GetRecordSize()()().)
GetService(Type)
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Initialize()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
InitializeLifetimeService()()()
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
IsCorrupt()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
IsOpen()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Load()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
LoadOnOpen()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
LoadSettings()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MemoryUsage()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Name()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
OnDataLoaded()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
OnDataLoading()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
OnDataSaved()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
OnDataSaving()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
OnFileModified()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Open()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
PersistSettings()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Read()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Read(Int32) (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
RecordsInMemory()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
RecordsOnDisk()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
ReloadOnModify()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Save()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
SaveOnClose()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
SaveSettings()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
SettingsCategory()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Site
Gets or sets the ISite of the Component.
(Inherited from Component.)
Status()()() (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
ToString()()()
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Write(IEnumerable<(Of <(UTP>)>)) (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Write(Int32, UTP) (Inherited from IsamDataFileBase<(Of <(StateRecord>)>).)
Inheritance Hierarchy
Object
MarshalByRefObject
 Component
  IsamDataFileBase<(Of <(StateRecord>)>)
   StateFile
See Also

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.33.39252