Click or drag to resize

CollectionElement Class
Represents an Element which is a collection of other elements. Collection elements are part of the physical structure of a PQDIF file. They exist within the body of a Record.
Inheritance Hierarchy
SystemObject
  GSF.PQDIF.PhysicalElement
    GSF.PQDIF.PhysicalCollectionElement

Namespace: GSF.PQDIF.Physical
Assembly: GSF.PQDIF (in GSF.PQDIF.dll) Version: 2.4.181-beta
Syntax
Copy
public class CollectionElement : Element
View Source

The CollectionElement type exposes the following members.

Constructors
 NameDescription
Public methodCollectionElement Creates a new instance of the CollectionElement class.
Top
Properties
 NameDescription
Public propertyElements Gets a list of the element in this collection.
Public propertyReadSize Gets or sets the size that the file says the collection is. This may differ from the actual size if, upon parsing the file the end of file is reached before the collection becomes as large as the read size.
Public propertySize Gets or sets the number of elements in the collection.
Public propertyTagOfElement Gets or sets the tag which identifies the element.
(Inherited from Element)
Public propertyTypeOfElement Gets the type of the element. Returns Collection.
(Overrides ElementTypeOfElement)
Public propertyTypeOfValue Gets or sets the physical type of the value or values contained by the element.
(Inherited from Element)
Top
Methods
 NameDescription
Public methodAddElement Adds the given element to the collection.
Public methodAddOrUpdateScalar Updates the value of the scalar element identified by the given tag or adds a new scalar element if one does not already exist.
Public methodAddOrUpdateVector Updates the values contained by the vector element identified by the given tag or adds a new vector element if one does not already exist.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
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 methodGetCollectionByTag Gets the element whose tag matches the one given as a parameter, type cast to CollectionElement.
Public methodGetElementsByTag Gets the elements whose tag matches the one given as a parameter.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetOrAddScalar Gets the scalar element identified by the given tag or adds a new scalar element if one does not already exist.
Public methodGetOrAddVector Gets the vector element identified by the given tag or adds a new vector element if one does not already exist.
Public methodGetScalarByTag Gets the element whose tag matches the one given as a parameter, type cast to ScalarElement.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetVectorByTag Gets the element whose tag matches the one given as a parameter, type cast to VectorElement.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodRemoveElement Removes the given element from the collection.
Public methodRemoveElementsByTag Removes all elements identified by the given tag from the collection.
Public methodToString Returns a string that represents the collection.
(Overrides ObjectToString)
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