Click or drag to resize

MeasurementKey Class

Represents a primary key for a measurement.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeriesMeasurementKey

Namespace: GSF.TimeSeries
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.207-beta
Syntax
[SerializableAttribute]
public class MeasurementKey
View Source

The MeasurementKey type exposes the following members.

Properties
 NameDescription
Public propertyID Gets or sets the numeric ID of this MeasurementKey.
Public propertyMetadata Gets the MeasurementMetadata as they appear in the primary DataSource.
Public propertyRuntimeID A unique ID that is assigned at runtime to identify this instance of MeasurementKey. This value will change between life cycles, so it cannot be used to compare MeasurementKey instances that are running out of process or in a separate AppDomain.
Public propertySignalID Gets or sets Guid ID of signal associated with this MeasurementKey.
Public propertySource Gets or sets the source of this MeasurementKey.
Top
Methods
 NameDescription
Public methodStatic memberCreateOrUpdate(Guid, String) Constructs a new MeasurementKey given the specified parameters.
Public methodStatic memberCreateOrUpdate(Guid, String, UInt64) Constructs a new MeasurementKey given the specified parameters.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodStatic memberEstablishDefaultCache Establish default MeasurementKey cache.
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 the current MeasurementKey.
(Overrides ObjectGetHashCode)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodStatic memberLookUpBySignalID Looks up the measurement key associated with the given signal ID.
Public methodStatic memberLookUpBySource Looks up the measurement key associated with the given source and ID.
Public methodStatic memberLookUpOrCreate(String) Performs a lookup by source and, failing that, attempts to create the key using a newly generated signal ID and the parsed source and ID.
Public methodStatic memberLookUpOrCreate(Guid, String) Performs a lookup by signal ID and, failing that, attempts to create the key using the given signal ID and the parsed source, and ID.
Public methodStatic memberLookUpOrCreate(String, UInt64) Performs a lookup by source and, failing that, attempts to create the key using a newly generated signal ID and the given source and ID.
Public methodStatic memberLookUpOrCreate(Guid, String, UInt64) Performs a lookup by signal ID and, failing that, attempts to create the key using the given signal ID, source, and ID.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodStatic memberParse Converts the string representation of a MeasurementKey into its value equivalent.
Public methodSetMeasurementMetadata Updates the values of the Metadata.
Public methodToString Returns a String that represents the current MeasurementKey.
(Overrides ObjectToString)
Public methodStatic memberTryCreateOrUpdate(Guid, String, MeasurementKey) Constructs a new MeasurementKey given the specified parameters.
Public methodStatic memberTryCreateOrUpdate(Guid, String, UInt64, MeasurementKey) Constructs a new MeasurementKey given the specified parameters.
Public methodStatic memberTryParse Attempts to convert the string representation of a MeasurementKey into its value equivalent.
Top
Fields
 NameDescription
Public fieldStatic memberUndefined Represents an undefined measurement key.
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