FrequencyValueCollection Class

Represents a protocol independent collection of IFrequencyValue objects.

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionIFrequencyValue
    GSF.CollectionsListCollectionIFrequencyValue
      GSF.PhasorProtocolsChannelCollectionBaseIFrequencyValue
        GSF.PhasorProtocolsChannelValueCollectionBaseIFrequencyDefinition, IFrequencyValue
          GSF.PhasorProtocolsFrequencyValueCollection

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class FrequencyValueCollection : ChannelValueCollectionBase<IFrequencyDefinition, IFrequencyValue>

<SerializableAttribute>
Public Class FrequencyValueCollection
	Inherits ChannelValueCollectionBase(Of IFrequencyDefinition, IFrequencyValue)

[SerializableAttribute]
public ref class FrequencyValueCollection : public ChannelValueCollectionBase<IFrequencyDefinition^, IFrequencyValue^>

[<SerializableAttribute>]
type FrequencyValueCollection = 
    class
        inherit ChannelValueCollectionBase<IFrequencyDefinition, IFrequencyValue>
    end

GSF.PhasorProtocols.FrequencyValueCollection = function();

Type.createClass(
	'GSF.PhasorProtocols.FrequencyValueCollection',
	GSF.PhasorProtocols.ChannelValueCollectionBase`2);

View Source

The FrequencyValueCollection type exposes the following members.

Constructors

	Name	Description
	FrequencyValueCollection(Int32)	Creates a new FrequencyValueCollection using specified lastValidIndex.
	FrequencyValueCollection(SerializationInfo, StreamingContext)	Creates a new FrequencyValueCollection from serialization parameters.

Top

Properties

	Name	Description
	AllValuesAssigned	Gets a boolean value indicating if all of the composite values have been assigned a value. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	Attributes	Gets a DictionaryTKey, TValue of string based property names and values for this ChannelValueCollectionBaseTDefinition, TValue object. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	BinaryLength	Gets the length of the ChannelCollectionBaseT. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	Count	Gets the number of elements contained in the ICollectionT. (Inherited from ListCollectionT)
	FixedElementSize	Gets flag that indicates if collection elements have a fixed size. (Inherited from ChannelCollectionBaseT)
	Item	Gets or sets the element at the specified index. (Inherited from ListCollectionT)
	Items	Gets a IListT wrapper around the CollectionT. (Inherited from ListCollectionT)
	MaximumCount	Gets or sets the maximum allowed number of items for this ChannelCollectionBaseT. (Inherited from ChannelCollectionBaseT)
	State	Gets or sets the parsing state for this IChannel object. (Inherited from ChannelCollectionBaseT)
	Tag	Gets or sets a user definable reference to an object associated with this IChannel object. (Inherited from ChannelCollectionBaseT)

Top

Methods

	Name	Description
	Add	Adds an item to the ICollectionT. (Inherited from ListCollectionT)
	AddRange	Adds the elements of the specified collection to the end of the ChannelCollectionBaseT. (Inherited from ChannelCollectionBaseT)
	Clear	Removes all items from the ICollectionT. (Inherited from ListCollectionT)
	ClearItems	Removes all elements from the ChannelValueCollectionBaseTDefinition, TValue. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	Contains	Determines whether the ICollectionT contains a specific value. (Inherited from ListCollectionT)
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Inherited from ListCollectionT)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from 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 ChannelCollectionBaseT)
	GetEnumerator	Returns an enumerator that iterates through the CollectionT. (Inherited from ListCollectionT)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IndexOf	Determines the index of a specific item in the IListT. (Inherited from ListCollectionT)
	Insert	Inserts an item to the IListT at the specified index. (Inherited from ListCollectionT)
	InsertItem	Inserts an element into the ChannelValueCollectionBaseTDefinition, TValue at the specified index. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnCollectionChanged	Raises the NotifyCollectionChangedEventHandler event. (Inherited from ChannelCollectionBaseT)
	RefreshBinding	Manually sends a Reset to the collection changed event. (Inherited from ChannelCollectionBaseT)
	Remove	Removes the first occurrence of a specific object from the ICollectionT. (Inherited from ListCollectionT)
	RemoveAt	Removes the element at the specified index of the CollectionT. (Inherited from ListCollectionT)
	RemoveItem	Removes the element at the specified index of the ChannelValueCollectionBaseTDefinition, TValue. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	SetItem	Replaces the element at the specified index. (Inherited from ChannelValueCollectionBaseTDefinition, TValue)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	CollectionChanged	Notifies listeners of dynamic changes, such as when items get added and removed or the whole list is refreshed. (Inherited from ChannelCollectionBaseT)

Top

Extension Methods

	Name	Description
	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)

Top

Remarks

None of the phasor protocols currently define multiple frequency elements per transmission, but if a future protocol does this collection can be used.

Reference

GSF.PhasorProtocols Namespace