ChannelCollectionBaseT Class

Represents a protocol independent collection of IChannel objects.
This is the base class of all collection classes in the phasor protocols library; it is the root of the collection class hierarchy.

Inheritance Hierarchy

SystemObject
  System.Collections.ObjectModelCollectionT
    GSF.CollectionsListCollectionT
      GSF.PhasorProtocolsChannelCollectionBaseT
        GSF.PhasorProtocolsChannelCellCollectionBaseT
        GSF.PhasorProtocolsChannelDefinitionCollectionBaseT
        GSF.PhasorProtocolsChannelFrameCollectionBaseT
        GSF.PhasorProtocolsChannelValueCollectionBaseTDefinition, TValue

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public abstract class ChannelCollectionBase<T> : ListCollection<T>, 
	IChannelCollection<T>, IChannel, ISupportBinaryImage, IList<T>, ICollection<T>, 
	IEnumerable<T>, IEnumerable, INotifyCollectionChanged, ISerializable
where T : IChannel

<SerializableAttribute>
Public MustInherit Class ChannelCollectionBase(Of T As IChannel)
	Inherits ListCollection(Of T)
	Implements IChannelCollection(Of T), IChannel, ISupportBinaryImage, 
	IList(Of T), ICollection(Of T), IEnumerable(Of T), 
	IEnumerable, INotifyCollectionChanged, ISerializable

[SerializableAttribute]
generic<typename T>
where T : IChannel
public ref class ChannelCollectionBase abstract : public ListCollection<T>, 
	IChannelCollection<T>, IChannel, ISupportBinaryImage, IList<T>, ICollection<T>, 
	IEnumerable<T>, IEnumerable, INotifyCollectionChanged, ISerializable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type ChannelCollectionBase<'T when 'T : IChannel> = 
    class
        inherit ListCollection<'T>
        interface IChannelCollection<'T>
        interface IChannel
        interface ISupportBinaryImage
        interface IList<'T>
        interface ICollection<'T>
        interface IEnumerable<'T>
        interface IEnumerable
        interface INotifyCollectionChanged
        interface ISerializable
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

T: Specific IChannel type that the ChannelCollectionBaseT contains.

The ChannelCollectionBaseT type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Attributes	Gets a DictionaryTKey, TValue of string based property names and values for this IChannel object.
	BinaryLength	Gets the length of the ChannelCollectionBaseT.
	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.
	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.
	State	Gets or sets the parsing state for this IChannel object.
	Tag	Gets or sets a user definable reference to an object associated with this IChannel object.

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.
	Clear	Removes all items from the ICollectionT. (Inherited from ListCollectionT)
	ClearItems	Removes all elements from the ChannelCollectionBaseT. (Overrides ListCollectionTClearItems)
	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.
	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.
	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 ChannelCollectionBaseT at the specified index. (Overrides ListCollectionTInsertItem(Int32, T))
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnCollectionChanged	Raises the NotifyCollectionChangedEventHandler event.
	RefreshBinding	Manually sends a Reset to the collection changed event.
	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 ChannelCollectionBaseT. (Overrides ListCollectionTRemoveItem(Int32))
	SetItem	Replaces the element at the specified index. (Overrides ListCollectionTSetItem(Int32, T))
	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.

Top

Extension Methods

	Name	Description
	AddRangeT	Adds the specified items to the collection. (Defined by CollectionExtensions)
	AllParallelT	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	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)
	DistinctByT, TKey	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	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)
	GetRangeT	Returns elements in the specified range from the collection. (Defined by CollectionExtensions)
	IndexOfT	Returns the index of the first element of the sequence that satisfies a condition or -1 if no such element is found. (Defined by CollectionExtensions)
	LoadDelimitedStringT	Appends items parsed from delimited string, created with ToDelimitedString, using the default delimiter ("\|") into the given list. (Defined by CollectionExtensions)
	LoadDelimitedStringT	Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions)
	LoadDelimitedStringT	Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions)
	MajorityT	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityT	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByT, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByT, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxT	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxT	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByT, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianT	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinT	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinT	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByT, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityT	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityT	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByT, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByT, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)
	ScrambleT	Rearranges all the elements in the list into a highly-random order. (Defined by CollectionExtensions)
	ScrambleT	Rearranges all the elements in the list into a repeatable pseudo-random order. (Defined by CollectionExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationT	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringT	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringT	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringT	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListT	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)
	UnscrambleT	Rearranges all the elements in the list previously scrambled with ScrambleTSource(IListTSource, Int32) back into their original order. (Defined by CollectionExtensions)
	UpdateRangeT	Updates collection starting at the index with the specified items. (Defined by CollectionExtensions)

Top

Remarks

This channel collection implements IChannel (inherited via IChannelCollectionT) for the benefit of providing a cumulative binary image of the entire collection.

Reference

GSF.PhasorProtocols Namespace