Click or drag to resize

SeriesInstance Class

Represents an instance of a series in a PQDIF file. A series instance resides in a ChannelInstance and is defined by a SeriesDefinition.
Inheritance Hierarchy
SystemObject
  GSF.PQDIF.LogicalSeriesInstance

Namespace: GSF.PQDIF.Logical
Assembly: GSF.PQDIF (in GSF.PQDIF.dll) Version: 2.4.218-beta
Syntax
public class SeriesInstance : IEquatable<SeriesInstance>
View Source

The SeriesInstance type exposes the following members.

Constructors
 NameDescription
Public methodSeriesInstance Creates a new instance of the SeriesInstance class.
Top
Properties
 NameDescription
Public propertyChannel Gets the channel instance in which the series instance resides.
Public propertyDefinition Gets the series definition that defines the series.
Public propertyOriginalValues Gets the original data values, after expanding sequences and scale and offset modifications.
Public propertyPhysicalStructure Gets the physical structure of the series instance.
Public propertySeriesOffset Gets the value added to the values in order to restore the original data values.
Public propertySeriesScale Gets the value by which to scale the values in order to restore the original data values.
Public propertySeriesShareChannel Gets the channel that owns the series to be shared.
Public propertySeriesShareChannelIndex Gets the index of the channel that owns the series to be shared.
Public propertySeriesShareSeries Gets the series to be shared.
Public propertySeriesShareSeriesIndex Gets the index of the series to be shared.
Public propertySeriesValues Gets the values contained in this series instance.
Top
Methods
 NameDescription
Public methodEquals(Object) Determines whether the specified SeriesInstance is equal to the current SeriesInstance.
(Overrides ObjectEquals(Object))
Public methodEquals(SeriesInstance) Indicates whether the current object is equal to another object of the same type.
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 methodGetHashCode Serves as a hash function for a particular type.
(Overrides ObjectGetHashCode)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodSetValues(IListObject) Sets the raw values to be written to the PQDIF file as the SeriesValues.
Public methodSetValues(Object, Object, Object) Sets the values to be written to the PQDIF file for the increment storage method.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberSeriesOffsetTag Tag that identifies the offset value to apply to the series.
Public fieldStatic memberSeriesScaleTag Tag that identifies the scale value to apply to the series.
Public fieldStatic memberSeriesShareChannelIndexTag Tag that identifies the index of the channel that owns the series to be shared.
Public fieldStatic memberSeriesShareSeriesIndexTag Tag that identifies the index of the series to be shared.
Public fieldStatic memberSeriesValuesTag Tag that identifies the values contained in the series.
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