C# 클래스 GSF.TimeSeries.MeasurementKey

파일 보기 프로젝트 열기: GridProtectionAlliance/gsf 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
Undefined MeasurementKey

공개 메소드들

메소드 설명
CreateOrUpdate ( System.Guid signalID, string value ) : MeasurementKey

Constructs a new MeasurementKey given the specified parameters.

CreateOrUpdate ( System.Guid signalID, string source, uint id ) : MeasurementKey

Constructs a new MeasurementKey given the specified parameters.

EstablishDefaultCache ( IDbConnection connection, Type adapterType, string measurementTable = "ActiveMeasurement" ) : void

Establish default MeasurementKey cache.

Source tables are expected to have at least the following fields: ID NVARCHAR Measurement key formatted as: ArchiveSource:PointID SignalID GUID Unique identification for measurement

GetHashCode ( ) : int

Serves as a hash function for the current MeasurementKey.

LookUpBySignalID ( System.Guid signalID ) : MeasurementKey

Looks up the measurement key associated with the given signal ID.

If no measurement key is found with the given signal ID, this method returns Undefined.

LookUpBySource ( string source, uint id ) : MeasurementKey

Looks up the measurement key associated with the given source and ID.

If no measurement key is found with the given source and ID, this method returns Undefined.

LookUpOrCreate ( System.Guid signalID, string value ) : MeasurementKey

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.

LookUpOrCreate ( System.Guid signalID, string source, uint id ) : MeasurementKey

Performs a lookup by signal ID and, failing that, attempts to create the key using the given signal ID, source, and ID.

LookUpOrCreate ( string value ) : MeasurementKey

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.

LookUpOrCreate ( string source, uint id ) : MeasurementKey

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.

Parse ( string value ) : MeasurementKey

Converts the string representation of a MeasurementKey into its value equivalent.

SetMeasurementMetadata ( string tagName, double adder, double multiplier, MeasurementValueFilterFunction valueFilter ) : void

Updates the values of the Metadata.

ToString ( ) : string

Returns a string that represents the current MeasurementKey.

TryCreateOrUpdate ( System.Guid signalID, string value, MeasurementKey &key ) : bool

Constructs a new MeasurementKey given the specified parameters.

TryCreateOrUpdate ( System.Guid signalID, string source, uint id, MeasurementKey &key ) : bool

Constructs a new MeasurementKey given the specified parameters.

TryParse ( string value, MeasurementKey &key ) : bool

Attempts to convert the string representation of a MeasurementKey into its value equivalent.

비공개 메소드들

메소드 설명
CreateUndefinedMeasurementKey ( ) : MeasurementKey

Creates the undefined measurement key. Used to initialize Undefined.

MeasurementKey ( ) : System
MeasurementKey ( System.Guid signalID, uint id, string source ) : System
TrySplit ( string value, string &source, uint &id ) : bool

Attempts to split the given string representation of a measurement key into a source and ID pair.

메소드 상세

CreateOrUpdate() 공개 정적인 메소드

Constructs a new MeasurementKey given the specified parameters.
cannot be empty The value is not in the correct format for a value.
public static CreateOrUpdate ( System.Guid signalID, string value ) : MeasurementKey
signalID System.Guid ID of associated signal, if defined.
value string A string representation of the .
리턴 MeasurementKey

CreateOrUpdate() 공개 정적인 메소드

Constructs a new MeasurementKey given the specified parameters.
cannot be empty. cannot be null.
public static CreateOrUpdate ( System.Guid signalID, string source, uint id ) : MeasurementKey
signalID System.Guid ID of associated signal, if defined.
source string Source of the measurement that this represents (e.g., name of archive).
id uint Numeric ID of the measurement that this represents.
리턴 MeasurementKey

EstablishDefaultCache() 공개 정적인 메소드

Establish default MeasurementKey cache.
Source tables are expected to have at least the following fields: ID NVARCHAR Measurement key formatted as: ArchiveSource:PointID SignalID GUID Unique identification for measurement
public static EstablishDefaultCache ( IDbConnection connection, Type adapterType, string measurementTable = "ActiveMeasurement" ) : void
connection IDbConnection The database connection.
adapterType System.Type The database adapter type.
measurementTable string Measurement table name used to load measurement key cache.
리턴 void

GetHashCode() 공개 메소드

Serves as a hash function for the current MeasurementKey.
public GetHashCode ( ) : int
리턴 int

LookUpBySignalID() 공개 정적인 메소드

Looks up the measurement key associated with the given signal ID.
If no measurement key is found with the given signal ID, this method returns Undefined.
public static LookUpBySignalID ( System.Guid signalID ) : MeasurementKey
signalID System.Guid The signal ID of the measurement key.
리턴 MeasurementKey

LookUpBySource() 공개 정적인 메소드

Looks up the measurement key associated with the given source and ID.
If no measurement key is found with the given source and ID, this method returns Undefined.
public static LookUpBySource ( string source, uint id ) : MeasurementKey
source string The source of the signal.
id uint The source-specific unique integer identifier.
리턴 MeasurementKey

LookUpOrCreate() 공개 정적인 메소드

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 static LookUpOrCreate ( System.Guid signalID, string value ) : MeasurementKey
signalID System.Guid The signal ID of the key to be looked up.
value string A string representation of the .
리턴 MeasurementKey

LookUpOrCreate() 공개 정적인 메소드

Performs a lookup by signal ID and, failing that, attempts to create the key using the given signal ID, source, and ID.
public static LookUpOrCreate ( System.Guid signalID, string source, uint id ) : MeasurementKey
signalID System.Guid The signal ID of the key to be looked up.
source string The source to use for the key if the lookup fails.
id uint The ID to use for the key if the lookup fails.
리턴 MeasurementKey

LookUpOrCreate() 공개 정적인 메소드

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 static LookUpOrCreate ( string value ) : MeasurementKey
value string A string representation of the .
리턴 MeasurementKey

LookUpOrCreate() 공개 정적인 메소드

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 static LookUpOrCreate ( string source, uint id ) : MeasurementKey
source string The source to use for the key if the lookup fails.
id uint The ID to use for the key if the lookup fails.
리턴 MeasurementKey

Parse() 공개 정적인 메소드

Converts the string representation of a MeasurementKey into its value equivalent.
The value is not in the correct format for a value.
public static Parse ( string value ) : MeasurementKey
value string A string representing the to convert.
리턴 MeasurementKey

SetMeasurementMetadata() 공개 메소드

Updates the values of the Metadata.
public SetMeasurementMetadata ( string tagName, double adder, double multiplier, MeasurementValueFilterFunction valueFilter ) : void
tagName string Gets or sets the text based tag name.
adder double Defines an offset to add to the value.
multiplier double Defines a multiplicative offset to apply to the value.
valueFilter MeasurementValueFilterFunction Defines the to use when downsampling this type of value.
리턴 void

ToString() 공개 메소드

Returns a string that represents the current MeasurementKey.
public ToString ( ) : string
리턴 string

TryCreateOrUpdate() 공개 정적인 메소드

Constructs a new MeasurementKey given the specified parameters.
cannot be empty. Measurement key Source cannot be null.
public static TryCreateOrUpdate ( System.Guid signalID, string value, MeasurementKey &key ) : bool
signalID System.Guid ID of associated signal, if defined.
value string A string representation of the .
key MeasurementKey The measurement key that was created or updated or .
리턴 bool

TryCreateOrUpdate() 공개 정적인 메소드

Constructs a new MeasurementKey given the specified parameters.
cannot be empty. cannot be null.
public static TryCreateOrUpdate ( System.Guid signalID, string source, uint id, MeasurementKey &key ) : bool
signalID System.Guid ID of associated signal, if defined.
source string Source of the measurement that this represents (e.g., name of archive).
id uint Numeric ID of the measurement that this represents.
key MeasurementKey The measurement key that was created or updated or .
리턴 bool

TryParse() 공개 정적인 메소드

Attempts to convert the string representation of a MeasurementKey into its value equivalent.
public static TryParse ( string value, MeasurementKey &key ) : bool
value string A string representing the to convert.
key MeasurementKey Output in which to stored parsed value.
리턴 bool

프로퍼티 상세

Undefined 공개적으로 정적으로 프로퍼티

Represents an undefined measurement key.
public static MeasurementKey,GSF.TimeSeries Undefined
리턴 MeasurementKey