C# Class GSF.Historian.Files.ArchiveDataPoint

Represents time-series data stored in ArchiveFile.

Inheritance: IDataPoint

Show file Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Methods

Method	Description
ArchiveDataPoint ( IDataPoint dataPoint ) : System	Initializes a new instance of the ArchiveDataPoint class.
ArchiveDataPoint ( IMeasurement measurement ) : System	Initializes a new instance of the ArchiveDataPoint class from a IMeasurement value.
ArchiveDataPoint ( IMeasurement measurement, Quality quality ) : System	Initializes a new instance of the ArchiveDataPoint class from a IMeasurement value.
ArchiveDataPoint ( int historianID ) : System	Initializes a new instance of the ArchiveDataPoint class.
ArchiveDataPoint ( int historianID, TimeTag time, float value, Quality quality ) : System	Initializes a new instance of the ArchiveDataPoint class.
ArchiveDataPoint ( int historianID, byte buffer, int startIndex, int length ) : System	Initializes a new instance of the ArchiveDataPoint class.
CompareTo ( object obj ) : int	Compares the current ArchiveDataPoint object to obj.
Equals ( object obj ) : bool	Determines whether the current ArchiveDataPoint object is equal to obj.
GenerateBinaryImage ( byte buffer, int startIndex ) : int	Generates binary image of the ArchiveDataPoint and copies it into the given buffer, for BinaryLength bytes.
GetHashCode ( ) : int	Returns the hash code for the current ArchiveDataPoint object.
ParseBinaryImage ( byte buffer, int startIndex, int length ) : int	Initializes ArchiveDataPoint from the specified buffer.
ToString ( ) : string	Returns the text representation of ArchiveDataPoint object.
ToString ( IFormatProvider provider ) : string	Returns the text representation of ArchiveDataPoint object using the specified provider.
ToString ( string format ) : string	Returns the text representation of ArchiveDataPoint object in the specified format.
ToString ( string format, IFormatProvider provider ) : string	Returns the text representation of ArchiveDataPoint object in the specified format using the specified provider.

Method Details

ArchiveDataPoint() public method

Initializes a new instance of the ArchiveDataPoint class.

public ArchiveDataPoint ( IDataPoint dataPoint ) : System
dataPoint	IDataPoint	A time-series data point.
return	System

ArchiveDataPoint() public method

Initializes a new instance of the ArchiveDataPoint class from a IMeasurement value.

public ArchiveDataPoint ( IMeasurement measurement ) : System
measurement	IMeasurement	Object that implements the interface.
return	System

ArchiveDataPoint() public method

Initializes a new instance of the ArchiveDataPoint class from a IMeasurement value.

public ArchiveDataPoint ( IMeasurement measurement, Quality quality ) : System
measurement	IMeasurement	Object that implements the interface.
quality	Quality	Specific value to apply to new .
return	System

ArchiveDataPoint() public method

Initializes a new instance of the ArchiveDataPoint class.

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

ArchiveDataPoint() public method

Initializes a new instance of the ArchiveDataPoint class.

public ArchiveDataPoint ( int historianID, TimeTag time, float value, Quality quality ) : System
historianID	int	Historian identifier of .
time	TimeTag	of .
value	float	Floating-point value of .
quality	Quality	of .
return	System

ArchiveDataPoint() public method

Initializes a new instance of the ArchiveDataPoint class.

public ArchiveDataPoint ( 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

CompareTo() public method

Compares the current ArchiveDataPoint object to obj.

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

Equals() public method

Determines whether the current ArchiveDataPoint 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

GenerateBinaryImage() public method

Generates binary image of the ArchiveDataPoint 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

GetHashCode() public method

Returns the hash code for the current ArchiveDataPoint object.

public GetHashCode ( ) : int
return	int

ParseBinaryImage() public method

Initializes ArchiveDataPoint 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

ToString() public method

Returns the text representation of ArchiveDataPoint object.

public ToString ( ) : string
return	string

ToString() public method

Returns the text representation of ArchiveDataPoint object using the specified provider.

public ToString ( IFormatProvider provider ) : string
provider	IFormatProvider	An that supplies culture-specific formatting information.
return	string

ToString() public method

Returns the text representation of ArchiveDataPoint object in the specified format.

public ToString ( string format ) : string
format	string	Format of text output (I for ID, T for Time, V for Value, Q for Quality).
return	string

ToString() public method

Returns the text representation of ArchiveDataPoint object in the specified format using the specified provider.

public ToString ( string format, IFormatProvider provider ) : string
format	string	Format of text output (I for ID, T for Time, V for Value, Q for Quality).
provider	IFormatProvider	An that supplies culture-specific formatting information.
return	string