ConfigurationCellBase Class

Represents the protocol independent common implementation of all configuration elements for cells in a IConfigurationFrame.

Inheritance Hierarchy

SystemObject
  GSF.ParsingBinaryImageBase
    GSF.PhasorProtocolsChannelBase
      GSF.PhasorProtocolsChannelCellBase
        GSF.PhasorProtocolsConfigurationCellBase
          More

Namespace: GSF.PhasorProtocols
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public abstract class ConfigurationCellBase : ChannelCellBase, 
	IConfigurationCell, IChannelCell, IChannel, ISupportBinaryImage, ISerializable, 
	IEquatable<IConfigurationCell>, IComparable<IConfigurationCell>, IComparable

<SerializableAttribute>
Public MustInherit Class ConfigurationCellBase
	Inherits ChannelCellBase
	Implements IConfigurationCell, IChannelCell, IChannel, ISupportBinaryImage, 
	ISerializable, IEquatable(Of IConfigurationCell), IComparable(Of IConfigurationCell), 
	IComparable

[SerializableAttribute]
public ref class ConfigurationCellBase abstract : public ChannelCellBase, 
	IConfigurationCell, IChannelCell, IChannel, ISupportBinaryImage, ISerializable, 
	IEquatable<IConfigurationCell^>, IComparable<IConfigurationCell^>, IComparable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type ConfigurationCellBase = 
    class
        inherit ChannelCellBase
        interface IConfigurationCell
        interface IChannelCell
        interface IChannel
        interface ISupportBinaryImage
        interface ISerializable
        interface IEquatable<IConfigurationCell>
        interface IComparable<IConfigurationCell>
        interface IComparable
    end

GSF.PhasorProtocols.ConfigurationCellBase = function();

Type.createClass(
	'GSF.PhasorProtocols.ConfigurationCellBase',
	GSF.PhasorProtocols.ChannelCellBase,
	GSF.PhasorProtocols.IConfigurationCell,
	GSF.PhasorProtocols.IChannelCell,
	GSF.PhasorProtocols.IChannel,
	GSF.Parsing.ISupportBinaryImage,
	ISerializable,
	IEquatable`1,
	IComparable`1,
	IComparable);

View Source

The ConfigurationCellBase type exposes the following members.

Constructors

	Name	Description
	ConfigurationCellBase(SerializationInfo, StreamingContext)	Creates a new ConfigurationCellBase from serialization parameters.
	ConfigurationCellBase(IConfigurationFrame, UInt16, Int32, Int32, Int32, Boolean)	Creates a new ConfigurationCellBase from specified parameters.

Top

Properties

	Name	Description
	AnalogDataFormat	Gets or sets the DataFormat for the IAnalogDefinition objects in the AnalogDefinitions of this ConfigurationCellBase.
	AnalogDefinitions	Gets a reference to the AnalogDefinitionCollection of this ConfigurationCellBase.
	Attributes	DictionaryTKey, TValue of string based property names and values for the ConfigurationCellBase object. (Overrides ChannelCellBaseAttributes)
	AutoPadIDLabelImage	Gets flag that indicates if IDLabelImage should auto pad-right value to IDLabelLength.
	AutoPadStationNameImage	Gets flag that indicates if StationNameImage should auto pad-right value to MaximumStationNameLength.
	BinaryImage	Gets the binary image of the ChannelBase object. (Inherited from ChannelBase)
	BinaryLength	Gets the length of the BinaryImageBase object. (Inherited from BinaryImageBase)
	BodyImage	Gets the binary body image of the ConfigurationCellBase object. (Overrides ChannelBaseBodyImage)
	BodyLength	Gets the length of the BodyImage. (Overrides BinaryImageBaseBodyLength)
	DigitalDefinitions	Gets a reference to the DigitalDefinitionCollection of this ConfigurationCellBase.
	FooterImage	Gets the binary footer image of the ConfigurationCellBase object. (Overrides ChannelBaseFooterImage)
	FooterLength	Gets the length of the FooterImage. (Overrides BinaryImageBaseFooterLength)
	FrameRate	Gets the specified frame rate of this ConfigurationCellBase.
	FrequencyDataFormat	Gets or sets the DataFormat of the FrequencyDefinition of this ConfigurationCellBase.
	FrequencyDefinition	Gets or sets the IFrequencyDefinition of this ConfigurationCellBase.
	HeaderImage	Gets the binary header image of the ConfigurationCellBase object. (Overrides ChannelBaseHeaderImage)
	HeaderLength	Gets the length of the HeaderImage. (Overrides BinaryImageBaseHeaderLength)
	IDCode	Gets or sets the numeric ID code for this ChannelCellBase. (Inherited from ChannelCellBase)
	IDLabel	Gets or sets the ID label of this ConfigurationCellBase.
	IDLabelImage	Gets the binary image of the IDLabel of this ConfigurationCellBase.
	IDLabelLength	Gets the length of the IDLabel of this ConfigurationCellBase.
	MaximumStationNameLength	Gets the maximum length of the StationName of this ConfigurationCellBase.
	NominalFrequency	Gets or sets the nominal LineFrequency of the FrequencyDefinition of this ConfigurationCellBase.
	Parent	Gets or sets a reference to the parent IConfigurationFrame for this ConfigurationCellBase.
	PhasorAngleFormat	Gets or sets the AngleFormat for the IPhasorDefinition objects in the PhasorDefinitions of this ConfigurationCellBase.
	PhasorCoordinateFormat	Gets or sets the CoordinateFormat for the IPhasorDefinition objects in the PhasorDefinitions of this ConfigurationCellBase.
	PhasorDataFormat	Gets or sets the DataFormat for the IPhasorDefinition objects in the PhasorDefinitions of this ConfigurationCellBase.
	PhasorDefinitions	Gets a reference to the PhasorDefinitionCollection of this ConfigurationCellBase.
	RevisionCount	Gets or sets the revision count of this ConfigurationCellBase.
	State	Gets or sets the parsing state for the this ConfigurationCellBase.
	StationName	Gets or sets the station name of this ConfigurationCellBase.
	StationNameImage	Gets the binary image of the StationName of this ConfigurationCellBase.
	Tag	Gets or sets a user definable reference to an object associated with this ChannelBase object. (Inherited from ChannelBase)

Top

Methods

	Name	Description
	CompareTo(IConfigurationCell)	Compares this instance to a specified IConfigurationCell object and returns an indication of their relative values.
	CompareTo(Object)	Compares this instance to a specified object and returns an indication of their relative values.
	Equals(IConfigurationCell)	Returns a value indicating whether this instance is equal to specified IConfigurationCell value.
	Equals(Object)	Returns a value indicating whether this instance is equal to a specified object. (Overrides ObjectEquals(Object))
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GenerateBinaryImage	Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes. (Inherited from ChannelBase)
	GenerateBodyImage	Generates the binary body image and copies it into the given buffer, for BodyLength bytes. (Inherited from BinaryImageBase)
	GenerateFooterImage	Generates the binary footer image and copies it into the given buffer, for FooterLength bytes. (Inherited from BinaryImageBase)
	GenerateHeaderImage	Generates the binary header image and copies it into the given buffer, for HeaderLength bytes. (Inherited from BinaryImageBase)
	GetHashCode	Returns the hash code for this instance. (Overrides ObjectGetHashCode)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides ChannelCellBaseGetObjectData(SerializationInfo, StreamingContext))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParseBinaryImage	Initializes object by parsing the specified buffer containing a binary image. (Inherited from BinaryImageBase)
	ParseBodyImage	Parses the binary body image. (Overrides BinaryImageBaseParseBodyImage(Byte, Int32, Int32))
	ParseFooterImage	Parses the binary footer image. (Overrides BinaryImageBaseParseFooterImage(Byte, Int32, Int32))
	ParseHeaderImage	Parses the binary header image. (Overrides BinaryImageBaseParseHeaderImage(Byte, Int32, Int32))
	ToString	Gets the string representation of this ConfigurationCellBase. (Overrides ChannelCellBaseToString)

Top

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)

Top

Reference

GSF.PhasorProtocols Namespace

Inheritance Hierarchy