C# Class GSF.PhasorProtocols.IEEEC37_118.CommandFrame

Inheritance: CommandFrameBase

Show file Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Methods

Method	Description
CommandFrame ( byte buffer, int startIndex, int length ) : System	Creates a new CommandFrame from the given buffer. This constructor is used by a consumer to parse a received IEEE C37.118 command frame. Typically command frames are sent to a device. This constructor would used if this code was being used inside of a phasor measurement device.
CommandFrame ( ushort idCode, DeviceCommand command, byte version ) : System	Creates a new CommandFrame from specified parameters. This constructor is used by a consumer to generate an IEEE C37.118 command frame.
GetObjectData ( SerializationInfo info, StreamingContext context ) : void	Populates a SerializationInfo with the data needed to serialize the target object.

Protected Methods

Method	Description
CalculateChecksum ( byte buffer, int offset, int length ) : ushort	Calculates checksum of given buffer.
CommandFrame ( SerializationInfo info, StreamingContext context ) : System	Creates a new CommandFrame from serialization parameters.
ParseHeaderImage ( byte buffer, int startIndex, int length ) : int	Parses the binary header image.

Method Details

CalculateChecksum() protected method

Calculates checksum of given buffer.

protected CalculateChecksum ( byte buffer, int offset, int length ) : ushort
buffer	byte	Buffer image over which to calculate checksum.
offset	int	Start index into to calculate checksum.
length	int	Length of data within to calculate checksum.
return	ushort

CommandFrame() protected method

Creates a new CommandFrame from serialization parameters.

protected CommandFrame ( SerializationInfo info, StreamingContext context ) : System
info	System.Runtime.Serialization.SerializationInfo	The with populated with data.
context	System.Runtime.Serialization.StreamingContext	The source for this deserialization.
return	System

CommandFrame() public method

Creates a new CommandFrame from the given buffer.

This constructor is used by a consumer to parse a received IEEE C37.118 command frame. Typically command frames are sent to a device. This constructor would used if this code was being used inside of a phasor measurement device.

is not large enough to parse frame.

public CommandFrame ( byte buffer, int startIndex, int length ) : System
buffer	byte	Binary image to parse.
startIndex	int	Start index into to begin parsing.
length	int	Length of valid data within .
return	System

CommandFrame() public method

Creates a new CommandFrame from specified parameters.

This constructor is used by a consumer to generate an IEEE C37.118 command frame.

public CommandFrame ( ushort idCode, DeviceCommand command, byte version ) : System
idCode	ushort	The ID code of this .
command	DeviceCommand	The for this .
version	byte	IEEE C37.118 revision number.
return	System

GetObjectData() public method

Populates a SerializationInfo with the data needed to serialize the target object.

public GetObjectData ( SerializationInfo info, StreamingContext context ) : void
info	System.Runtime.Serialization.SerializationInfo	The to populate with data.
context	System.Runtime.Serialization.StreamingContext	The destination for this serialization.
return	void

ParseHeaderImage() protected method

Parses the binary header image.

protected ParseHeaderImage ( byte buffer, int startIndex, int length ) : int
buffer	byte	Binary image to parse.
startIndex	int	Start index into to begin parsing.
length	int	Length of valid data within .
return	int