C# Class GSF.Historian.Files.MetadataRecord

Represents a record in the MetadataFile that contains the various attributes associates to a HistorianID.
Inheritance: ISupportBinaryImage, IComparable
Afficher le fichier Open project: GridProtectionAlliance/gsf Class Usage Examples

Méthodes publiques

Méthode Description
CompareTo ( object obj ) : int

Compares the current MetadataRecord object to obj.

Equals ( object obj ) : bool

Determines whether the current MetadataRecord object is equal to obj.

GenerateBinaryImage ( byte buffer, int startIndex ) : int

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

GetHashCode ( ) : int

Returns the hash code for the current MetadataRecord object.

MetadataRecord ( int historianID, MetadataFileLegacyMode legacyMode ) : System

Initializes a new instance of the MetadataRecord class.

MetadataRecord ( int historianID, MetadataFileLegacyMode legacyMode, byte buffer, int startIndex, int length ) : System

Initializes a new instance of the MetadataRecord class.

ParseBinaryImage ( byte buffer, int startIndex, int length ) : int

Initializes MetadataRecord from the specified buffer.

ToString ( ) : string

Returns the text representation of MetadataRecord object.

Private Methods

Méthode Description
MetadataRecord ( BinaryReader reader ) : System
WriteImage ( BinaryWriter writer ) : void

Method Details

CompareTo() public méthode

Compares the current MetadataRecord object to obj.
public CompareTo ( object obj ) : int
obj object Object against which the current object is to be compared.
Résultat int

Equals() public méthode

Determines whether the current MetadataRecord object is equal to obj.
public Equals ( object obj ) : bool
obj object Object against which the current object is to be compared for equality.
Résultat bool

GenerateBinaryImage() public méthode

Generates binary image of the MetadataRecord 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.
Résultat int

GetHashCode() public méthode

Returns the hash code for the current MetadataRecord object.
public GetHashCode ( ) : int
Résultat int

MetadataRecord() public méthode

Initializes a new instance of the MetadataRecord class.
public MetadataRecord ( int historianID, MetadataFileLegacyMode legacyMode ) : System
historianID int Historian identifier of .
legacyMode MetadataFileLegacyMode Legacy mode of .
Résultat System

MetadataRecord() public méthode

Initializes a new instance of the MetadataRecord class.
public MetadataRecord ( int historianID, MetadataFileLegacyMode legacyMode, byte buffer, int startIndex, int length ) : System
historianID int Historian identifier of .
legacyMode MetadataFileLegacyMode Legacy mode 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 .
Résultat System

ParseBinaryImage() public méthode

Initializes MetadataRecord 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 .
Résultat int

ToString() public méthode

Returns the text representation of MetadataRecord object.
public ToString ( ) : string
Résultat string