3.18.1 Metody

 

 

CreateSeries

 

AsloggerSeries CreateSeries(string aPlanName, string aDescription, DateTime aSeriesTimeUtc, int aSamplingTime);

Function CreateSeries(ByVal aPlanName As  String, ByVal aDescription As  String, ByVal aSeriesTimeUtc As  DateTime, ByVal aSamplingTime As  Integer) As AsloggerSeries  

 

Metoda jest wykorzystywane w procesie zapisu nowej serii pomiarowej - tworzy obiekt klasy AsloggerSeries służacy następnie do konstrukcji zawartości serii i jej zapisu.

Parametr aPlanName określa nazwę planu, do którego seria będzie należała. Parametr aDescription służy do dodania do serii jej opisu.

Parametr aSeriesTimeUtc określa stempel czasu zapisywanej serii w standardzie UTC, a aSamplingTime to okres czasu pomiędzy kolejnymi wartościami serii wyrażony w mikrosekundach.

UWAGA

Dodanie serii do bazy danych wymaga wcześniejszego zdefiniowania, w bazie danych modułu AsLogger, planu rejestracji wraz ze wszystkimi punktami składowymi.

 

 

DeleteSeries

 

bool DeleteSeries(string aPlanName, int? aSeriesId);

Function DeleteSeries(ByVal aPlanName As  String, ByVal aSeriesId As  Integer?) As Boolean  

 

Metoda służy do usunięcia serii pomiarowej określonej nazwą planu (parametr  aPlanName) i numerem identyfikacyjnym serii (parametr aSeriesId). Zestaw poprawnych identyfikatorów serii można uzyskać przy pomocy metody ReadSeries. Przekazenie wartości pustej w parametrze aSeriesId oznacza usunięcie ostatniej zarejestrownej serii.

 

 

 

ExecuteQuery

 

System.Data.DataTable ExecuteQuery(string aQuery);

Function ExecuteQuery(ByVal aQuery As  String) As System.Data.DataTable  

 

Metoda pozwala na wykonanie dowolnego zapytania podanego w parametrze aQuery na bazie danych AsLogger. Metoda zwraca obiekt klasy DataTable zawierający odczytane rekordy.

Użycie metody wymaga znajomości struktury bazy AsLogger. Metodę należy używac tylko wtedy, gdy żadna ze specjalizowanych metod klasy AsLoggerAccess nie jest wystarczająca.

 

UWAGA

Chociaż, zasadniczo metoda przeznaczona jest do wykonywania zapytań typu Select, to możliwe jest również wykonanie komend zmieniających dane w bazie danych. Należy jednak zachować maksymalną ostrożność - nieprawidłowe użycie może doprowadzić do utraty całości zgromadzonych danych.

 

 

ReadPlans

 

System.Data.DataTable ReadPlans(string aPlanName, string aWherePhrase);

Function ReadPlans(ByVal aPlanName As  String, ByVal aWherePhrase As  String) As System.Data.DataTable  

Metoda służy do odczytu informacji dotyczących planów rejestracji zdefiniowanych w bazie danych mudułu AsLogger. Parametr aPlanName służy do określenia nazwy planu rejestracji. Przekazanie wartość pustej (null lub Nothing) powoduje zwrócenie danych dla wszystkich planów rejesteracji. W treści parametru można też użyć znaków specjalnych w konwencji SQL (% lub _) w celu wyboru podgrupy planów.

Jeżeli selekcja po nazwie planu jest niewystarczająca, to można użyć parametr aWherePhrase. Parametr powinien być zgodny ze składnią klauzuli where języka SQL. Użycie parametru wymaga znajomości struktury bazy AsLogger.

 

 

 

ReadPoints

 

System.Data.DataTable ReadPoints(string aPlanName, string aWherePhrase);

Function ReadPoints(ByVal aPlanName As  String, ByVal aWherePhrase As  String) As System.Data.DataTable  

Metoda służy do odczytu informacji dotyczących punktów wchodzących w skład planu rejestracji o nazwie określonej parametrem aPlanName.

Standardowo zwracane są dane wszystkich punktów planu. Zestaw można ograniczyć przy pomocy parametru aWherePhrase. Parametr powinien być zgodny ze składnią klauzuli where języka SQL. Użycie parametru wymaga znajomości struktury bazy AsLogger. W szczególności wartość parametru Name = ’P1’  , oznacza odpytanie o dane konfiguracyjne wyłącznie dla punktu o nazwie P1.

 

 

 

ReadSeries

 

System.Data.DataTable ReadSeries(string aPlanName, DateTime? aStartTimeUtc, DateTime? aEndTimeUtc, string aWherePhrase, bool aAddLocalTimeColumn);

Function ReadSeries(ByVal aPlanName As  String, ByVal aStartTimeUtc As  DateTime?, ByVal aEndTimeUtc As DateTime?, ByVal aWherePhrase As  String, ByVal aAddLocalTimeColumn As  Boolean) As System.Data.DataTable  

 

Metoda służy do odczytu informacji dotyczących zarejestrowanych serii pomiarowych dla planu rejestracji o nazwie określonej parametrem aPlanName.

Parametry aStartTimeUtc i aEndTimeUtc służą do określenia zakresu czasowego dla pobieranych rekordów. Czasy podawane są w standardzie UTC. Przekazanie wartości pustej (null lub Nothing) oznacza brak ograniczenia czasowego.

Standardowo zwracane są dane wszystkich serii z okresu określonego parametrami aStartTime  i aEndTime. Zestaw można ograniczyć przy pomocy parametru aWherePhrase. Parametr powinien być zgodny ze składnią klauzuli where języka SQL. Użycie parametru wymaga znajomości struktury bazy AsLogger.

Parametr aAddLocalTimeColumn pozwala na dodanie do wynikowego obiektu DataTable kolumny BeginTimeLocal przekazującej czasy początków serii jako czasy lokalne. Standardowo, dostępny jest tylko czas UTC w kolumnie BeginTimeUtc. Dodanie czasu lokalnego może być szczególnie przydatne w przypadku tworzenia raportów za pośrednictwem klasy Report.

W zestawie kolumn, w zwróconym przez metodę obiekcie DataTable, szczególnie istotna jest kolumna IdSerie. Przechowuje ona identyfikatory serii, które mogą być później wykorzystane do odczytu danych serii metodą ReadSeriesData lub usunięcia serii metodą DeleteSeries.

 

 

 

ReadSeriesAggregates

 

System.Data.DataTable ReadSeriesAggregates(string aPlanName, SeriesAggregateId aAggregate, DateTime? aStartTimeUtc, DateTime? aEndTimeUtc, string aWherePhrase, bool aAddLocalTimeColumn, params string[] aPointsNames);

Function ReadSeriesAggregates(ByVal aPlanName As  String, ByVal aAggregate As  SeriesAggregateId, ByVal aStartTimeUtc As  DateTime?, ByVal aEndTimeUtc As DateTime?, ByVal aWherePhrase As  String, ByVal aAddLocalTimeColumn As  Boolean, ByVal ParamArray aPointsNames As  String()) As System.Data.DataTable  

 

Metoda służy do odczytu agregatów zarejestrowanych serii pomiarowych dla planu rejestracji o nazwie określonej parametrem aPlanName.

Parametr aAggregate określa typ agregatu:

SeriesAggregateId.SeriesMinimum  - minimalna wartość w serii

SeriesAggregateId.SeriesMaximum  - maksymalna wartość w serii

SeriesAggregateId.SeriesAverage  - średnia wartość serii

Parametry aStartTimeUtc i aEndTimeUtc służą do określenia zakresu czasowego serii pomiarowych, dla których agregaty są pobierane. Czasy podawane są w standardzie UTC. Przekazanie wartości pustej (null lub Nothing) oznacza brak ograniczenia czasowego.

Standardowo zwracane są agregaty wszystkich serii z okresu określonego parametrami aStartTime  i aEndTime. Zestaw serii można ograniczyć przy pomocy parametru aWherePhrase. Parametr powinien być zgodny ze składnią klauzuli where języka SQL. Użycie parametru wymaga znajomości struktury bazy AsLogger.

Parametr aAddLocalTimeColumn pozwala na dodanie do wynikowego obiektu DataTable kolumny SampleTimeLocal przekazującej czasy agregatów jako czasy lokalne. Standardowo, dostępny jest tylko czas UTC w kolumnie SampleTimeUtc. Dodanie czasu lokalnego może być szczególnie przydatne w przypadku tworzenia raportów za pośrednictwem klasy Report.

Parametr aPointsNames służy do przekazania nazw punktów serii, dla których agregaty mają zostać pobrane. Jeżeli parametr nie zostanie użyty, to pobrane będą agregaty wszystkich punktów.

 

 

ReadSeriesData

 

System.Data.DataTable ReadSeriesData(string aPlanName, AggregateId aAggregate, int? aSeriesId, string aWherePhrase, bool aAddLocalTimeColumn, params string[] aPointsNames);

Function ReadSeriesData(ByVal aPlanName As  String, ByVal aAggregate As  AggregateId, ByVal aSeriesId As  Integer?, ByVal aWherePhrase As  String, ByVal aAddLocalTimeColumn As  Boolean, ByVal ParamArray aPointsNames As  String()) As System.Data.DataTable  

 

Metoda służy do odczytu zarejestrowanych wartości w serii pomiarowej określonej nazwą planu (parametr  aPlanName) i numerem identyfikacyjnym serii (parametr aSeriesId). Zestaw poprawnych identyfikatorów serii można uzyskać przy pomocy metody ReadSeries. Przekazenie wartości pustej w parametrze aSeriesId oznacza odczyt wartości dla ostatniej zarejestrownej serii.

Parametr aAggregate określa typ odczytywanych wartości punktów:

AggregateId.RawData  - dane surowe

AggregateId.Minimum  - okresowa minimalna wartość (liczona z każdych kolejnych 100 wartości surowych)

AggregateId.Maximum  - okresowa maksymalna wartość (liczona z każdych kolejnych 100 wartości surowych)

AggregateId.Average  - okresowa średnia wartość (liczona z każdych kolejnych 100 wartości surowych)

AggregateId.SeriesMinimum  - minimalna wartość w serii

AggregateId.SeriesMaximum  - maksymalna wartość w serii

AggregateId.SeriesAverage  - średnia wartość serii

Parametr aWherePhrase pozwala dodatkowo ograniczyć zestaw zwracanych wartości. Parametr powinien być zgodny ze składnią klauzuli where języka SQL. Użycie parametru wymaga znajomości struktury bazy AsLogger.

Parametr aAddLocalTimeColumn pozwala na dodanie do wynikowego obiektu DataTable kolumny SampleTimeLocal przekazującej czasy próbek jako czasy lokalne. Standardowo, dostępny jest tylko czas UTC w kolumnie SampleTimeUtc. Dodanie czasu lokalnego może być szczególnie przydatne w przypadku tworzenia raportów za pośrednictwem klasy Report.

Parametr aPointsNames służy do przekazania nazw punktów serii, dla których wartości mają zostać pobrane. Jeżeli parametr nie zostanie użyty, to pobrane będą wartości dla wszystkich punktów.

 

 

 

SetAccessData

 

void SetAccessData(string aServerName, string aDatabaseName);

Sub SetAccessData (ByVal aServerName As  String, ByVal aDatabaseName As  String)

 

Metoda SetAccessData powinna być zawsze wywoływana jako pierwsza po uzyskaniu dostępu do obiektu AsloggerAccess. Służy ona do określenia lokalizacji bazy danych modułu AsLogger. Parametr aServerName określa nazwę serwera SQL, a parametr  aDatabaseName nazwę bazy danych.