Click or drag to resize

DigitalDefinition Class

Represents the IEEE C37.118 implementation of a IDigitalDefinition.
Inheritance Hierarchy
SystemObject
  GSF.ParsingBinaryImageBase
    GSF.PhasorProtocolsChannelBase
      GSF.PhasorProtocolsChannelDefinitionBase
        GSF.PhasorProtocolsDigitalDefinitionBase
          GSF.PhasorProtocols.IEEEC37_118DigitalDefinition

Namespace: GSF.PhasorProtocols.IEEEC37_118
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.205-beta
Syntax
[SerializableAttribute]
public class DigitalDefinition : DigitalDefinitionBase
View Source

The DigitalDefinition type exposes the following members.

Constructors
 NameDescription
Public methodDigitalDefinition(IConfigurationCell) Creates a new DigitalDefinition.
Protected methodDigitalDefinition(SerializationInfo, StreamingContext) Creates a new DigitalDefinition from serialization parameters.
Public methodDigitalDefinition(ConfigurationCell, String, UInt16, UInt16) Creates a new DigitalDefinition from specified parameters.
Top
Properties
 NameDescription
Public propertyAttributes Gets a DictionaryTKey, TValue of string based property names and values for this DigitalDefinition object.
(Overrides ChannelDefinitionBaseAttributes)
Public propertyAutoPadLabelImage Gets flag that indicates if LabelImage should auto pad-right value to MaximumLabelLength.
(Inherited from ChannelDefinitionBase)
Public propertyBinaryImage Gets the binary image of the ChannelBase object.
(Inherited from ChannelBase)
Public propertyBinaryLength Gets the length of the BinaryImageBase object.
(Inherited from BinaryImageBase)
Protected propertyBodyImage Gets the binary body image of the ChannelDefinitionBase object.
(Inherited from ChannelDefinitionBase)
Protected propertyBodyLength Gets the length of the BodyImage.
(Inherited from ChannelDefinitionBase)
Public propertyConversionFactor Gets or sets the conversion factor of this ChannelDefinitionBase.
(Inherited from ChannelDefinitionBase)
Public propertyDataFormat Gets the DataFormat of this DigitalDefinitionBase.
(Inherited from DigitalDefinitionBase)
Public propertyDraftRevision Gets the DraftRevision of this DigitalDefinition.
Protected propertyFooterImage Gets the binary footer image of the BinaryImageBase object.
(Inherited from ChannelBase)
Protected propertyFooterLength Gets the length of the footer portion of the BinaryImageBase object.
(Inherited from BinaryImageBase)
Protected propertyHeaderImage Gets the binary header image of the ChannelBase object.
(Inherited from ChannelBase)
Protected propertyHeaderLength Gets the length of the header portion of the BinaryImageBase object.
(Inherited from BinaryImageBase)
Public propertyIndex Gets or sets the index of this ChannelDefinitionBase.
(Inherited from ChannelDefinitionBase)
Public propertyLabel Gets or sets the combined set of label images of this DigitalDefinition.
(Overrides ChannelDefinitionBaseLabel)
Public propertyLabelCount Gets the number of labels defined in this DigitalDefinition.
Public propertyLabelImage Gets the binary image of the Label of this ChannelDefinitionBase.
(Inherited from ChannelDefinitionBase)
Public propertyMaximumLabelLength Gets the maximum length of the Label of this DigitalDefinition.
(Overrides ChannelDefinitionBaseMaximumLabelLength)
Public propertyMaximumScalingValue Gets the maximum value for the ScalingValue of this ChannelDefinitionBase.
(Inherited from ChannelDefinitionBase)
Public propertyNormalStatus Gets or sets normal status for this DigitalDefinition.
Public propertyOffset Gets or sets the offset of this DigitalDefinitionBase.
(Inherited from DigitalDefinitionBase)
Public propertyParent Gets or sets the ConfigurationCell parent of this DigitalDefinition.
Public propertyScalePerBit Gets the scale/bit for the ScalingValue of this DigitalDefinitionBase.
(Inherited from DigitalDefinitionBase)
Public propertyScalingValue Gets or sets the integer scaling value of this DigitalDefinitionBase.
(Inherited from DigitalDefinitionBase)
Public propertyState Gets or sets the parsing state for this ChannelBase object.
(Inherited from ChannelBase)
Public propertyTag Gets or sets a user definable reference to an object associated with this ChannelBase object.
(Inherited from ChannelBase)
Public propertyValidInputs Gets or sets valid input for this DigitalDefinition.
Top
Methods
 NameDescription
Public methodCompareTo(IChannelDefinition) Compares this instance to a specified IChannelDefinition object and returns an indication of their relative values.
(Inherited from ChannelDefinitionBase)
Public methodCompareTo(Object) Compares this instance to a specified object and returns an indication of their relative values.
(Inherited from ChannelDefinitionBase)
Public methodEquals(IChannelDefinition) Returns a value indicating whether this instance is equal to specified IChannelDefinition value.
(Inherited from ChannelDefinitionBase)
Public methodEquals(Object) Returns a value indicating whether this instance is equal to a specified object.
(Inherited from ChannelDefinitionBase)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGenerateBinaryImage Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ChannelBase)
Protected methodGenerateBodyImage Generates the binary body image and copies it into the given buffer, for BodyLength bytes.
(Inherited from BinaryImageBase)
Protected methodGenerateFooterImage Generates the binary footer image and copies it into the given buffer, for FooterLength bytes.
(Inherited from BinaryImageBase)
Protected methodGenerateHeaderImage Generates the binary header image and copies it into the given buffer, for HeaderLength bytes.
(Inherited from BinaryImageBase)
Public methodGetHashCode Returns the hash code for this instance.
(Inherited from ChannelDefinitionBase)
Public methodGetLabel Gets the individual labels for specified bit in this DigitalDefinition.
Public methodGetObjectData Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ChannelDefinitionBaseGetObjectData(SerializationInfo, StreamingContext))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParseBinaryImage Initializes object by parsing the specified buffer containing a binary image.
(Inherited from BinaryImageBase)
Protected methodParseBodyImage Parses the binary body image.
(Overrides ChannelDefinitionBaseParseBodyImage(Byte, Int32, Int32))
Protected methodParseFooterImage Parses the binary footer image.
(Inherited from BinaryImageBase)
Protected methodParseHeaderImage Parses the binary header image.
(Inherited from BinaryImageBase)
Public methodSetLabel Sets the individual labels for specified bit in this DigitalDefinition.
Public methodToString Gets the string representation of this ChannelDefinitionBase.
(Inherited from ChannelDefinitionBase)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also