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.257-beta

Syntax

public class SeriesInstance : IEquatable<SeriesInstance>

Public Class SeriesInstance
	Implements IEquatable(Of SeriesInstance)

public ref class SeriesInstance : IEquatable<SeriesInstance^>

type SeriesInstance = 
    class
        interface IEquatable<SeriesInstance>
    end

GSF.PQDIF.Logical.SeriesInstance = function();

Type.createClass(
	'GSF.PQDIF.Logical.SeriesInstance',
	null,
	IEquatable`1);

The SeriesInstance type exposes the following members.

Constructors

	Name	Description
	SeriesInstance	Creates a new instance of the SeriesInstance class.

Properties

	Name	Description
	Channel	Gets the channel instance in which the series instance resides.
	Definition	Gets the series definition that defines the series.
	OriginalValues	Gets the original data values, after expanding sequences and scale and offset modifications.
	PhysicalStructure	Gets the physical structure of the series instance.
	SeriesOffset	Gets the value added to the values in order to restore the original data values.
	SeriesScale	Gets the value by which to scale the values in order to restore the original data values.
	SeriesShareChannel	Gets the channel that owns the series to be shared.
	SeriesShareChannelIndex	Gets the index of the channel that owns the series to be shared.
	SeriesShareSeries	Gets the series to be shared.
	SeriesShareSeriesIndex	Gets the index of the series to be shared.
	SeriesValues	Gets the values contained in this series instance.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified SeriesInstance is equal to the current SeriesInstance. (Overrides ObjectEquals(Object))
	Equals(SeriesInstance)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SetValues(IListObject)	Sets the raw values to be written to the PQDIF file as the SeriesValues.
	SetValues(Object, Object, Object)	Sets the values to be written to the PQDIF file for the increment storage method.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

	Name	Description
	SeriesOffsetTag	Tag that identifies the offset value to apply to the series.
	SeriesScaleTag	Tag that identifies the scale value to apply to the series.
	SeriesShareChannelIndexTag	Tag that identifies the index of the channel that owns the series to be shared.
	SeriesShareSeriesIndexTag	Tag that identifies the index of the series to be shared.
	SeriesValuesTag	Tag that identifies the values contained in the series.

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)