C# Class GSF.PhasorProtocols.IEEEC37_118.DigitalDefinition

Inheritance: DigitalDefinitionBase
Mostrar archivo Open project: GridProtectionAlliance/gsf Class Usage Examples

Private Properties

Property Type Description
CreateNewDefinition IDigitalDefinition
ParseConversionFactor int

Public Methods

Method Description
DigitalDefinition ( GSF.PhasorProtocols.IEEEC37_118.ConfigurationCell parent, string label, ushort normalStatus, ushort validInputs ) : System

Creates a new DigitalDefinition from specified parameters.
DigitalDefinition ( IConfigurationCell parent ) : System

Creates a new DigitalDefinition.
GetLabel ( int index ) : string

Gets the individual labels for specified bit in this DigitalDefinition.

In the final version of the protocol each digital bit can be labeled, but we read them out as one big string in the "Label" property so this property allows individual access to each label.

Note that the draft 6 implementation of the protocol supports one label for all 16-bits, however draft 7 (i.e., version 1) supports a label for each of the 16 bits.
GetObjectData ( SerializationInfo info, StreamingContext context ) : void

Populates a SerializationInfo with the data needed to serialize the target object.
SetLabel ( int index, string value ) : void

Sets the individual labels for specified bit in this DigitalDefinition.

In the final version of the protocol each digital bit can be labeled, but we read them out as one big string in the "Label" property so this property allows individual access to each label.

Note that the draft 6 implementation of the protocol supports one label for all 16-bits, however draft 7 (i.e., version 1) supports a label for each of the 16 bits.

Protected Methods

Method Description
DigitalDefinition ( SerializationInfo info, StreamingContext context ) : System

Creates a new DigitalDefinition from serialization parameters.
ParseBodyImage ( byte buffer, int startIndex, int length ) : int

Parses the binary body image.

Private Methods

Method Description
CreateNewDefinition ( IConfigurationCell parent, byte buffer, int startIndex, int &parsedLength ) : IDigitalDefinition
ParseConversionFactor ( byte buffer, int startIndex ) : int

Parses conversion factor image from the specified buffer.

Method Details

DigitalDefinition() public method

Creates a new DigitalDefinition from specified parameters.
public DigitalDefinition ( GSF.PhasorProtocols.IEEEC37_118.ConfigurationCell parent, string label, ushort normalStatus, ushort validInputs ) : System
parent GSF.PhasorProtocols.IEEEC37_118.ConfigurationCell The parent of this .
label string The label of this .
normalStatus ushort The normal status for this .
validInputs ushort The valid input for this .
return System

DigitalDefinition() public method

Creates a new DigitalDefinition.
public DigitalDefinition ( IConfigurationCell parent ) : System
parent IConfigurationCell The parent of this .
return System

DigitalDefinition() protected method

Creates a new DigitalDefinition from serialization parameters.
protected DigitalDefinition ( 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

GetLabel() public method

Gets the individual labels for specified bit in this DigitalDefinition.

In the final version of the protocol each digital bit can be labeled, but we read them out as one big string in the "Label" property so this property allows individual access to each label.

Note that the draft 6 implementation of the protocol supports one label for all 16-bits, however draft 7 (i.e., version 1) supports a label for each of the 16 bits.

public GetLabel ( int index ) : string
index int Index of desired bit label to access.
return string

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

ParseBodyImage() protected method

Parses the binary body image.
protected ParseBodyImage ( 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

SetLabel() public method

Sets the individual labels for specified bit in this DigitalDefinition.

In the final version of the protocol each digital bit can be labeled, but we read them out as one big string in the "Label" property so this property allows individual access to each label.

Note that the draft 6 implementation of the protocol supports one label for all 16-bits, however draft 7 (i.e., version 1) supports a label for each of the 16 bits.

public SetLabel ( int index, string value ) : void
index int Index of desired bit label to access.
value string Value of the bit label to assign.
return void