C# Class GSF.Snap.SnapTypeBase

The interface that is required to use as a value in SortedTree
Show file Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Public Methods

Method Description
Clear ( ) : void

Clears the key

MethodCopy ( byte source, byte destination ) : void

Executes a copy command without modifying the current class.

Read ( BinaryStreamBase stream ) : void

Reads the provided key from the stream.

Read ( Stream stream ) : void
Read ( byte stream ) : void

Reads the key from the stream

SetMax ( ) : void

Sets the privided key to it's maximum value

SetMin ( ) : void

Sets the provided key to it's minimum value

Write ( BinaryStreamBase stream ) : void

Writes the provided data to the BinaryWriter

Write ( Stream stream ) : void
Write ( byte stream ) : void

Writes the key to the stream

Protected Methods

Method Description
SnapTypeBase ( ) : System

Ensures that only SnapTypeBase{T} inherits from this class.

Method Details

Clear() public abstract method

Clears the key
public abstract Clear ( ) : void
return void

MethodCopy() public method

Executes a copy command without modifying the current class.
public MethodCopy ( byte source, byte destination ) : void
source byte
destination byte
return void

Read() public abstract method

Reads the provided key from the stream.
public abstract Read ( BinaryStreamBase stream ) : void
stream GSF.IO.BinaryStreamBase
return void

Read() public method

public Read ( Stream stream ) : void
stream Stream
return void

Read() public method

Reads the key from the stream
public Read ( byte stream ) : void
stream byte
return void

SetMax() public abstract method

Sets the privided key to it's maximum value
public abstract SetMax ( ) : void
return void

SetMin() public abstract method

Sets the provided key to it's minimum value
public abstract SetMin ( ) : void
return void

SnapTypeBase() protected method

Ensures that only SnapTypeBase{T} inherits from this class.
protected SnapTypeBase ( ) : System
return System

Write() public abstract method

Writes the provided data to the BinaryWriter
public abstract Write ( BinaryStreamBase stream ) : void
stream GSF.IO.BinaryStreamBase
return void

Write() public method

public Write ( Stream stream ) : void
stream Stream
return void

Write() public method

Writes the key to the stream
public Write ( byte stream ) : void
stream byte
return void