C# Class GSF.Historian.Files.StateRecord

Represents a record in the StateFile that contains the state information associated to a HistorianID.

Inheritance: ISupportBinaryImage, IComparable

Public Methods

Method	Description
CompareTo ( object obj ) : int	Compares the current StateRecord object to obj.
Equals ( object obj ) : bool	Determines whether the current StateRecord object is equal to obj.
GenerateBinaryImage ( byte buffer, int startIndex ) : int	Generates binary image of the StateRecord and copies it into the given buffer, for BinaryLength bytes.
GetHashCode ( ) : int	Returns the hash code for the current StateRecord object.
ParseBinaryImage ( byte buffer, int startIndex, int length ) : int	Initializes StateRecord from the specified buffer.
StateRecord ( int historianID ) : System	Initializes a new instance of the StateRecord class.
StateRecord ( int historianID, byte buffer, int startIndex, int length ) : System	Initializes a new instance of the StateRecord class.
ToString ( ) : string	Returns the text representation of StateRecord object.

Compares the current StateRecord object to obj.

public CompareTo ( object obj ) : int
obj	object	Object against which the current object is to be compared.
return	int

Determines whether the current StateRecord object is equal to obj.

public Equals ( object obj ) : bool
obj	object	Object against which the current object is to be compared for equality.
return	bool

Generates binary image of the StateRecord and copies it into the given buffer, for BinaryLength bytes.

is null. /// or is less than 0 -or- /// and will exceed length. ///

public GenerateBinaryImage ( byte buffer, int startIndex ) : int
buffer	byte	Buffer used to hold generated binary image of the source object.
startIndex	int	0-based starting index in the to start writing.
return	int

Returns the hash code for the current StateRecord object.

public GetHashCode ( ) : int
return	int

Initializes StateRecord from the specified buffer.

public ParseBinaryImage ( byte buffer, int startIndex, int length ) : int
buffer	byte	Binary image to be used for initializing .
startIndex	int	0-based starting index of initialization data in the .
length	int	Valid number of bytes in from .
return	int

Initializes a new instance of the StateRecord class.

public StateRecord ( int historianID ) : System
historianID	int	Historian identifier of .
return	System

Initializes a new instance of the StateRecord class.

public StateRecord ( int historianID, byte buffer, int startIndex, int length ) : System
historianID	int	Historian identifier of .
buffer	byte	Binary image to be used for initializing .
startIndex	int	0-based starting index of initialization data in the .
length	int	Valid number of bytes in from .
return	System

Returns the text representation of StateRecord object.

public ToString ( ) : string
return	string