4 Spis i opis funkcji

 

Dostęp do elementów aplikacji

AppData - zwraca wartość wskazanej danej aplikacyjnej lub jej elementu składowego

AppDataOrDefault - sprawdza, czy istnieje dana aplikacyjna o wskazanej nazwie

Asix6Attribute - zwraca wartość wskazanego atrybutu zmiennej procesowej w postaci liczbowej. Jeżeli atrybut nie jest liczbą, to jest traktowany jako nazwa zmiennej i zwracana jest wartość tej zmiennej.

Attribute - zwraca wartość wskazanego atrybutu zmiennej procesowej

AttributeOrDefault - zwraca wartość wskazanego atrybutu zmiennej procesowej, lub wartość zastępczą w przypadku błędu.

ExistAppData - sprawdza, czy istnieje dana aplikacyjna o wskazanej nazwie

ExistsAttribute - sprawdza w bazie definicji zmiennych aplikacji, czy używany jest podany atrybut

GetDictionary – zwraca treść słownika wartości pobranego ze wskazanego obiektu tabelarycznego

GetDictionaryValue – zwraca wartość wyliczoną przy pomocy słownika wartości pobranego ze wskazanego obiektu tabelarycznego

GetMessage – zwraca tekst, kolor tekstu albo tła odpowiadający określonej wartości wskazanego zestawu komunikatów

LocalProperty - zwraca wartość właściwości obiektu lub diagramu

LocalPropertyStatus - zwraca status OPC związany z właściwością obiektu lub diagramu

MeasurementStatus - zwraca status pomiarowy (True/False) zmiennej w oparciu o wartość zmiennej kontrolnej

ObjectData - zwraca wskazaną wartość danej lub stanu wybranego obiektu diagramu

Parameter - zwraca wartość parametru użytego w diagramie lub wzorcu

Parameters - zwraca ciąg nazw i wartości wszystkich parametrów używanych w diagramie, wzorcu lub menu

PowerGuardRead - odczyt danych mierników modułu Strażnik mocy

Property - zwraca wartość właściwości globalnej

Reg - zwraca wartość wskazanego rejestru diagramu lub wzorca

RegStatus - zwraca status OPC wartości wskazanego rejestru diagramu lub wzorca

ScriptValue - wywołuje wskazany skrypt i zwraca wynik jego działania

Text - zwraca tekst z puli tekstów wielojęzycznych

TimetableRead – odczyt wybranych danych związanych z harmonogramem

 

Dostęp do wartości bieżących zmiennych procesowych

Asix6Limit - sprawdza warunek przekroczenia limitu wartości zmiennej procesowej zgodnie z algorytmem stosowanym w aplikacjach Asix6

CheckStateMask - testuje, czy wartość zmiennej procesowej jest zgodna z podanym stanem. Testowany stan opisany jest wartościami liczbowymi maski i spodziewanej wartości.

CheckStateTemplate - testuje, czy wartość zmiennej procesowej  jest zgodna z podanym stanem. Testowany stan opisany jest w postaci tekstowej.

ExistsVariable - sprawdza, czy zmienna procesowa o podanej nazwie jest zdefiniowana

GetStateDescription - zwraca opis stanu zmiennej procesowej w oparciu o informacje znajdujące się w bazie zmiennych

GetStateText - zwraca nazwę stanu zmiennej procesowej w oparciu o informacje znajdujące się w bazie zmiennych

NewValue - zwraca nową wartość zmiennej procesowej. Funkcja używana  tylko w trakcie wykonywania operacji sterującej w funkcji przeliczającej zapisu.

RawValue - zwraca wartość surową zmiennej procesowej,  bez wykonania przeliczeń zdefiniowanych w bazie definicji zmiennych

TableElement - zwraca wskazany element z wartości zmiennej procesowej  typu tablicowego

TableLength - zwraca liczbę elementów w zmiennej procesowej typu tablicowego

VarBit - zwraca stan (True/False) wskazanego bitu zmiennej procesowej

VarChanged - informuje, czy wartość zmiennej uległa zmianie  w ostatnim okresie czasu

Variable - zwraca bieżąca wartość zmiennej procesowej po zastosowaniu przeliczeń zdefiniowanych w bazie definicji zmiennych

VariableOrDefault - zwraca bieżąca wartość zmiennej procesowej lub wartość domyślną, gdy zmienna nie jest zdefiniowana

VarIsBad - zwraca wartość logiczną informującą, czy status wartości zmiennej jest niepoprawny

VarIsGood - informuje, czy status wartości zmiennej procesowej jest dobry

VarIsNotGood - informuje, czy status wartości zmiennej procesowej nie jest dobry

VarIsUncertain - zwraca wartość logiczną informującą, czy status wartości zmiennej jest niepewny

VarStatus - zwraca status wartości zmiennej procesowej

VarStringValue - zwraca wartość tekstową  zmiennej procesowej, utworzoną na podstawie formatu zdefiniowanego w bazie definicji zmiennych

VarTime - zwraca czas ostatniej aktualizacji wartości zmiennej procesowej

VarTimeUtc - zwraca czas UTC ostatniej aktualizacji wartości zmiennej procesowej

VarValueChangeTime - zwraca czas ostatniej zmiany wartości lub statusu zmiennej procesowej

 

Dostęp do wartości historycznych zmiennych procesowych

HorizonAggregate - zwraca wartość agregatu wartości historycznych zmiennej procesowej ze wskazanego horyzontu czasu liczonego względem chwili bieżącej.

RangeAggregate - zwraca wartość agregatu wartości historycznych zmiennej procesowej ze wskazanego zakresu czasu.

Funkcje stanu obiektów i diagramów

Angle -  wylicza kąt odpowiadający położeniu kursora w obrębie bieżącego obiektu względem środka tego obiektu

CurrentGisLatitude - zwraca aktualną szerokość geograficzną środka wskazanego (lub kontekstowego) diagramu GIS

CurrentGisLongitude - zwraca aktualną długość geograficzną środka wskazanego (lub kontekstowego) diagramu GIS

EventContext – zwraca wskazaną daną kontekstu zdarzenia, której można użyć w argumentach akcji operatorskiej

HasWaitingControl - informuje, czy znajduje się w stanie oczekiwania na wysłanie sterowania

IsActive - informuje, czy obiekt jest aktywny, czyli może wykonywać operacje sterujące

IsBlinkOff - informuje o aktualnej fazie migotania (zwraca cyklicznie wartości true lub false)

IsDiagramActive - informuje, czy diagram o podanej nazwie jest aktualnie diagramem aktywnym (bieżącym)

IsDiagramActivePar - informuje, czy diagram o podanej nazwie i zestawie parametrów jest aktualnie diagramem aktywnym (bieżącym)

IsDiagramOpened - informuje, czy diagram o podanej nazwie jest uruchomiony

IsGisLayerVisible - informuje, czy wskazana warstwa diagramu GIS jest widoczna

CurrentGisZoom- zwraca bieżącą skalę (powiększenie) diagramu GIS

IsSelected - informuje, czy obiekt jest aktualnie wybrany (jest obiektem bieżącym)

IsWindowOpened - informuje, czy okno o podanej nazwie jest uruchomione

Wsparcie dla systemu alarmów

AlarmsControler - funkcja zwraca nazwę aktywnego kontrolera

AlarmsGroupState - zwraca status grupy alarmów, pozwala sprawdzić, czy w grupie są alarmy aktywne  lub/i niepotwierdzone.

AlarmsMode - informuje o aktualnym trybie pracy systemu alarmów

DeadBand - funkcja wykorzystywana w wykrywaniu alarmów, kontroluje przekraczanie limitów z histerezą

DelayedState - funkcja wykorzystywana w wykrywaniu alarmów,  wykrywa brak przewidywanych zmian stanu

IsAlarm - informuje, czy alarm znajduje się w logu alarmów aktywnych i czy jest aktywny(niezakończony)

IsAlarmExcluded - informuje, czy wskazany alarm jest aktualnie wykluczony

IsAlarmUnaccepted - informuje, czy alarm znajduje się w logu alarmów aktywnych i czy jest niepotwierdzony

RateOfChange - funkcja wykorzystywana w wykrywaniu alarmów, monitoruje prędkość zmian wartości wyrażenia


 

Funkcje konwersji współrzędnych

AbsToRelX - konwertuje współrzędną poziomą lub szerokość z wartości bezwzględnej (0 do 1 000 000) na wartość względną w pikselach

AbsToRelY - konwertuje współrzędną pionową lub wysokość z wartości bezwzględnej (0 do 1 000 000) na wartość względną w pikselach

RelToAbsX - konwertuje współrzędną poziomą lub szerokość z wartości względnej w pikselach na wartość bezwzględną (0 do 1 000 000)

RelToAbsY - konwertuje współrzędną pionową lub wysokość z wartości względnej w pikselach na wartość bezwzględną (0 do 1 000 000)

XOnScreen - przelicza współrzędną poziomą z wartości względnej wskazanego monitora na wartość bezwzględną dla pełnego pulpitu

YOnScreen  - przelicza współrzędną pionową z wartości względnej wskazanego monitora na wartość bezwzględną dla pełnego pulpitu

Kontrola stanu klawiatury i myszki

CursorX - zwraca współrzędną X aktualnego położenia kursora w ramach diagramu

CursorY - zwraca współrzędną Y aktualnego położenia kursora w ramach diagramu

IsControlPressed - informuje, czy klawisz Control jest wciśnięty

IsAltPressed - informuje, czy klawisz Alt jest wciśnięty

IsShiftPressed - informuje, czy klawisz Shift jest wciśnięty

IsMouseOver - informuje, czy kursor myszki znajduje się nad obiektem

IsMousePressed - informuje, czy przyciśnięty jest klawisz myszki i kursor myszki znajduje się nad obiektem 

LastKeyPressed - zwraca opis ostatnio przyciśniętego klawisza na klawiaturze

Operacje na łańcuchach tekstowych

Concat - łączy wiele ciągów znaków w pojedynczy napis

ContainsString - funkcja  informuje, czy w podanym łańcuchu tekstowym występuje określony ciąg znaków.

Format - zwraca napis utworzony zgodnie z podanym formatem

Replace - zamienia wszystkie wystąpienia wskazanego podciągu na inny ciąg znaków

SplitString - dzieli napis według podanego separatora na podciągi składowe

Substring - zwraca napis będący fragmentem napisu podanego w wywołaniu funkcji

ToLower - zwraca napis skonwertowany na małe litery

ToUpper - zwraca napis skonwertowany na wielkie litery

Funkcje arytmetyczne

Abs - zwraca wartość bezwzględną

Acos - zwraca wartość funkcji arcus cosinus

Add – sumuje dowolną liczbę argumentów numerycznych

And – wykonuje iloczyn logiczny na dowolnej liczbie argumentów

Asin - zwraca wartość funkcji arcus sinus

Atan - zwraca wartość funkcji arcus tangens

Atan2 - zwraca wartość funkcji arcus tangens dla ilorazu dwóch liczb (współrzędnych kartezjańskich)

Ceiling - zwraca najmniejszą liczbę całkowitą większą lub równą podanej liczbie

Cos - wylicza wartość funkcji cosinus

Div - wylicza iloraz dwóch liczb z kontrolą poprawności wykonania

E - zwraca wartość liczby e

Floor - zwraca największą liczbę całkowitą mniejszą lub równą podanej liczbie

Log - wylicza wartość logarytmu naturalnego

Log10 - wylicza wartość logarytmu dziesiętnego

Max - zwraca większą liczbę

Min - zwraca mniejszą liczbę

Or – wykonuje sumę logiczną na dowolnej liczbie argumentów

PI - zwraca wartość liczby pi

Pow - wylicza wartość liczby podniesionej do podanej potęgi

Round - zaokrągla liczbę do podanej liczby cyfr ułamkowych

Sin - wylicza wartość funkcji sinus

Sqrt - wylicza wartość pierwiastka kwadratowego

Tan - wylicza wartość funkcji tangens

Truncate - zwraca część całkowitą liczby

Funkcje konwersji wartości      

CheckOPCStatus - pozwala na uproszczone testowanie wartości statusu OPC

Color - tworzy wartość koloru na podstawie podanych barw podstawowych RGB

FromAsix6Date  - konwertuje liczbową wartość daty i czasu aplikacji Asix6 na format daty i czasu

FromAsix6Time - konwertuje liczbową wartość zakresu czasu aplikacji Asix6 na format zakresu czasu

OPCTime - tworzy wartość daty i czasu po zastosowaniu modyfikacji opisanej rozszerzonym wyrażeniem formatującym OPC

ToAsix6Date  - konwertuje datę i czas na liczbową wartość daty i czasu  aplikacji Asix6

ToAsix6Time - konwertuje zakres czasu na liczbową wartość zakresu czasu aplikacji Asix6

                ToBool - konwersja na wartość logiczną true/false

ToDateTime - konwertuje wartość do postaci daty i czasu

ToDouble - konwersja na liczbę zmiennoprzecinkową podwójnej precyzji

                ToInt8 - konwersja na 8-bitową liczbę całkowitą ze znakiem

                ToInt16 - konwersja na 16-bitową liczbę całkowitą ze znakiem

                ToInt32 - konwersja na 32-bitową liczbę całkowitą ze znakiem

                ToInt64 - konwersja na 64-bitową liczbę całkowitą ze znakiem

                ToLocalTime - konwersja wartość typu data/czas z czasu UTC na lokalny 

ToSingle - konwersja na liczbę zmiennoprzecinkową pojedynczej precyzji

ToString - konwertuje wartość liczbową interpretowaną jako sekwencję znaków Ascii na tekst

ToTimeSpan - konwertuje wartość do postaci zakresu czasu

ToUInt8 - konwersja na 8-bitową liczbę całkowitą bez znaku

                ToUInt16 - konwersja na 16-bitową liczbę całkowitą bez znaku

                ToUInt32 - konwersja na 32-bitową liczbę całkowitą bez znaku

                ToUInt64 - konwersja na 64-bitową liczbę całkowitą bez znaku

                ToUTCTime - konwersja wartość typu data/czas z czasu lokalnego na UTC

ValueOrDefault - zwraca wartość lub wartość domyślną

XorColor - zwraca dopełnienie (XOR) podanego koloru

Pomocnicze

ApplicationChanged - informuje, czy aplikacja została zaktualizowana

AsbaseText - zamiana wartości liczbowej na tekst na podstawie słownika zdefiniowanego w aplikacji Asbase

AsserviceRead - odczyt wartości pola licznika programu AsService

ChannelState - zwraca status pracy kanału komunikacyjnego

Evaluate - wyznacza wartość wyrażenia podanego w parametrze funkcji

GetNote - zwraca treść ostatniej aktywnej notatki operatorskiej ze wskazanego segmentu

HasPrivilege - sprawdza w systemie uprawnień aplikacji, czy aktualny użytkownik posiada podane uprawnienie

HasRole - sprawdza w systemie uprawnień aplikacji, czy aktualny użytkownik pełni daną rolę

InRange – określa, czy sprawdzana wartość liczbowa lub czas tstVal mieści się w zadanym zakresie <min, max>

InSet – określa, czy sprawdzana wartość tstVal należy do zadanego zbioru wartości.

If - zwraca wartość przypisaną do pierwszego warunku, który jest spełniony

IsActiveNote - sprawdza, czy z określonym segmentem skojarzone są jakieś aktywne notatki operatora  

IsBrowser - sprawdza, czy aplikacja jest uruchomiona w oknie przeglądarki

IsLiteBrowserTerminal - sprawdza, czy aplikacja jest uruchomiona w oknie przeglądarki w ograniczonym trybie Lite.

IsRunning - sprawdza, czy aplikacja jest aktualnie w trybie pracy

IsScriptWorking - sprawdza, czy jest uruchomiony skrypt o podanej nazwie

IsWorking - sprawdza, czy jest nawiązane lub można nawiązać połączenie z określoną stacją zdefiniowaną w ustawieniach aplikacji

RoleDescription - zwraca opis podanej roli systemu zabezpieczeń

Slide - symulacja płynnej zmiany wartości pomiarowej

StationDiagInfo - zwraca informacje diagnostyczne dla wskazanego stanowiska zgromadzone na serwerze diagnostyki

StationInfo - zwraca informacje dotyczące aktualnego stanowiska aplikacji

Switch - zwraca wartość przypisaną do pierwszej wartości porównywanej równej wartości sprawdzanej

ToFullPath - zwraca bezwzględną ścieżkę do pliku dla ścieżki podanej względem katalogu aplikacji

ToTable - zwraca tablicę wartości przekazanych jako kolejne argumenty

 



Abs

 

 

Przeznaczenie

Funkcja zwraca wartość bezwzględną liczby.

Składnia

Abs(wartość)

Parametry

                wartość

Argument funkcji

 

Acos

 

 

Przeznaczenie

Funkcja wylicza wartość funkcji arcus cosinus. Zwraca kąt mierzony w radianach z zakresu 0≤θ≤π, którego cosinus wynosi wartość podaną w argumencie funkcji.

Składnia

Acos(wartość)

Parametry

                wartość

Argument funkcji

 

AbsToRelX

 

Przeznaczenie

Funkcja konwertuje współrzędną poziomą lub szerokość z wartości bezwzględnej (0 do 1 000 000) na wartość względną w pikselach. Wartości bezwzględne są przechowywane w definicjach współrzędnych. Przejście na wartości względne wykonywane jest w trakcie wyświetlania obiektu i jest dostosowywane do aktualnych rozmiarów diagramu. Współrzędna bezwzględna 1 000 000 odpowiada prawej krawędzi diagramu. Funkcja używana jest w przypadku implementacji ruchu lub zmiany rozmiaru obiektów.

Składnia

 AbsToRelX(współrzędna_X)

Parametry

               współrzędna_X

Współrzędna X lub szerokość obiektu w jednostkach bezwzględnych, którą należy przeliczyć na  wartość względną.

Zobacz też

Techniki budowy diagramów > 13.Animacja ruchu i zmiana rozmiaru obiektów

funkcje: AbsToRelY, RelToAbsX, RelToAbsY

 


AbsToRelY

 

Przeznaczenie

Funkcja konwertuje współrzędną pionową lub wysokość z wartości bezwzględnej (0 do 1 000 000) na wartość względną w pikselach. Ogólne zasady użycia są takie same jak w przypadku funkcji AbsToRelX.

Składnia

 AbsToRelY(współrzędna_Y)

Parametry

               współrzędna_Y

Współrzędna Y lub wysokość obiektu w jednostkach bezwzględnych, którą należy przeliczyć na  wartość względną.

Zobacz też

Techniki budowy diagramów > 13.Animacja ruchu i zmiana rozmiaru obiektów

funkcje: AbsToRelX, RelToAbsX, \RelToAbsY

 

AlarmsControler

 

Przeznaczenie

Funkcja zwraca nazwę aktywnego kontrolera w wybranej domenie alarmów. W przypadku terminali podpiętych za pośrednictwem pomostu zwracana jest nazwa użytego pomostu.

Składnia

AlarmsControler ()

AlarmsControler (nazwa_domeny)

Parametry

nazwa_domeny

Nazwa domeny, której dotyczy wywołanie funkcji.  W przypadku wariantu funkcji bez podania nazwy domeny,  używana jest  domena domyślna (pierwsza zdefiniowana). 

Zobacz też

Funkcja AlarmsMode

 

 


AlarmsCount

 

 

Przeznaczenie

Funkcja zwraca ilość alarmów w wybranej grupie alarmów lub w całej domenie. W zależności od sposobu wywołania, można uzyskać ilość alarmów aktywnych, niepotwierdzonych lub aktywnych niepotwierdzonych.

Składnia

AlarmsCount (nazwa_domeny, selektor_grupy, rodzaj_alarmów)

AlarmsCount (selektor_grupy, rodzaj_alarmów)

AlarmsCount (nazwa_domeny, selektor_grupy, rodzaj_alarmów, priorytety)

 

Parametry

nazwa_domeny

Nazwa domeny, której dotyczy wywołanie funkcji.  W przypadku wariantu funkcji bez podania nazwy domeny  używana jest  domena domyślna (pierwsza zdefiniowana).

selektor_grupy

Parametr określa podzbiór alarmów, którego stan ma zostać zwrócony. Definicja parametru ma postać tekstu złożonego z par <identyfikator_atrybutu_grupującego>=<wartość_atrybutu>  rozdzielonych znakami średnika. Użycie pustego parametru wywołania oznacza zwrócenie ilości alarmów dla  całej domeny.

rodzaj_alarmów

Parametr określa typ alarmów, które mają zostać policzone. Parametr musi być jedną z poniższych stałych:

$Active - liczone są alarmy aktywne (niezakończone), niezależnie od ich stanu potwierdzenia.

$ActiveUnaccepted - liczone są alarmy aktywne (niezakończone), które nie zostały jeszcze potwierdzone przez operatora.

$Unaccepted - liczone są alarmy, które nie zostały jeszcze potwierdzone przez operatora.

priorytety

Filtr priorytetów alarmów (wymienionych po przecinkach) np. ”Alert,Urgent,Critical”

Zobacz też

Funkcja AlarmsGroupState

 

 

AlarmsGroupState

 

Przeznaczenie

Funkcja zwraca zbiorczy stan wybranego zbioru alarmów lub całej domeny. Funkcja pozwala określić, czy w kontrolowanym zbiorze alarmów znajdują się alarmy aktywne (niezakończone) oraz alarmy niepotwierdzone. Interpretację zwracanej wartości opisuje poniższa tabelka.

 

Bit 2

Istnieje alarm aktywny niepotwierdzony

Bit 1

Istnieje alarm niezakończony

Bit 0

Istnieje alarm niepotwierdzony

Wartość liczbowa

Interpretacja

0

0

0

0

Brak alarmów w logu alarmów aktywnych

0

0

1

1

Istnieją tylko alarmy zakończone niepotwierdzone

0

1

0

2

Istnieją tylko alarmy aktywne potwierdzone

0

1

1

3

Mieszanka alarmów zakończonych niepotwierdzonych i aktywnych potwierdzonych

1

1

1

7

Mieszanka alarmów zakończonych niepotwierdzonych, aktywnych potwierdzonych i aktywnych niepotwierdzonych

 

W zależność od potrzeb zwracany wynik można testować pod kątem ustawionych bitów lub wartości liczbowych.

Należy pamiętać, że wartość funkcji wyliczana jest na podstawie logu alarmów aktywnych. Oznacza to, że obsługa alarmów zakończonych jest zależna od konfiguracji logu. Jeżeli alarmy zakończone są natychmiast usuwane z logu alarmów aktywnych, to funkcja nigdy nie zwróci stanu oznaczającego, że są niepotwierdzone alarmy zakończone. Analogicznie, jeżeli alarmy zakończone są usuwane po zadanym czasie, to informacja o ich niepotwierdzeniu zostanie utracona.

Składnia

AlarmsGroupState (selektor_grupy)

AlarmsGroupState (nazwa_domeny, selektor_grupy)

AlarmsGroupState (nazwa_domeny, selektor_grupy, priorytety)

Parametry

selektor_grupy

Parametr określa podzbiór alarmów, którego stan ma zostać zwrócony. Definicja parametru ma postać tekstu złożonego z par <identyfikator_atrybutu_grupującego>=<wartość_atrybutu>  rozdzielonych znakami średnika. Użycie pustego parametru wywołania oznacza zwrócenie stanu całej domeny alarmów.

nazwa_domeny

Nazwa domeny, której dotyczy wywołanie funkcji.  W przypadku wariantu funkcji bez podania nazwy domeny  używana jest  domena domyślna (pierwsza zdefiniowana).

priorytety

Filtr priorytetów alarmów (wymienionych po przecinkach) np. ”Alert,Urgent,Critical”.

Przykład

                =AlarmsGroupState("Strefa=B1;Strefa=B2;Typ=Elektryczna")&4

Funkcja AlarmsGroupState zwraca zbiorczy stan dla alarmów, których atrybut grupujący Strefa  jest równy B1 lub B2 i atrybut Typ jest równy Elektryczna. Całe wyrażenie natomiast zwraca wartość true, gdy w zbiorze kontrolowanych alarmów jest przynajmniej jeden alarm aktywny i niepotwierdzony.

Zobacz też

Funkcja IsAarm, IsAlarmUnaccepted, AlarmsCount

 

 


AlarmsMode

 

Przeznaczenie

Funkcja zwraca tryb pracy stanowiska w ramach wybranej domeny alarmów. Funkcja może  zwrócić poniższe wartości:

1.                  - stanowisko nie bierze udziału w pracy domeny

2.                  - stanowisko jest kontrolerem aktywnym

3.                  - stanowisko jest kontrolerem pasywnym

4.                  - stanowisko jest terminalem lub pomostem

5.                  - stan stanowiska jest nieustalony, występuje w trakcie startu domeny oraz poszukiwania kontrolera aktywnego

Składnia

AlarmsMode ()

AlarmsMode (nazwa_domeny)

Parametry

nazwa_domeny

Nazwa domeny, której dotyczy wywołanie funkcji.  W przypadku wariantu funkcji bez podania nazwy domeny  używana jest  domena domyślna (pierwsza zdefiniowana).

Zobacz też

Funkcja AlarmsControler

 

 

 

Add

 

Przeznaczenie

Funkcja służy do wyliczenia sumy wielu argumentów numerycznych. Efekt jej działania jest identyczny do użycia konstrukcji z wieloma operatorami +, ale w przypadku dużej liczby argumentów funkcja Add jest bardziej efektywna.

W przypadku konieczności połączenia wielu argumentów tekstowych należy stosować funkcję Concat.

Składnia

Add (arg_1, ... ,arg_n)

Parametry

               arg_1, ..., arg_n

Kolejne składniki sumy.

 

 

 

And

 

Przeznaczenie

Funkcja służy do wyliczenia iloczynu logicznego wielu argumentów. Efekt jej działania jest identyczny do użycia konstrukcji z wieloma operatorami &&, ale w przypadku dużej liczby argumentów funkcja And jest bardziej efektywna.

Składnia

And (arg_1, ... ,arg_n)

Parametry

               arg_1, ..., arg_n

Kolejne argumenty iloczynu logicznego.

Zobacz też

Funkcja Or

 

 

 

 

Angle

 

Przeznaczenie

Funkcja zwraca kąt (0 do 360) odpowiadający położeniu kursora w obrębie bieżącego obiektu względem środka tego obiektu. Kąt 0 to kierunek „wschodni” – na prawo od środka obiektu. Kąt wzrasta zgodnie z ruchem wskazówek zegara.

Funkcja może być użyta we wszelkich scenariuszach sterowania kierunkiem za pomocą myszki, na przykład w obsłudze zdarzeń kliknięcia myszką lub animacji.

Składnia

Angle ()


 

 

 

AppData

 

Przeznaczenie

Funkcja zwraca wartość wskazanej danej aplikacyjnej lub jej elementu składowego. Dana aplikacyjna może być zapisana akcją SetAppData(..) lub przez skrypty. Dane aplikacyjne są dostępne tylko lokalnie w obrębie jednego stanowiska aplikacji. Wartość danej aplikacyjnej może być skalarem (np. pojedyncza liczba), tablicą, tabelą, kolekcją lub innym obiektem złożonym. Funkcja może być wykorzystywana na przykład do wyświetlania wartości wyliczonych przez skrypty lub do przekazywania tabeli danych jako źródła danych obiektu Wykres Danych lub Tabela Danych.

Składnia

 AppData(nazwa_danej)

AppData(nazwa_danej, nazwa_elementu1, nazwa_elementu2, …)

Parametry

                nazwa_danej

Nazwa danej aplikacyjnej

                nazwa_elementuN

Jeżeli dana aplikacyjna jest tablicą, to można pobrać jej element, podając dodatkowo numer elementu tablicy. Jeżeli dana aplikacyjna jest tabelą, to można pobrać jej wskazany element lub tablice wartości dla wskazanej kolumny.

Przykłady

                AppData("WspółczynnikX")

                                Zwraca całą wartość danej aplikacyjnej o nazwie „WspółczynnikX”.

AppData("TablicaSterowan", 5)

Zwraca piąty element danej aplikacyjnej o nazwie „TablicaSterowan”, której wartością jest tablica.

AppData("TabelaOEE", "Zalaczenia", 0)

Zwraca pierwszy element z kolumny „Zalaczenia” danej aplikacyjnej, której wartością jest tabela danych.

 

 

AppDataOrDefault

 

Przeznaczenie

Funkcja sprawdza, czy istnieje dana aplikacyjna o wskazanej nazwie.

Składnia

 AppDataOrDefault(nazwa_danej, nazwa_elementu1, nazwa_elementu2, wartość_domyślna)

Parametry

                nazwa_danej

Nazwa danej aplikacyjnej

                nazwa_elementuN

Jeżeli dana aplikacyjna jest tablicą, to można pobrać jej element, podając dodatkowo numer elementu tablicy. Jeżeli dana aplikacyjna jest tabelą, to można pobrać jej wskazany element lub tablice wartości dla wskazanej kolumny.

wartość_domyślna

                                Wartość domyślna zwracana w przypadku braku danej aplikacyjnej.

 

 

 

ApplicationChanged

 

Przeznaczenie

Funkcja zwraca wartość logiczną, informującą czy aplikacja została zaktualizowana poprzez mechanizm okresowej synchronizacji definicji aplikacji.

Składnia

 ApplicationChanged()

 

 
 

ArchiveData

 

 

Przeznaczenie

Funkcja zwraca tablicę zagregowanych wartości archiwalnych zmiennej ze wskazanego zakresu czasu. Może być wykorzystana na przykład do zasilenia danymi obiektu Wykres Danych lub Tabela Danych.

Składnia

RangeAggregate(nazwa_agregatu, początek, koniec, interwał, okres_odświeżania)

RangeAggregate(nazwa_zmiennej, nazwa_agregatu, początek, koniec, interwał, okres_odświeżania)

Parametry

nazwa_agregatu

Nazwa agregatu, który należy wyliczyć. Dostępne nazwy to: none, start, end, delta, min, max, range, total, average, average0, sumup, sumdown, prevknown, last, stdev, rms, avglk, totallk. Nazwa none oznacza odczyt danych surowych. Opis agregatów znajduje się w dokumentacji modułu archiwizacji Aspad (Patrz: Rodzaje agregatów danych archiwalnych).

początek

Początek horyzontu wyliczanego agregatu. Może być wartością typu data i czas (DateTime) lub tekstem konwertowalnym na datę i czas. Dopuszczalne są formaty systemowe i OPC  (zobacz funkcje ToDateTime i OPCTime).

koniec

Koniec horyzontu wyliczanego agregatu. Może być wartością typu data i czas (DateTime) lub tekstem konwertowalnym na datę i czas. Dopuszczalne są formaty systemowe i OPC  (zobacz funkcje ToDateTime i OPCTime).

interwał

Interwał wyliczanego agregatu. Może być wartością typu zakres czasu (TimeSpan) lub tekstem konwertowalnym na zakres czasu (zobacz funkcję ToTimeSpan).

 

okres_odświeżania

Okres ponawiania odczytu danych archiwalnych. Może być wartością typu zakres czasu (TimeSpan) lub tekstem konwertowalnym na zakres czasu (zobacz funkcję ToTimeSpan).

nazwa_zmiennej

Nazwa zmiennej, której wartości historyczne są pobierane. Można stosować sufiksowe nazwy zmiennych. W przypadku wariantu funkcji bez podania nazwy zmiennej używana jest zmienna wynikająca  z kontekstu użycia.

Przykład

 ArchiveData(S1, "Average", "HOUR-1H", "HOUR", "5m", "5s")

Funkcja zwraca tablicę 12 średnich 5-cio minutowych zmiennej S1 z okresu od początku godziny poprzedniej do początku godziny bieżącej. Wartość funkcji jest przeliczana co 5 sekund.

                ArchiveData("Max", "10.05.2018", "12.05.2018", "1h", "30s")

Funkcja zwraca tablicę 24 maksimów godzinowych z okresu od początku dnia 10.05.2018 do początku dnia 12.05.2018. Wartość funkcji jest przeliczana co 30 sekund.

Zobacz też

- Funkcje RangeAggregate, HorizonAggregate, ToDateTime, OPCTime, ToTimeSpan,

-  Rodzaje agregatów danych archiwalnych

 
 
 

 

AsbaseText

 

Przeznaczenie

Funkcja pozwala zamienić wartość liczbową na jej odpowiednik tekstowy.  Przyporządkowanie liczba – tekst zdefiniowane jest w słowniku utworzonym w aplikacji Asbase. W typowym przypadku wartość liczbowa pobierana jest ze zmiennej należącej do zestawu zmiennych, który jest użyty w akcjach operatorskich rodziny Asbase.

Składnia

AsbaseText (nazwa_słownika, wartość)

Parametry

                nazwa_słownika

Nazwa słownika zdefiniowanego w aplikacji Asbase.

wartość

Wartość liczbową, którą należy zamienić na tekst.

 

 

Asin

 

 

Przeznaczenie

Funkcja wylicza wartość funkcji arcus sinus. Zwraca kąt mierzony w radianach z zakresu -π/2≤θ≤π/2, którego sinus wynosi wartość podaną w argumencie funkcji.

Składnia

Asin(wartość)

Parametry

                wartość

Argument funkcji

 

 


Asix6Attribute

 

Przeznaczenie

Funkcja pobiera z bazy definicji zmiennych wartość tekstową wskazanego atrybutu zmiennej procesowej i konwertuje ją na wartość liczbową. Jeżeli atrybut nie jest liczbą, to jest traktowany jako nazwa zmiennej procesowej i zwracana jest wartość tej zmiennej. Funkcja typowo stosowana w warunkach stanów obiektów, szczególnie w trakcie konwersji aplikacji Asix6.

Składnia

Asix6Attribute (nazwa_atrybutu)

Asix6Attribute (nazwa_zmiennej, nazwa_atrybutu)

Parametry

                nazwa_atrybutu

Nazwa atrybutu, który należy pobrać z bazy definicji zmiennych i przetworzyć zgodnie z opisanym wyżej algorytmem.

nazwa_zmiennej

Nazwa zmiennej, której atrybut jest pobierany. Można stosować sufiksowe nazwy zmiennych. W przypadku wariantu funkcji bez podania nazwy zmiennej, pobierany jest atrybut zmiennej wynikającej  z kontekstu użycia.

Zobacz też

Funkcje Attribute, Asix6Limit

 


Asix6Limit

 

Przeznaczenie

Funkcja zwraca wartość logiczną, której wartość jest rezultatem sprawdzenia warunku przekroczenia limitu wartości zmiennej procesowej zgodnie z algorytmem stosowanym w aplikacjach Asix6. Funkcja jest typowo stosowana w warunkach stanów obiektów. Szczegółowy algorytm wyliczania wyniku funkcji jest następujący:

·         Jeżeli wartość atrybutu jest liczbą, to wartość zmiennej procesowej jest porównywana bezpośrednio z wartością limitu. Funkcja zwraca true, gdy wartość zmiennej jest większa od limitu (dla atrybutów LimitHi i LimitHiHi) lub wartość zmiennej jest mniejsza od limitu (dla atrybutów LimitLo i LimitLoLo).

·         Jeżeli wartość atrybutu jest nazwą zmiennej, to jako próg limitu pobierana jest wartość tej zmiennej. Dalsze działanie jest zgodne z punktem poprzednim.

·         Jeżeli wartość atrybutu ma postać nazwa_zmiennej|maska_bitowa, to pobierana jest wartość zmiennej podanej w atrybucie i sprawdzane jest, czy w tej wartości ustawiony jest przynajmniej jeden z jedynkowych bitów maski bitowej.

·         Jeżeli wartość atrybutu ma postać nazwa_zmiennej&maska_bitowa, to pobierana jest wartość zmiennej podanej w atrybucie i sprawdzane jest, czy w tej wartości ustawione są wszystkie jedynkowe bity maski bitowej.

Składnia

Asix6Limit (nazwa_atrybutu)

Asix6Limit (nazwa_zmiennej, nazwa_atrybutu)

Parametry

                nazwa_atrybutu

Nazwa atrybutu, który należy pobrać z bazy definicji zmiennych i przetworzyć zgodnie z opisanym wyżej algorytmem. Dopuszczalne nazwy atrybutów to: LimitLo, LimitLoLo, LimitHi  i LimitHiHi.

nazwa_zmiennej

Nazwa zmiennej, której atrybut jest pobierany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, pobierany jest atrybut zmiennej wynikającej  z kontekstu użycia.

Zobacz też

Funkcje  Asix6Attribute

 


AsserviceRead

 

Przeznaczenie

Funkcja służy do odczytu wybranego pola wartości licznika programu AsService.

Składnia

AsserviceRead (identyfikator_licznika, nazwa_pola)

Parametry

                Identyfikator_licznika

Identyfikator licznika program AsService, którego dotyczy wywołanie funkcji. Licznik o podanym identyfikatorze musi być zdefiniowany w bazie danych programu AsService.

nazwa_pola

Nazwa pola licznika, którego wartość ma zostać zwrócona przez funkcję. Dozwolone są poniższe nazwy pól:

 

Pola związane z definicją i aktualnym stanem licznika

Name

Tekstowy opis licznika

CounterType

Typ licznika

CounterTypeDesc

Tekstowy opis typu licznika

VarName

Nazwa zmiennej procesowej na podstawie której przeliczana jest wartość licznika

AggrName

Nazwa agregatu używanego do przeliczeń

MainCounter

Flaga True/False określająca, czy licznik jest licznikiem głównym urządzenia

RefreshFreq

Okres przeliczania wartości licznika

StartValue

Początkowa wartość licznika

Value

Aktualna wartość licznika

StartTime        

Czas początku zliczania

NoValueTime

Okres czasu braku odczytu poprawnych wartości zmiennej źródłowej

LastReadTime

Czas ostatniego przeliczenia licznika

NextReadTime

Czas planowanego następnego przeliczenia licznika

OperatingLevel

Wartość limitu eksploatacyjnego

CyclicOperatingLevel

Flaga True/False określająca czy wartość limitu eksploatacyjnego jest odtwarzana po każdym resecie

WarningLevel

Wartość limitu ostrzegawczego

WarningLevel2

Wartość drugiego limitu ostrzegawczego

AutoResetReason

Przyczyna automatycznego resetu licznika

AutoResetReasonDesc

Tekstowy opis przyczyny automatycznego resetu licznika

OperatingTask

Czynność eksploatacyjna związana z przekroczeniem limitu licznika

OperatingTaskDesc

Tekstowy opis czynności eksploatacyjnej

Pola związane z definicją urządzenia, do którego licznik należy

DeviceId

Identyfikator urządzenia

DeviceName

Nazwa urządzenia

DeviceDesc

Tekstowy opis urządzenia

DeviceSymbol

Alfanumeryczny symbol urządzenia

DeviceRegistryNum

Numer ewidencyjny urządzenia

DeviceFactoryNum

Numer fabryczny urządzenia

DeviceProdYear

Rok produkcji urządzenia

DevicePurchaseDate

Data zakupu urządzenia

DevicePowerInst

 

DeviceDimensions

Rozmiary urządzenia

DeviceMass

Masa całkowita urządzenia

DeviceVirtual

Flaga True/False określająca czy urządzenie jest wirtualne

DeviceMachine

Nazwa maszyny, do której urządzenie należy

DeviceMachineDesc

Opis tekstowy maszyny

DeviceDepartment

Nazwa wydziału, do którego urządzenie należy

DeviceDepartmentDesc

Opis tekstowy wydziału

DeviceProducer

Producent urządzenia

DeviceProducerDesc

Opis tekstowy producenta

DeviceSupplier

Dostawca urządzenia

DeviceSupplierDesc

Opis tekstowy dostawcy

DeviceLine

Nazwa linii, do której urządzenie należy

DeviceLineDesc

Opis tekstowy linii

DeviceGroup

Nazwa grupy, do której urządzenie należy

DeviceGroupDesc

Opis tekstowy grupy

DevicePowerInst

Moc zasilania urządzania

DevicePowerType

Typ zasilania urządzenia

DevicePowerTypeDesc

Tekstowy opis typu zasilania

DeviceStatus

Status urządzenia

DeviceStatusDesc

Tekstowy opis statusu

DeviceTechCond

Stan techniczny urządzenia

DeviceTechCondDesc

Tekstowy opis stanu technicznego

Pola opisujące ostatni reset licznika

ArcEndValue

Wartość licznika w momencie resetu

ArcStartValue

Początkowa wartość licznika

ArcStartTime

Moment uruchomienia licznika

ArcEndTime

Moment resetu licznika

ArcNoValueTime

Okres czasu, przez który brakowało odczytu poprawnych danych źródłowych

ArcProtocolNo

Numer protokołu związanego z resetem licznika

ArcExecutedBy

Osoba wykonująca reset

ArcResetReason

Przyczyna resetu licznika

ArcResetReasonDesc

Opis tekstowy przyczyny resetu

 


Atan

 

Przeznaczenie

Funkcja wylicza wartość funkcji arcus tangens. Zwraca kąt mierzony w radianach z zakresu -π/2≤θ≤π/2, którego tangens wynosi wartość podaną w argumencie funkcji.

Składnia

Atan(wartość)

Parametry

                wartość

Argument funkcji

 

 

Atan2

 

Przeznaczenie

Funkcja wylicza wartość funkcji arcus tangens dla ilorazu dwóch liczb traktowanych, jako współrzędne układu kartezjańskiego. Zwraca kąt mierzony w radianach z zakresu -π≤θ≤π. Funkcja pozwala przeliczyć współrzędne kartezjańskie na kąt w układzie polarnym.

Składnia

Atan2(wartośćX, wartośćY)

Parametry

                wartośćX, wartośćY

Współrzędne kartezjańskie punktu.

Przykład

                Atan2(10,20)*(180/PI())

                Przelicza współrzędne 10,20 na kąt wyrażony w stopniach.

 

 

Attribute

 

Przeznaczenie

Funkcja pobiera z bazy definicji zmiennej wartość wskazanego atrybutu zmiennej procesowej.

Składnia

Attribute (nazwa_atrybutu)

Attribute (nazwa_zmiennej, nazwa_atrybutu)

Parametry

                nazwa_atrybutu

                               Nazwa atrybutu, który należy pobrać z bazy definicji zmiennych.

nazwa_zmiennej

Nazwa zmiennej, której atrybut jest pobierany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, pobierany jest atrybut zmiennej wynikającej  z kontekstu użycia.

Przykład

                Attribute(LimitLoLo)

Pobierany jest atrybut LimitLoLo kontekstowej zmiennej procesowej. Jeżeli w wyrażeniu definiującym właściwość obiektu nie jest wymagana żadna dodatkowa funkcjonalność, to powyższe wywołanie można zastąpić skrótową notacją:

@LimitLoLo

Zobacz też

Funkcja ExistsAttribute

 

 

 

AttributeOrDefault

 

Przeznaczenie

Funkcja pobiera z bazy definicji zmiennej wartość wskazanego atrybutu zmiennej procesowej. W przypadku błędu (brak zmiennej lub atrybutu) zwraca wartość domyślną.

Składnia

AttributeOrDefault (nazwa_atrybutu, wartość_domyślna)

AttributeOrDefault (nazwa_zmiennej, nazwa_atrybutu, wartość_domyślna)

Parametry

                nazwa_atrybutu

                               Nazwa atrybutu, który należy pobrać z bazy definicji zmiennych.

nazwa_zmiennej

Nazwa zmiennej, której atrybut jest pobierany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, pobierany jest atrybut zmiennej wynikającej  z kontekstu użycia.

 wartość_domyślna

                             Wartość zastępcza zwracana w przypadku błędu odczytu atrybutu.

 

 

 


Ceiling

 

 

Przeznaczenie

Funkcja zwraca najmniejszą liczbę całkowitą większą lub równą podanej liczbie.

 

Składnia

Ceiling(argument)

Parametry

                argument

Argument funkcji

Zobacz też

                Funkcje Floor

 

 

 

ChannelState      

 

Przeznaczenie

Funkcja  zwraca status pracy kanału komunikacyjnego. Możliwe są poniższe wartości statusu:

0 - kanał pracuje normalnie

1 - kanał w fazie inicjalizacji (nie pracuje)

2 - błąd komunikacji w kanale fizycznym (kanale Asmena) obsługiwanym za pośrednictwem drajwera Asix6

3 - praca w kanale redundantnym kanału Asmena obsługiwanego za pośrednictwem drajwera Asix6

4 - sterownik PLC, z którym komunikuje się drajwer kanału fizycznego (kanału Asmena) obsługiwanego za pośrednictwem drajwera Asix6, jest w stanie STOP

5 - kanał fizyczny (kanał Asmena) obsługiwany za pośrednictwem drajwera Asix6 jest wyłączony z działania

6 - kanał pracuje na drajwerze redundantnym

30 - inny błąd kanału

31 - niepoprawna nazwa kanału w wywołaniu funkcji

32- stan kanału nie został jeszcze określony

W przypadku użycia kanału Asmena w ramach serwera danych (drajwer Asix6), do określenia jego stanu można również wykorzystać funkcję przeliczającą Asmena STATUS_KANALU.  

Składnia

ChannelState(nazwa_kanału)

Parametry

                nazwa_kanału

                              Nazwa kanału komunikacyjnego, którego status należy zwrócić.

 

 

CheckOPCStatus

 

 

Przeznaczenie

Funkcja służy do testowania wartości statusu OPC. Funkcja zwraca wartość logiczną informującą o tym, czy status spełnia podany warunek. Rodzaj testu jest definiowany przez podanie w parametrze wywołania jednej ze stałych rodziny $Opc....

Alternatywą dla funkcji CheckOPCStatus są bezpośrednie testy bitowe na wartości statusu. Dla prostych testów poprawności wartości zmiennej procesowej można stosować funkcje VarIsGood i VarIsNotGood.

Składnia

CheckOPCStatus(wartość_statusu, rodzaj_testu)

Parametry

                wartość_statusu

Status Opc, którego wartość należy sprawdzić. Typowo status Opc pozyskiwany jest za pomocą funkcji VarStatus, RegStatus lub LocalPropertyStatus.

                rodzaj_testu

Jedna ze stałych rodziny $Opc..., która określa rodzaj wykonywanego testu wartości statusu. Pełną listę stałych i ich znaczenie można znaleźć w edytorze wyrażeń w menu Stałe.

Przykład

               CheckOpcStatus(LocalPropertyStatus(Text), $OpcQualityGood)

Funkcja sprawdza, czy wartość wyliczona we właściwości Text obiektu jest poprawna.

Zobacz też

Funkcje VarStatus VarIsGood VarIsNotGood LocalPropertyStatus

 


CheckStateMask 

 

Przeznaczenie

Funkcja  zwraca wartość logiczną informującą o tym, czy wartość zmiennej procesowej jest zgodna z podanym stanem. Testowany stan opisany jest wartościami liczbowymi maski i spodziewanej wartości. W pierwszym kroku na wartości testowanej zmiennej wykonywana  jest operacja  iloczynu bitowego z wartością maski. Jeżeli tak uzyskana wartość jest równa wartości spodziewanej, to zwracana jest wartość true.

Funkcja jest typowo stosowana w warunkach stanów obiektów.

Składnia

CheckStateMask(maska_wartości, wartość_stanu)

CheckStateMask (nazwa_zmiennej, maska_wartości, wartość_stanu)

Parametry

                maska_wartości

Maska bitowa, wykonywana jest operacja bitowego iloczynu z wartością zmiennej monitorowanej

                wartość_stanu

                Spodziewana wartość po zastosowaniu maski

nazwa_zmiennej

Nazwa zmiennej, której wartość jest sprawdzana. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, używana jest wartość zmiennej wynikającej  z kontekstu użycia.

Przykład

                CheckStateMask(0xf,3)

Funkcja zwraca true, gdy stan 4 najmłodszych bitów wartości zmiennej kontekstowej jest równy 0011. Pozostałe bity nie mają znaczenia.

                CheckStateMask(z1, 4,0)

Funkcja zwraca true, gdy trzeci najmłodszy bit wartości zmiennej z1  jest równy 0.

CheckStateMask(z1, 4,4)

Funkcja zwraca true, gdy trzeci najmłodszy bit wartości zmiennej z1  jest równy 1. W tym przypadku identycznie zadziała prostsze wyrażenie:

Variable(z1)&4

Zobacz też

Funkcja CheckStateTemplate

 


CheckStateTemplate

 

Przeznaczenie

Funkcja  zwraca wartość logiczną informującą o tym, czy wartość zmiennej procesowej jest zgodna z podanym stanem. Testowany stan opisany jest w postaci tekstowej. Opis stanu składa się z sekwencji znaków:  0 , 1 i - , odpowiadających spodziewanym wartościom bitów zmiennej testowanej. Znak -  oznacza, że wartość odpowiadającego mu bitu nie ma znaczenia.

Składnia

CheckStateTemplate(wzorzec_stanu)

CheckStateMask (nazwa_zmiennej, wzorzec_stanu)

Parametry

                wzorzec_stanu

                Tekstowy opis spodziewanej wartości zmienne testowanej.

nazwa_zmiennej

Nazwa zmiennej, której wartość jest sprawdzana. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej używana jest wartość zmiennej wynikającej  z kontekstu użycia.

Przykład

                CheckStateTemplate(”0110----”)

Funkcja zwraca true, gdy  stan bitów od 7 do 4 wartości zmiennej kontekstowej jest równy 0110. Pozostałe bity nie mają znaczenia.

CheckStateTemplate(z1,”1--”)

Funkcja zwraca true, gdy trzeci najmłodszy bit wartości zmiennej z1  jest równy 1. W tym przypadku identycznie zadziała prostsze wyrażenie:

Variable(z1)&4

Zobacz też

Funkcja CheckStateMask

 


Color

 

Przeznaczenie

Funkcja tworzy wartość koloru na podstawie podanych barw podstawowych RGB. Jest to alternatywa do bezpośredniego podania koloru przez jego nazwę.

Składnia

Color (r, g ,b)

               

Parametry

                r

Czerwona składowa koloru, liczba  z zakresu 0 - 255

                g

Zielona składowa koloru, liczba  z zakresu 0 - 255

                b

Niebieska składowa kolor, liczba z zakresu 0 - 255

Przykład

                Color( Variable(zR), Variable(zG), Variable(zB) )

                Funkcja wylicza kolor na podstawie wartości trzech zmiennych procesowych.

Zobacz też

                Funkcja XorColor

 


Concat

 

Przeznaczenie

Funkcja pozwala na utworzenie napisu poprzez złączenie dowolnej  liczby napisów składowych. Podobną funkcjonalność można uzyskać przy pomocy operatora +, ale w przypadku wielokrotnego łączenia funkcja Concat jest bardziej efektywna. Inną alternatywą jest użycie funkcji Format.

Składnia

Concat (napis_1, ... , napis_n)

Parametry

               napis_1, ..., napis_n

Kolejne napisy składowe, które zostaną złączone w napis wynikowy.

Przykład

                Concat( VarTime() ,” ”, Variable(), ” ”, (VarIsGood()?OK,Błąd))

Funkcja łączy w pojedynczy napis stempel czasu, wartość i opis statusu kontekstowej zmiennej procesowej. Alternatywne implementacja pokazano poniżej:

                VarTime()  + ” ” +  Variable() + ” ” + (VarIsGood()?OK,Błąd)

                Format(”r;{0} {1} {2}”, VarTime(), Variable(), (VarIsGood()?OK,Błąd))

Zobacz też

Funkcja Format

 


ContainsString

 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy w podanym łańcuchu tekstowym występuje określony ciąg znaków.

Składnia

ContainsString(napis_wejściowy, napis_wyszukiwany)

Parametry

                napis_wejściowy

Napis, w którym wyszukiwany będzie ciąg znaków.

                napis_wyszukiwany

Wyszukiwany ciąg znaków.

 

 

 

Cos

 

Przeznaczenie

Funkcja wylicza wartość funkcji cosinus.

Składnia

Cos (kąt)

Parametry

                kąt

Argument funkcji cosinus wyrażony w radianach

Zobacz też

                Funkcje Sin, Tan, Pi

 

 

 

 

CurrentGisLatitude

 

Przeznaczenie

Funkcja zwraca aktualną szerokość geograficzną środka wskazanego (lub kontekstowego) diagramu GIS.

Składnia

CurrentGisLatitude()

CurrentGisLatitude(nazwa_okna, nazwa_panela)

Parametry

nazwa_okna

Nazwa okna, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do okna kontekstowego.

nazwa_panela

Nazwa panela, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do panela kontekstowego.

 

 

 

CurrentGisLongitude

 

Przeznaczenie

Funkcja zwraca aktualną długość geograficzną środka wskazanego (lub kontekstowego) diagramu GIS.

Składnia

CurrentGisLongitude()

CurrentGisLongitude(nazwa_okna, nazwa_panela)

Parametry

nazwa_okna

Nazwa okna, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do okna kontekstowego.

nazwa_panela

Nazwa panela, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do panela kontekstowego.

 

 

 

CurrentGisZoom

 

Przeznaczenie

Funkcja zwraca bieżącą skalę (powiększenie) wskazanego (lub kontekstowego) diagramu GIS.

Składnia

IsGisLayerVisible()

IsGisLayerVisible(nazwa_okna, nazwa_panela)

Parametry

nazwa_okna

Nazwa okna, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do okna kontekstowego.

nazwa_panela

Nazwa panela, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do panelu kontekstowego.

 

 

 

 


CursorX

 

Przeznaczenie

Funkcja zwraca aktualną współrzędna X położenia kursora myszki w ramach diagramu. Zwracana jest w wartość bezwzględna z zakresu od 0 do 1000000.

Składnia

CursorX ()

Zobacz też

Funkcja CursorY

 


CursorY

 

Przeznaczenie

Funkcja zwraca aktualną współrzędna Y położenia kursora myszki w ramach diagramu. Zwracana jest w wartość bezwzględna z zakresu od 0 do 1000000.

Składnia

CursorY ()

Zobacz też

Funkcja CursorX

 


DeadBand

 

Przeznaczenie

Funkcja zwraca wartość logiczną, która informuje o przekroczeniu limitu. Sprawdzanie wykonywane jest z histerezą, próg zmiany statusu zależy od kierunku zmiany wartości. Typowo funkcja jest wykorzystywana w strategii warunkowej wykrywania alarmów jako część wyrażenia użytego w parametrach wykrywania.

Składnia

DeadBand (wartość_monitorowana,  limit_włączenia, limit_wyłączenia)

Parametry

               wartość_ monitorowana

                               Wyrażenie, którego prędkość jest testowana na przekroczenie limitów

                limit_włączenia

Limit wartości monitorowanej, powyżej którego następuje zmiana wartości funkcji z false na true

               limit_wyłączenia

Limit wartości monitorowanej, poniżej którego następuje zmiana wartości funkcji z true na false.

Przykład

                DeadBand (Variable(s1), Variable(low), Variable(high))

Wartość zmiennej s1 jest sprawdzana pod kątem przekroczenia limitów z uwzględnieniem histerezy. Wartości progowe są dynamicznie zmienne, zależne od aktualnych wartości zmiennych low i high.

Zobacz też

                - System_alarmów > 5.2. Strategia warunkowa

- funkcje RateOfChange,  DelayedState

 


DelayedState

 

Przeznaczenie

Funkcja zwraca wartość logiczną, która informuje o tym, że w systemie nie zaszły przewidywane zmiany stanu. Funkcja monitoruje stan warunku początkowego. Jeżeli on zajdzie, to sprawdzane jest, czy w zadanym czasie zostanie spełniony warunek końcowy. Jeżeli nie, to wartość funkcji jest równa true. Typowo funkcja jest wykorzystywana w strategii warunkowej wykrywania alarmów jako część wyrażenia użytego w parametrach wykrywania.

Składnia

DelayedState (warunek_startu,  limit_czasu, warunek_zakończenia)

Parametry

                warunek_ startu

Warunek, którego zmiana na true powoduje początek cyklu sprawdzania warunku końcowego.

                limit_czasu

Okres czasu w sekundach, w ciągu którego spodziewanie jest spełnienie warunku końcowego.

                warunek_zakończenia

Warunek logiczny, który powinien zostać spełniony w zadanym czasie.

Przykład

                DelayedState (Variable(st1)==1, 5, Variable(stop)==1)

Od momentu zmiany wartości zmiennej st1 na wartość 1 przez 5 sekund sprawdzane jest, czy wartość zmiennej stop też zmieniła się na 1. Jeżeli nie, to funkcja przyjmie wartość true.

Zobacz też

- System_alarmów > 5.2. Strategia warunkowa               

- funkcje RateOfChange,  DeadBand

 

 

 

Div

 

Przeznaczenie

Funkcja zwraca wynik dzielenia dwóch liczb. Jeżeli wartość dzielnika jest rói)na 0 lub wystąpi inny błąd, to zwracana jest podana wartość domyślna.

Składnia

Div (liczba1,  liczba2, wartość_domyślna)

Parametry

                liczba1, liczba2

Argumenty operacji dzielenia.

                Wartość_domyślna

Warunek logiczny, który powinien zostać spełniony w zadanym czasie.

Przykład

                Div (Variable(v1), Variable(v2),”błąd”)

Funkcja zwraca iloraz wartości zmiennych o nazwach v1 i v2. W przypadku wystąpienia błędu dzielenia zwracany jest tekst błąd.

 

 

 

E

 

Przeznaczenie

Zwraca wartość liczby e.

Składnia

E ()

Zobacz też

                Funkcja Log  

 

 

 

Evaluate

 

Przeznaczenie

Funkcja wylicza wartość wyrażenia (ewaluatora) podanego w parametrze funkcji. Parametr jest tekstem, w którym należy stosować składnię definicji właściwości. Funkcja jest używana wtedy, gdy nie jest z góry znana treść wyliczanego wyrażenia, np. wyrażenie jest odczytywane z atrybutów zmiennej procesowej.

Składnia

Evaluate (wyrażenie)

Parametry

                wyrażenie

Treść obliczanego wyrażenia

 

Przykład

                Evaluate( Attribute(a1))

Z atrybutu a1 zmiennej kontekstowej pobierana jest treść ewaluatora, który zostanie następnie wyliczony. Poniższe przykłady pokazują efekt obliczenia w zależności od definicji atrybutu:

#_s1                      wartość zmiennej o nazwie zmiennej kontekstowej z sufiksem s1

@Name               nazwa zmiennej głównej

!g1                         wartość właściwości globalnej g1

=7+4                     11

7+4                        tekst 7+4

 

 

 

 

EventContext

 

Przeznaczenie

Funkcja zwraca wskazaną informacje dotyczącą kontekstu zdarzenia, której można użyć w argumentach akcji operatorskiej.

Składnia

EventContext (dana)

Parametry

                dana

Nazwa danej. Nazwy dostępnych danych dla określonych zdarzeń obiektów są wymienione w opisach obiektów i ich zdarzeń.

 

Przykład

OpenDiagram ("SeriesDetails”,"index=”+EventContext("SeriesIndex"), null, $Dialog, $CursorLocation,  $CursorLocation, "”, $None )

W powyższym przykładzie Funkcja EventContext została użyta w akcji OpenDiagram wywołanej w zdarzeniu kliknięcia na serię obiektu Wykres danych. Pozwala ona przekazać jako parametr wywołania diagramu numer serii, którą kliknął użytkownik i dzięki temu otworzyć diagram ze szczegółami dotyczącymi konkretnej serii danych.

 

 

ExistAppData

 

Przeznaczenie

Funkcja sprawdza, czy istnieje dana aplikacyjna o wskazanej nazwie.

Składnia

ExistAppData(nazwa_danej)

Parametry

                nazwa_danej

Nazwa danej aplikacyjnej.

 

 

ExistsAttribute

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą czy w bazie definicji zmiennych aplikacji używany jest  atrybut o podanej nazwie.

Składnia

ExistsAttribute (nazwa_atrybutu)

Parametry

                nazwa_atrybutu

                               Nazwa atrybutu, którego obecność w bazie definicji zmiennych jest sprawdzana.

Zobacz też

Funkcja Attribute

 


 

ExistsVariable

 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy w bazie definicji zmiennych aplikacji zdefiniowana jest zmienna o podanej nazwie.

Składnia

ExistsVariable (nazwa_zmiennej)

Parametry

                nazwa_zmiennej

Nazwa zmiennej, której obecność w bazie definicji zmiennych jest sprawdzana. Można stosować notację sufiksową nazw zmiennych z użyciem przedrostka #.

 

 

Floor

 

 

Przeznaczenie

Funkcja zwraca największą liczbę całkowitą mniejszą lub równą podanej liczbie.

 

Składnia

Floor (argument)

Parametry

                argument

Argument funkcji

Zobacz też

                Funkcje Ceiling

 


 

Format

 

Przeznaczenie

Funkcja tworzy napis, który powstaje na podstawie napisu formatującego i zestawu argumentów. Argumenty te są konwertowane na tekst zgodnie z instrukcjami zawartymi w napisie formatującym i wstawiane we wskazane miejsca napisu docelowego. Działanie funkcji jest identyczne z działaniem funkcji String.Format platformy .NET. Na witrynie msdn.microsoft.com można znaleźć szczegółowy opis działania funkcji Format łącznie z opisem struktury napisu formatującego. W przykładach użycia pokazano typowe przypadki działania funkcji.

Składnia

                Format(napis_formatujący, argument_0, argument_1, ...)

Parametry

napis_formatujący

Napis formatujący zgodny z formatem platformy .NET. Fragmenty napisu postaci {x:yyy} oznaczają miejsca wstawienia pozostałych argumentów funkcji, gdzie x oznacza numer kolejny argumentu (pierwszy argument ma numer 0), a yyy  określa szczegóły formatowania obiektu.

argument_1, argument_2, ...

Kolejne argumenty wstawiane do napisu wynikowego zgodnie z zasadami podanymi w napisie formatującym.

Przykład

                Format (”{0} {1}”,Variable(),Attribute(Unit))

Tworzy połączenie wartości zmiennej, skonwertowanej na tekst w sposób domyślny wynikający z typu wartości, z opisem jednostki pomiaru pobranym z bazy definicji zmiennych, np. "122 kg”

Format("{0:f4}", Variable())

Konwertuje liczbę zmiennoprzecinkową na tekst z zaokrągleniem do 4 cyfr ułamkowych.

Format("{0:x}", Variable())

Konwertuje liczbę na postać tekstową szesnastkową.

Format("{0:hh:mm:ss}", Variable(DateTime))

Tworzy napis zawierający aktualną godzinę, np. 11:30:00

Format("{0:# ###}", Variable())

Formatuje duże liczby wstawiając znak spacji przed cyfrą setek.

Zobacz też

                Funkcje Concat, VarStringValue

 


FromAsix6Date 

 

Przeznaczenie

Funkcja przelicza datę i czas wyrażoną liczbą sekund, która upłynęła od 1.1.1970 na wartość typu data i czasu (typ DateTime platformy .NET). Funkcja używana głównie przy konwersji aplikacji z Asix6.

Składnia

FromAsix6Date (sekundy)

Parametry

                sekundy

Liczba sekund od 1.1.1970.

Zobacz też

                Funkcje ToDateTime, ToAsix6Date OPCTime

 

 


FromAsix6Time 

 

Przeznaczenie

Funkcja przelicza czas wyrażony liczbą milisekund na wartość typu zakres czasu (typ TimeSpan platformy .NET).

Składnia

FromAsix6Time (milisekundy)

Parametry

               milisekundy

Liczba milisekund.

Zobacz też

                Funkcje ToTimeSpan, ToAsix6Time, OPCTime

 

 

 

 

GetDictionary 

 

Przeznaczenie

Funkcja zwraca definicję słownika wartości pobranego z obiektu klasy Tabela Asbase. Słownik wartości pozwala na przekodowanie wartości liczbowych na ich odpowiedniki tekstowe. Funkcja jest przeznaczona do użycia we właściwości Słownik wartości obiektów klasy Tekst.

Składnia

GetDictionary (nazwa_obiektu, identyfikator_słownika)

Parametry

nazwa_obiektu

Nazwa obiektu klasy Tabela Asbase, z którego zostanie pobrana definicja słownika.

identyfikator_słownika

Identyfikator słownika. W przypadku obiektu Tabela Asbase jest to identyfikator pola kolumny tabeli, która podlega przekształceniu wartość-tekst na podstawie słownika zdefiniowanego w bazie modułu Asbase.

Zobacz też

                Funkcja GetDictionary, Obiekt Text


 

GetDictionaryValue 

 

Przeznaczenie

Funkcja zwraca wartość wyliczoną przy pomocy słownika wartości pobranego z obiektu klasy Tabela Asbase. Słownik wartości pozwala na przekodowanie wartości liczbowych na ich odpowiedniki tekstowe.

Składnia

GetDictionaryValue (nazwa_obiektu, identyfikator_słownika, klucz_słownika)

Parametry

nazwa_obiektu

Nazwa obiektu klasy Tabela Asbase, z którego zostanie pobrana definicja słownika.

identyfikator_słownika

Identyfikator słownika. W przypadku obiektu Tabela Asbase jest to identyfikator pola kolumny tabeli, która podlega przekształceniu wartość-tekst na podstawie słownika zdefiniowanego w bazie modułu Asbase.

klucz_słownika

Wartość klucza. Słownik wartości zostanie przeszukany pod kątem obecności w nim pozycji o podanym kluczu – zostanie zwrócona odpowiadająca mu wartość tekstowa.

Przykład

                GetDictionaryValue(TabRej, SK2_KOD, Variable(V_SK2_KOD))

Funkcja pobiera słownik wartości z obiektu klasy Tabela Asbase z kolumny o identyfikatorze pola SK2_KOD.  Następnie na podstawie wartości zmiennej V_SK2_KOD, ze słownika jest pobierana właściwa wartość tekstowa. Jeżeli zmienna jest częścią zestawu zmiennych podpiętych do tabeli, to uzyskany zostanie efekt synchronicznej zmiany wyświetlanego tekstu zgodnie ze zmianami aktywnego wiersza tabeli.

Podobny efekt można uzyskać przy pomocy funkcji GetDictionary i właściwości Słownik wartości obiektu klasy Tekst.

Zobacz też

                Funkcja GetDictionary

 

 

 

 

GetMessage

 

Przeznaczenie

Funkcja zwraca tekst, kolor tekstu albo tła odpowiadający określonej wartości klucza wskazanego zestawu komunikatów.

Składnia

GetMessage (nazwa_zestawu_komunikatów, wartość_klucza, typ_danej)

Parametry

nazwa_zestawu_komunikatów

Nazwa zdefiniowanego zestawu komunikatów

wartość_klucza

Wartość liczbowa klucza

typ_danej

Stała: $Text – tekst komunikatu, $Color – kolor komunikatu, $BackgroundColor – kolor tła komunikatu

Przykład

                GetMessage (”Zestaw1”, 5, $Text)

Dla zestawu „Zestaw1” funkcja pobiera tekst komunikatu odpowiadający wartości 5.

 

 

 

GetNote

 

Przeznaczenie

Funkcja zwraca treść ostatniej aktywnej notatki operatorskiej ze wskazanego segmentu.

Składnia

GetNote(segment)

Parametry

segment

Nazwa segmentu notatek operatorskich

Przykład

                GetNote(”Naweglanie”)

Zobacz też

                Akcje DeactivateNote, AddNote, ShowNotes, funkcja IsActiveNote

 

 

 

 

 

GetStateDescription 

 

Przeznaczenie

Funkcja zwraca  opis stanu wyrażenia (zmiennej procesowej) w oparciu o informacje znajdujące się w bazie definicji zmiennych.  Algorytm działania funkcji jest następujący:

·         Określana jest nazwa grupy opisującej stany poprzez odczyt wartości atrybutu Nazwy stanów dla zmiennej podanej w wywołaniu funkcji.

·         W bazie definicji zmiennych wyszukiwane są wszystkie zmienne, których atrybut Zestaw stanów, jest identyczny z nazwą grupy określoną w poprzednim punkcie. Typowo są to zmienne nieaktywne służące tylko do definiowania nazw stanów.

·         Wśród zmiennych wybranych w poprzednim punkcie wyszukiwana jest ta, której wartość atrybutu Wartość_stanu jest identyczna z wartością stanu przekazanego do wywołania funkcji GetStateDescription.

·         Wynikiem funkcji jest wartość atrybutu Opis zmiennej wybranej w poprzednim punkcie.

Efekt podobny do działania funkcji GetStateDescription można uzyskać stosując wzorzec bazujący na obiekcie Tekst, w którym zostały zdefiniowane odpowiednie stany.

Składnia

GetStateDescription (nazwa_zmiennej, wartość_stanu)

Parametry

nazwa_zmiennej

Nazwa zmiennej służącej do pozyskania opisów stanów z bazy definicji zmiennych . Można używać notacji sufiksowej. Pusta nazwa oznacza użycie zmiennej kontekstowej.

wartość_stanu

Wartość określająca stan, dla którego należy uzyskać opis. W typowym przypadku jest to wyrażenie wykorzystujące wartość zmiennej przekazanej w parametrze nazwa_zmiennej (nie jest to jednak obowiązkowe).

Przykład

                GetStateDescription (””,Variable())

Funkcja pobiera opisy stanów dla zmiennej kontekstowej,  a następnie określa odpowiedni opis na podstawie wartości zmiennej kontekstowej.

Zobacz też

                Funkcja GetStateText

 

 

 


 

GetStateText

 

Przeznaczenie

Funkcja zwraca tekstowy opis stanu na podstawie dwóch parametrów liczbowych: stanu i podstanu oraz informacji znajdujących się w bazie definicji zmiennych.  Typowym zastosowaniem jest tworzenie opisów dla wartości pojedynczych bitów, gdzie stan to numer bitu, a podstan to aktualna wartość bitu. Algorytm działania funkcji jest następujący:

·         Pobierana jest  wartość atrybutu Nazwy stanów dla zmiennej podanej w wywołaniu funkcji.

·         Jeżeli pobrany atrybut to ciąg postaci 0=stan1;1=stan2;... , to zwracana jest nazwa stanu odpowiadająca wartości równej parametrowi podstanu. Ten wariant zbliżony jest działaniu do funkcji GetStateDescription, ale nie wymaga dodatkowych zmiennych.

·         Jeżeli działanie funkcji nie zostało jeszcze zakończone, to w bazie definicji zmiennych wyszukiwane są wszystkie zmienne, których atrybut Zestaw stanów, jest identyczny z  wartością atrybutu Nazwy stanów pobranego w punkcie pierwszym. Typowo są to zmienne nieaktywne służące tylko do definiowania nazw stanów.

·         Wśród zmiennych wybranych w poprzednim punkcie wyszukiwana jest ta, której wartość atrybutu Wartość_stanu jest identyczna z wartością stanu przekazanego do wywołania funkcji GetStateText.

·         Jeżeli atrybut Nazwy stanów zmiennej wybranej w  poprzednim punkcie stanowi ciąg postaci 0=stan1;1=stan2;...,  to zwracana jest nazwa stanu odpowiadająca wartości równej parametrowi podstanu. W przeciwnym przypadku wartością funkcji jest kompletna wartość atrybutu.

Składnia

GetStateText (nazwa_zmiennej, wartość_stanu, wartość_podstanu)

Parametry

nazwa_zmiennej

Nazwa zmiennej służącej do pozyskania opisów stanów z bazy zmiennych . Można używać notacji sufiksowej. Pusta nazwa oznacza użycie zmiennej kontekstowej.

wartość_stanu

Wartość określająca stan, dla którego należy uzyskać opis w przypadku stosowania Wirtualnych zmiennych definiujących opisy.

wartość_podstanu

Parametr określający wartość podstan, stosowana przy wyciąganiu opisu z teksów w  postaci 0=stan1;1=stan2;... W typowym przypadku jest to wyrażenie wykorzystujące wartość zmiennej przekazanej w parametrze nazwa_zmiennej (nie jest to jednak obowiązkowe).  

Przykład

                GetStateText(z1, 3 , Variable(z1)&8)

Zadaniem funkcji jest uzyskanie opis stanu pojedynczego bitu. Przykładowe dane w bazie definicji zmiennych:

·         Atrybut Nazwy stanów zmiennej z1 jest równy OpisyBitów

·         Nieaktywna zmienna Bit3 ma atrybut  Zestaw stanów równy  OpisyBitów, a atrybut Wartość stanu równy 3.

·         Atrybut Nazwy stanów zmiennej Bit3 ma postać 0=OK;8=Awaria

W zależności od wartości bitu 3 zmiennej z1 zostanie zwrócony opis OK lub Awaria.

Zobacz też

                Funkcja GetStateDescription 

 

 

 

 

HasPrivilege

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy aktualnie zalogowany  użytkownik posiada podane uprawnienie systemowe lub aplikacyjne. W typowym zastosowaniu funkcja jest używana w warunkach stanów obiektu, właściwościach  Aktywny lub Widoczny lub operatorskich akcjach warunkowych Break i Perform. Funkcja jest alternatywą dla zalecanej funkcji HasRole.

Składnia

HasPrivilege (identyfikator_uprawnienia)

Parametry

Identyfikator_uprawnienia

Tekstowy identyfikator uprawnienia systemowego lub aplikacyjnego, którego posiadanie jest sprawdzane. Lista identyfikatorów wszystkich używanych uprawnień dostępna jest w okienku kreatora wyrażeń.

Zobacz też

Parametryzacja_aplikacji > 5. System uprawnień, Funkcja HasRole

 

 

HasRole

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy aktualnie zalogowany  użytkownik pełni podaną rolę. W typowym zastosowaniu funkcja jest używana w warunkach stanów obiektu, właściwościach  Aktywny lub Widoczny lub operatorskich akcjach warunkowych Break i Perform.

Składnia

HasRole (nazwa_roli)

Parametry

nazwa_roli

Nazwa roli, do której przynależność jest sprawdzana. W nazwie roli można stosować znaki specjalne * i ?.

Zobacz też

Parametryzacja_aplikacji > 5. System uprawnień, Funkcja HasPrivilege

 

 


HasWaitingControl

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą  czy obiekt wynikający z kontekstu użycia lub obiekty o zgodnej nazwie znajdują się w stanie oczekiwania na wysłanie sterownia. Funkcja dotyczy obiektów na diagramach synoptycznych, które mogą pracować w trybie opóźnionego sterowania. Funkcja typowo używana w warunku stanu w celu modyfikacji wyglądu obiektu oczekującego na wysłanie sterowania.

Składnia

HasWaitingControl ()

HasWaitingControl (wzorzec_nazwy)

Parametry

wzorzec_nazwy

Wzorzec nazwy obiektów, których stan jest kontrolowany. We wzorcu można stosować znaki specjalne * i ?. Parametr &rdquor;r;*” sprawdza stan wszystkich obiektów diagramu, nawet tych nieposiadających nazwy. Możliwe jest też użycie jednej z poniższych stałych:

$All - test dotyczy wszystkich obiektów umieszczonych na wszystkich otwartych diagramach

$Window - test dotyczy wszystkich obiektów umieszczonych na diagramach bieżącego okna

$Diagram - test dotyczy wszystkich obiektów umieszczonych na bieżącym diagramie

Użycie bezparametrowego wariantu oznacza test stanu obiektu kontekstowego

Zobacz też

- funkcje IsActive, IsSelected

- Akcje > akcje SendControls, CancelControls

 

 

HorizonAggregate

 

Przeznaczenie

Funkcja zwraca wartość agregatu wartości historycznych zmiennej procesowej ze wskazanego horyzontu czasu liczonego względem chwili bieżącej (tzw. agregat kroczący)

Składnia

HorizonAggregate(nazwa_agregatu, horyzont_czasu, okres_odświeżania)

HorizonAggregate(nazwa_zmiennej, nazwa_agregatu, horyzont_czasu, okres_odświeżania)

Parametry

nazwa_agregatu

Nazwa agregatu, który należy wyliczyć. Dostępne nazwy to: none, start, end, delta, min, max, range, total, average, average0, sumup, sumdown, prevknown, last, stdev, rms, avglk, totallk. Nazwa none oznacza odczyt danych surowych.

horyzont_czasu

Okres wyliczanego agregatu. Liczony zawsze względem chwili bieżącej. Może być wartością typu zakres czasu (TimeSpan) lub tekstem konwertowalnym na zakres czasu (zobacz funkcję ToTimeSpan)

okres_odświeżania

Okres ponawiania odczytu danych archiwalnych. Może być wartością typu zakres czasu (TimeSpan) lub tekstem konwertowalnym na zakres czasu (zobacz funkcję ToTimeSpan)

nazwa_zmiennej

Nazwa zmiennej, której wartości historyczne są pobierane. Można stosować sufiksowe nazwy zmiennych. W przypadku wariantu funkcji bez podania nazwy zmiennej, używana jest zmienna wynikająca  z kontekstu użycia.

Przykład

                HorizonAggregate(max,”00:15:00”,”00:00:10)

Funkcja zwraca maksymalną wartość zmiennej kontekstowej z okresu ostatnich 15 minut. Wartość funkcji jest przeliczana co 10 sekund.

Zobacz też         

- Funkcje RangeAggregate, ToTimeSpan

- Rodzaje agregatów danych archiwalnych   

 

 

 

InRange

 

Przeznaczenie

Określa czy sprawdzana wartość liczbowa lub czas tstVal mieści się w zadanym zakresie <min, max>

Składnia

InRange(tstVal, min, max)

Przykład

                =InRange(Variable("Pomiar"), 18, 25)

 

 

 

InSet

 

Przeznaczenie

Określa czy sprawdzana wartość tstVal należy do zadanego zbioru wartości.

Składnia

InSet(tstVal, elements…)

Przykład

                =InSet(Variable("Pomiar"), 2, 3, 6, 7, 9)

 

 

 

If

 

Przeznaczenie

Funkcja zwraca wartość przypisaną do pierwszego warunku, który jest spełniony. W przypadku, gdy żaden warunek nie jest spełniony, to zwraca wartość domyślną (ostatni argument). Zaleca się stosowanie tej funkcji zamiast zagnieżdżonych operatorów warunkowych (‘?’ ‘:’).

Składnia

If(warunek1, wartość1, warunek2, wartość2, …, wartość_domyślna)

Przykład

                =If(Variable("Pomiar") < 20, "Za mało", Variable("Pomiar") > 80, "Za dużo", "W sam raz")

Zobacz też

                Funkcje Switch, ?: 


 

 

IsActive

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy obiekt wynikający z kontekstu użycia jest  aktywny, czyli może wykonywać operacje sterujące (interaktywne). Wynik funkcji jest bezpośrednio związany z wartością właściwości Aktywny obiektu. Funkcja typowo używana w warunku stanu w celu modyfikacji wyglądu obiektu.

Składnia

IsActive ()

Zobacz też

                Funkcje IsSelected, HasWaitingControl

 



 

IsActiveNote

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą czy z określonym segmentem skojarzone są aktualnie jakieś aktywne notatki operatora.

Składnia

IsActiveNote (identyfikator_segmentu)

Parametry

                identyfikator_segmentu

Identyfikator segmentu, dla którego sprawdzana jest obecność aktywnych notatek. Można stosować znaki specjalne * i ?.

 

 

IsAlarm

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy wskazany alarm jest aktualnie aktywny (rozpoczęty i niezakończony).

Składnia

IsAlarm (identyfikator_alarmu)

IsAlarm (nazwa_domeny, identyfikator_alarmu)

 

Parametry

identyfikator_alarmu

Identyfikator alarmu, którego status aktywności ma być zwrócony.

nazwa_domeny

Nazwa domeny , do której należy kontrolowany alarm.  W przypadku wariantu funkcji bez podania nazwy domeny  używana jest  domena domyślna (pierwsza zdefiniowana).

 

Zobacz też

Funkcja IsAlarmUnaccepted, AlarmsGroupState

 


 

 

IsAlarmExcluded 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy wskazany alarm jest aktualnie na liście alarmów wykluczonych z wykrywania.

Składnia

IsAlarmExcluded (identyfikator_alarmu)

IsAlarmExcluded (nazwa_domeny, identyfikator_alarmu)

Parametry

identyfikator_alarmu

Identyfikator alarmu, którego status wykluczenia ma być zwrócony.

nazwa_domeny

Nazwa domeny, do której należy kontrolowany alarm.  W przypadku wariantu funkcji bez podania nazwy domeny używana jest  domena domyślna (pierwsza zdefiniowana).

 

Zobacz też

Akcje > akcje ExcludeAlarm, IncludeAlarm

 


 

IsAlarmUnaccepted 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy wskazany alarm występuje  w logu alarmów aktywnych i nie został jeszcze potwierdzony przez operatora.

Składnia

IsAlarmUnaccepted (identyfikator_alarmu)

IsAlarmUnaccepted (nazwa_domeny, identyfikator_alarmu)

Parametry

identyfikator_alarmu

Identyfikator alarmu, którego status potwierdzenia ma być zwrócony.

nazwa_domeny

Nazwa domeny , do której należy kontrolowany alarm.  W przypadku wariantu funkcji bez podania nazwy domeny  używana jest  domena domyślna (pierwsza zdefiniowana).

Zobacz też

Funkcja IsAlarm, AlarmsGroupState


 

IsAltPressed

 

Przeznaczenie

Funkcja służy do sprawdzenia, czy na klawiaturze jest wciśnięty klawisz Alt. Typowe zastosowania funkcji to uwarunkowanie pewnych działań lub wyglądu diagramu od przyciśnięcia klawisza Alt. Funkcja typowa używana w warunkach stanów obiektu, właściwościach  Aktywny lub Widoczny lub operatorskich akcjach warunkowych Break i Perform.

Składnia

IsAltPressed ()

Przykład

                Perform( IsAltPressed(), SetVariable(z1,1), Nothing())

Zmienna z1  jest sterowana tylko wtedy, gdy w momencie wykonania akcji klawisz Alt jest przyciśnięty.

Zobacz też

Funkcje IsControlPressed, IsShiftPressed

 

 

IsBlinkOff 

 

Przeznaczenie

Funkcja  zwraca cyklicznie wartości true lub false informujące o aktualnej fazie migotania. Funkcja typowa używana w warunkach stanów obiektu lub wyrażeniach warunkowych we właściwościach obiektów. Pozwala to zmieniać  wygląd obiektów w zależności od fazy migotania.

Składnia

IsBlinkOff ()

Przykład

                IsBlinkOff()?Blue:Red

                Wyrażenie zwraca cyklicznie wartości kolorów Blue i Red.

Zobacz też

Techniki_budowy_diagramów > 4.3. Migotanie poprzez zmianę właściwości obiektów

 


 

 

IsBrowser

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy aplikacja jest uruchomiona w oknie przeglądarki www.

Składnia

IsBrowser ()

 



 

IsLiteBrowserTerminal

 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy aplikacja jest uruchomiona w oknie przeglądarki www w ograniczonym trybie Lite.

Składnia

IsLiteBrowserTerminal ()

 

 

 

IsControlPressed

 

Przeznaczenie

Funkcja służy do sprawdzenia, czy na klawiaturze jest wciśnięty klawisz Control. Zastosowania funkcji są identyczne jak w przypadku funkcji IsAltPressed.

Składnia

IsAltPressed ()

Zobacz też

Funkcje IsAltPressed, IsShiftPressed

 


 

 

IsDiagramActive 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy diagram o podanej nazwie (lub diagram kontekstowy) jest aktualnie diagramem aktywnym (bieżącym). Funkcja pozwala na uzyskanie funkcjonalności, którą w aplikacjach Asix6 daje obiekt Prezenter.

Składnia

IsDiagramActive()

IsDiagramActive(wzorzec_nazwy)

Parametry

wzorzec_nazwy

Parametr określa wzorzec nazwy diagramu. Można używać znaków * i ?. Jeżeli nazwa nie jest podana, to funkcja sprawdza aktywność diagramu kontekstowego.

Przykład

                IsDiagramActive(”Stac*”)

Funkcja zwraca true, jeżeli aktywny jest diagram o nazwie rozpoczynającej się od Stac.

Zobacz też

                Funkcja IsDiagramOpened

 

 

 

IsDiagramActivePar 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy diagram o podanej nazwie i zestawie parametrów otwarcia jest aktualnie diagramem aktywnym (bieżącym). Funkcja pozwala na uzyskanie funkcjonalności, którą w aplikacjach Asix6 daje obiekt Prezenter.

Składnia

IsDiagramActivePar(wzorzec_nazwy, parametry)

Parametry

wzorzec_nazwy

Parametr określa wzorzec nazwy diagramu. Można używać znaków * i ?.

parametry

Parametry otwarcia diagramu. Podawane w sposób określony w opisie akcji OpenDiagram.

Przykład

                IsDiagramActivePar(”Hydrant”,”nr=7”)

Funkcja zwraca true, jeżeli aktywny jest diagram o nazwie Hydrant otwarty z parametrem nr równym 7.


 

Zobacz też

                Funkcja IsDiagramOpened, IsDiagramActive

 

 


IsDiagramOpened

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy jest otwarty diagram o podanej nazwie i parametrach otwarcia. Funkcja pozwala na uzyskanie funkcjonalności, którą w aplikacjach Asix6 daje obiekt Prezenter.

Składnia

IsDiagramOpened(wzorzec_nazwy)

IsDiagramOpened(wzorzec_nazwy, parametry_otwarcia)

IsDiagramOpened(wzorzec_nazwy, parametry_otwarcia, ekran)

Parametry

wzorzec_nazwy

Parametr określa wzorzec nazwy diagramu. Można używać znaków * i ?.

                parametry_otwarcia

Parametry otwarcia diagramu, których zgodność jest weryfikowana przez funkcję. Sprawdzana jest zgodność tylko parametrów podanych w wywołaniu. Jeżeli parametry nie są podane, to funkcja sprawdza tylko nazwę diagramu.

ekran

Numer ekranu, na którym sprawdzane jest otwarcie diagramu. Możliwe są poniższe wartości:

-1                                  - ekran jest dowolny (działanie identyczne jak dla wywołania bez podania

numeru ekranu)

 0                                   - ekran na którym znajduje się kursor myszki

większe od  1           - systemowy numer ekranu

Przykład

                IsDiagramOpened(”StacX”,”pokoj=11”)

Funkcja zwraca true, jeżeli otwarty jest diagram o nazwie StacX i parametrach otwarcia identycznych z pokoj=11.

Zobacz też

                Funkcja IsDiagramActive

 

 

 

IsGisLayerVisible

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy wskazana warstwa diagramu GIS jest widoczna.

Składnia

IsGisLayerVisible(nazwa_okna, nazwa_panelu, nazwa_warstwy)

Parametry

nazwa_okna

Nazwa okna, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do okna kontekstowego.

nazwa_panelu

Nazwa panelu, w którym otwarty jest diagram GIS, którego dotyczy wywołanie funkcji. Pusta nazwa oznacza odwołania do panelu kontekstowego.

nazwa_warstwy

Nazwa warstwy diagramu GIS, którego dotyczy wywołanie funkcji.

 

 

 

 


 

IsMouseOver

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy kursor myszki znajduje się nad obiektem. Można sprawdzać pozycję nad obiektem kontekstowym lub wskazanym przez nazwę. Funkcja typowo używana w warunkach stanów obiektu w celu zmiany wyglądu obiektu po najechaniu na niego kursorem myszki.

Funkcja wymaga, żeby sprawdzany obiekt miał właściwość Aktywny  ustawioną na true.

Składnia

IsMouseOver (wzorzec_nazwy)

IsMouseOver ()

Parametry

wzorzec_nazwy

Parametr określa wzorzec nazwy obiektów, dla których sprawdzany jest warunek najechania kursorem myszki. We wzorcu można znaki specjalne * i ?. Jako pierwszy znak można też podać prefiks !.

Algorytm określania obiektów podlegających kontroli najechania kursorem myszki jest następujący:

- brak parametru oznacza sprawdzanie wyłącznie obiektu kontekstowego.

- podanie tylko znaku ! oznacza sprawdzenie dla wszystkich obiektów (także tych bez nazwy) będących częścią wzorca, do którego należy obiekt kontekstowy.

- dodanie prefiksu ! przed wzorcem nazwy oznacza sprawdzanie obiektów bezpośrednio osadzonych w diagramie kontekstowym.

- brak prefiksu ! przed wzorcem nazwy oznacza sprawdzenia tylko obiektów będących częścią wzorca, do którego należy obiekt kontekstowy lub obiektów bezpośrednio osadzonych w diagramie, gdy obiekt kontekstowy nie jest częścią wzorca.

Zobacz też

- Techniki_budowy_diagramów > 7.1. Nawigacja poprzez tekstowe łącza

- Funkcje IsMousePressed

 


 

IsMousePressed

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy dowolny klawisz myszki jest wciśnięty, a kursor myszki znajduje się nad obiektem wynikającym z kontekstu użycia.

Funkcja wymaga, żeby sprawdzany obiekt miał właściwość Aktywny  ustawioną na true.

Składnia

IsMousePressed ()

Zobacz też

- - Techniki_budowy_diagramów > 7.1. Nawigacja poprzez tekstowe łącza

- Funkcje IsMouseOver

               


 

IsRunning

 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy aplikacja jest aktualnie w trybie pracy. Funkcja pozwala np. na zmianę wyglądu obiektów po przejściu do trybu edycji.

Składnia

IsRunning ()

 

 

 

IsSelected

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy obiekt wynikający z kontekstu użycia jest aktualnie wybrany (jest obiektem bieżącym diagramu). Funkcja typowo używana w warunku stanu w celu modyfikacji wyglądu wyselekcjonowanego obiektu.

Składnia

IsSelected ()

Zobacz też

                Funkcje IsActive, HasWaitingControl

 


 

IsShiftPressed 

 

Przeznaczenie

Funkcja służy do sprawdzenia, czy na klawiaturze jest wciśnięty klawisz Shift. Zastosowania funkcji są identyczne jak w przypadku funkcji IsAltPressed.

Składnia

IsAltPressed ()

Zobacz też

Funkcje IsControlPressed, IsAltPressed

 


 

IsScriptWorking 

 

Przeznaczenie

Funkcja służy do sprawdzenia czy jest aktualnie uruchomiony skrypt o podanej nazwie i liście parametrów startowych.

Składnia

IsScriptWorking (nazwa_skryptu))

IsScriptWorking (nazwa_skryptu, parametr_1, ... , parametr_n)

Parametry

nazwa_skryptu

Nazwa skryptu, którego status pracy jest zwracany.

parametr_1, ... , parametr_n

Opcjonalna lista parametrów uruchomienia skryptu.

 


IsWindowOpened

 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy jest otwarte okno o podanej nazwie. Funkcja pozwala na uzyskanie funkcjonalności, którą w aplikacjach Asix6 daje obiekt Prezenter.

Składnia

IsWindowOpened(wzorzec_nazwy)

IsWindowOpened(wzorzec_nazwy, ekran)

Parametry

wzorzec_nazwy

Parametr określa wzorzec nazwy okna. Można używać znaków * i ?.

ekran

Numer ekranu, na którym sprawdzane jest otwarcie okna. Możliwe są poniższe wartości:

-1                                                  - ekran jest dowolny (działanie identyczne jak dla jednoargumentowej

wersji wywołania)

0                                                    - ekran na którym znajduje się kursor myszki

większe od  1                           - systemowy numer ekranu

Zobacz też

                Funkcja IsDiagramOpened

 

 

 

IsWorking 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy jest nawiązane lub można nawiązać połączenie z określoną stacją zdefiniowaną w ustawieniach aplikacji. Wartość funkcji jest odświeżana cyklicznie.

Składnia

IsWorking(nazwa_stanowiska)

Parametry

                nazwa_stanowiska

Nazwa testowanego stanowiska. Nazwa musi być zdefiniowana w ustawieniach aplikacji.

 


 

LastKeyPressed

 

Przeznaczenie

Funkcja zwraca tekstowy opis ostatnio przyciśniętego klawisza na klawiaturze. Postać opisu jest zgodna z opisami stosowanymi w definicji skrótów klawiszowych. Funkcja jest przeznaczona do użycia w obsłudze zdarzenia Wciśnięcie klawisza obiektów. Pozwala uzależnić działanie od rodzaju przyciśniętego  klawisza.

Składnia

LastKeyPressed ()

Przykład

Perform ( LastKeyPressed()==”Alt+G”, SetVariable ( v1, 1), Nothing())

Zmienna v1 jest ustawiana na 1, jeżeli zostały przyciśnięte klawisze Alt i g. Funkcja powinna być użyta w obsłudze zdarzenia Wciśnięcie klawisza.

Zobacz też

Elementy_wizualizacji > Standardowe zdarzenia obiektów

 

 

Log

 

Przeznaczenie

Funkcja wylicza wartość logarytmu naturalnego.

Składnia

Log (argument)

Parametry

               argument

Argument funkcji logarytmu naturalnego

Zobacz też

                Funkcje E, Log10


 

 

LocalProperty

 

Przeznaczenie

Funkcja  zwraca wartość właściwości lokalnej obiektu diagramu. Można pobrać właściwość obiektu kontekstowego lub dowolnego innego wskazanego nazwą.

Składnia

LocalProperty (nazwa_właściwości)

LocalProperty (nazwa_obiektu, nazwa_właściwości)

Parametry

                nazwa_właściwości

                               Nazwa właściwości lokalnej, którą należy pobrać.

                nazwa_obiektu

Nazwa obiektu, którego właściwość lokalną należy pobrać. W przypadku wariantu funkcji bez podania nazwy obiektu, pobierana jest wartość właściwości obiektu wynikającego z kontekstu użycia. Jeżeli funkcja użyta jest w obiekcie znajdującym się w osadzonym wzorcu, to obiekt o danej nazwie najpierw jest szukany w tym samym wzorcu. Dopiero gdy takiego nie ma, to obiekt szukany jest na diagramie, ale z pominięciem obiektów wchodzących w skład innych wzorców.

 Przykład

                LocalProperty(o2,"Color")

Pobierana jest definicja właściwości lokalnej Color z obiektu o nazwie o2.

Zobacz też

                Funkcje Property

 

 

 

 

LocalPropertyStatus

 

 

Przeznaczenie

Funkcja  zwraca wartość statusu dla właściwości lokalnej obiektu diagramu. Można pobrać status właściwości obiektu kontekstowego lub dowolnego innego wskazanego nazwą.

Z wartością każdej właściwości obiektu związany jest jej status Opc. Status ten w większości przypadków jest stale ustawiony na QualityGood. Jeżeli jednak definicja właściwości odwołuje się do jakiegoś elementu aplikacji, który status posiada, to ten status jest zwracany. Typowe przypadki to:

a) Odwołania do wartości zmiennych poprzez prefiksy & i # lub samodzielne (nie w złożonych wyrażeniach) wywołania funkcji Variable lub VarStringValue.

b) Status wyliczenia agregatów historycznych funkcjami  HorizonAggregate lub RangeAggregate (dla samodzielnych wywołań).

c) Odwołania do wartości liczników programu AsService funkcją AsserviceRead.

W przypadku łączenia przy pomocy operatorów odwołań do elementów aplikacji posiadających status, to stosowana jest zasada, że status jest równy QualityGood wtedy, gdy wszystkie elementy wyrażenia posiadają status QualityGood.

Składnia

LocalPropertyStatus (nazwa_właściwości)

LocalPropertyStatus (nazwa_obiektu, nazwa_właściwości)

Parametry

                nazwa_właściwości

                               Nazwa właściwości lokalnej, której status należy pobrać.

                nazwa_obiektu

Nazwa obiektu, dla którego status właściwości lokalnej należy pobrać. W przypadku wariantu funkcji bez podania nazwy obiektu, pobierany jest status właściwości obiektu wynikającego  z kontekstu użycia. Jeżeli funkcja użyta jest w obiekcie znajdującym się w osadzonym wzorcu, to obiekt o danej nazwie najpierw jest szukany w tym samym wzorcu. Dopiero gdy takiego nie ma, to obiekt szukany jest na diagramie, ale z pominięciem obiektów wchodzących w skład innych wzorców.

 Przykład

                LocalPropertyStatus(o2,"Text")

Pobierany jest status właściwości lokalnej Text z obiektu o nazwie o2. W przypadku gdyby właściwość Text była obliczana np. wyrażeniem =HorizonAggregate(max,”00:15:00”,”00:00:10”) , to pobrany byłby status wyliczenia agregatu historycznego zmiennej procesowej.

Zobacz też

                Funkcja CheckOPCStatus

 

 

 

Log10

 

Przeznaczenie

Funkcja wylicza wartość logarytmu dziesiętnego.

Składnia

Log 10(argument)

Parametry

                argument

Argument funkcji logarytmu dziesiętnego

Zobacz też

                Funkcje Log

 


 

Max

 

Przeznaczenie

Funkcja zwraca większą z dwóch podanych wartości.

 

Składnia

Max (wartość_1, wartość_2)

Parametry

                wartość_1

Pierwsza z porównywanych wartości.

                wartość_2

Druga z porównywanych wartości.

Zobacz też

                Funkcja Min

 

 

 

MeasurementStatus 

Przeznaczenie

Funkcja zwraca status pomiarowy (True/False) zmiennej w oparciu o wartość zmiennej kontrolnej, której nazwa jest zdefiniowana w atrybucie ControlVariable oraz maski zdefiniowanej liczbowo szesnastkowo w atrybucie ControlVariableMask.

 

Składnia

MeasurementStatus()

MeasurementStatus(nazwa_zmiennej)

 

Parametry

                nazwa_zmiennej

Nazwa zmiennej procesowej.

                

 

 

Min

 

Przeznaczenie

Funkcja zwraca najmniejszą z dwóch podanych wartości.

 

Składnia

Max (wartość_1, wartość_2)

Parametry

                wartość_1

Pierwsza z porównywanych wartości.

                wartość_2

Druga z porównywanych wartości.

Zobacz też

                Funkcja Max

 

 

 

NewValue

 

Przeznaczenie

Funkcja zwraca wartość sterującą zmiennej procesowej, która została przekazana do wysłania w efekcie działań operatora lub skryptów użytkownika. Funkcja używana  jest tylko w trakcie wykonywania operacji sterującej w wyrażeniach atrybutu Funkcja przeliczająca zapisu. Wynik obliczenia takiego wyrażenia jest wartością przeliczoną wysyłaną do drajwera kanału komunikacyjnego. Funkcja działa na zmiennej kontekstowej, której dotyczy operacja sterująca.

UWAGA: w przypadku korzystania z kanału komunikacyjnego Asix6, wartość sterująca jest jeszcze dodatkowo przeliczana przez moduł  komunikacyjny Asmen na podstawie atrybutu Funkcja przeliczająca.

Składnia

NewValue ()

Zobacz też

Funkcje  RawValue

 

 

 

ObjectData

 

Przeznaczenie

Funkcja zwraca wskazaną wartość danej lub stanu wybranego obiektu diagramu.

Składnia

ObjectData(nazwa_obiektu, dana)

Parametry

                nazwa_obiektu

                               Nazwa obiektu na tym samym diagramie. Obiekt musi mieć nadaną nazwę.

dana

Dla obiektu Kontener wzorców: CurrentPage – numer aktualnej strony, PageCount – liczba stron, ElementCount – liczba wszystkich elementów.

Dla obiektu Słupek: SliderPosition – położenie suwaka, PendingValue – wartość oczekująca na wysłanie.

Dla obiektu Tekst i Przycisk: PendingValue – wartość oczekująca na wysłanie.

Dla obiektu Wykres: MinX, MaxX, MinX, MaxY – wartości graniczne osi widzialnego obszaru wykresu. CursorX, CursorY  - współrzędne pozycji kursora; SeriesValue – wartość wskazanej serii dla linii odczytu kursora (dodatkowym parametrem jest numer serii).

Dla obiektu Wykres danych: MinLeft, MaxLeft, MinRight, MaxRight, MinTop, MaxTop, MinBottom, MaxBottom – wartości graniczne osi widzialnego obszaru wykresu.

 

Przykład

                ObjectData("Kont1","CurrentPage")

Zwraca numer aktualnej strony obiektu Kontener wzorców nazwanego „Kont1”.

 

 

 

 

 

OPCTime

 

Przeznaczenie

Funkcja tworzy wartość daty i czasu wyliczaną względem chwili aktualnej lub dowolnego innego momentu czasu. Przesunięcie opisane jest rozszerzonym wyrażeniem formatującym OPC.

Składnia

OPCTime (moment_bazowy,  przesunięcie_czasu)

OPCTime (przesunięcie_czasu)

Parametry

moment_bazowy

Chwila czasu, względem którego liczone jest przesunięcie. W przypadku wariantu wywołania bez momentu bazowego przesunięcie jest liczone względem chwili bieżącej.

przesunięcie_czasu

Określa modyfikację momentu bazowego służącą do wyliczenia wyniku funkcji. Przesunięcie opisane jest rozszerzonym wyrażeniem formatującym OPC postaci:

 [NOW|SECOND|MINUTE|HOUR|DAY|WEEK|MONTH|YEAR][cykl[/przesunięcie]] [[+|-][liczba][Y|MO|W|D|H|M|S]...]

Pierwsza część wyrażenia określa początkowe przesunięcie, np. NOW oznacza dokładnie moment bazowy, HOUR początek godziny. Klauzule  cykl i przesunięcie  pozwalają na implementacje cykli, np. HOUR8/6 pozwala na wyliczenie początku 8-godzinnej zmiany, gdzie pierwsza zmiana zaczyna się o godzinie 8. Końcowa część wyrażenia pozwala dodatkowo przesunąć czas, np. HOUR-15M , oznacza 15 minut przed początkiem godziny.

Przykład

Poniższe przykłady zakładają, że moment bazowy (zadeklarowany jawnie lub domyślnie) to 2011//05/09 11:06:30

NOW (lub pusty)             2011//05/09 11:06:30

NOW-1H                             2011//05/09 10:06:30

HOUR                                   2011//05/09 11:00:00

HOUR8/6                            2011//05/09 06:00:00

DAY+12H+15M                 2011//05/09 12:15:00

MONTH-1D                        2011//04/30 00:00:00

 

 

Or

 

Przeznaczenie

Funkcja służy do wyliczenia sumy logicznej wielu argumentów. Efekt jej działania jest identyczny do użycia konstrukcji z wieloma operatorami ||, ale w przypadku dużej liczby argumentów funkcja Or jest bardziej efektywna.

Składnia

Or (arg_1, ... ,arg_n)

Parametry

               arg_1, ..., arg_n

Kolejne argumenty sumy logicznej.

Zobacz też

Funkcja And

 


Parameter

 

Przeznaczenie

Funkcja  zwraca wartość parametru użytego w diagramie lub wzorcu. Działanie zależy od kontekstu użycia. Funkcja użyta wewnątrz wzorca pobiera zawsze wyłącznie parametry wzorca.

Składnia

Parameter (nazwa_parametru)

Parametry

                nazwa_parametru

                               Nazwa parametru, który należy pobrać z zestawu parametrów diagramu lub wzorca

Przykład

                Parameter(pokoj)

Pobierany jest parametr pokoj.  Jeżeli w wyrażeniu definiującym właściwość obiektu nie jest wymagana żadna dodatkowa funkcjonalność, to powyższe wywołanie można zastąpić skrótową notacją:

%pokoj

 

 

 

Parameters

 

Przeznaczenie

Funkcja zwraca ciąg nazw i wartości wszystkich parametrów używanych w bieżącym diagramie, wzorcu lub menu. Format ciągu parametrów jest zgodny z formatem używanym w akcjach OpenDiagram, OpenWindow i ShowMenu. Funkcja  ma za zadanie ułatwić przekazywanie parametrów pomiędzy sekwencyjnie otwieranymi diagramami i menu.

Składnia

Parameters ()

Przykład

               ShowMenu((menu1,Parameters())

Akcja otwiera menu kontekstowe diagramu o nazwie menu1. Jednocześnie do menu przekazywany jest kompletny zestaw parametrów zdefiniowanych w aktywnym diagramie.

 

 

PI

 

Przeznaczenie

Zwraca wartość liczby pi.

Składnia

PI ()

Zobacz też

                Funkcje Sin, Cos, Tan

 

 

 

Pow

 

Przeznaczenie

Funkcja wylicza wartość liczby podniesionej do podanej potęgi.             

Składnia

Pow (podstawa, potęga)

Parametry

                podstawa

Wartość, która ma być podniesiona do potęgi.

potęga

Wartość potęgi.

Zobacz też

                Funkcje Sqrt

 

 

 

PowerGuardRead

 

Przeznaczenie

Funkcja zwraca wartości związane z bieżącym stanem wskazanego miernika modułu Strażnik mocy.             

Składnia

PowerGuardRead (identyfikator, typ_danej)

Parametry

                identyfikator

Identyfikator miernika, którego dane należy zwrócić.

typ_danej

Określa, jaką daną dotyczącą miernika należy zwrócić. Możliwe jest użycie jednej z poniższych stałych:

$AverageValue – przewidywana średnia wartość w bieżącym cyklu

 $Limit– bieżący limit

$CycleStartTime – czas początku cyklu

$CycleEndTime – czas końca cyklu

$IsPredictionSafe – informacja czy przewidywana wartość średnia przekracza limit

$SafeRemainingValue - średnia wartość bezpieczna dla pozostałych interwałów

 

Property

 

Przeznaczenie

Funkcja  zwraca wartość właściwości globalnej o podanej nazwie.

Składnia

Property (nazwa_właściwości)

Parametry

                nazwa_właściwości

                               Nazwa właściwości globalnej, którą należy pobrać.

 Przykład

                Property(g1)

Pobierana jest definicja właściwości globalnej o nazwie g1.  Jeżeli w wyrażeniu definiującym właściwość obiektu nie jest wymagana żadna dodatkowa funkcjonalność, to powyższe wywołanie można zastąpić skrótową notacją:

!g1

Zobacz też

                Funkcje LocalProperty

 

 

 


 

RangeAggregate

 

Przeznaczenie

Funkcja zwraca wartość agregatu wartości historycznych zmiennej procesowej ze wskazanego horyzontu czasu.

Składnia

RangeAggregate(nazwa_agregatu, horyzont_początek,horyzont_koniec, okres_odświeżania)

RangeAggregate(nazwa_zmiennej, nazwa_agregatu, horyzont_początek, horyzont_koniec, okres_odświeżania)

Parametry

nazwa_agregatu

Nazwa agregatu, który należy wyliczyć. Dostępne nazwy to: none, start, end, delta, min, max, range, total, average, average0, sumup, sumdown, prevknown, last, stdev, rms, avglk, totallk. Nazwa none oznacza odczyt danych surowych. Opis agregatów znajduje się w dokumentacji modułu archiwizacji Aspad (Patrz: Rodzaje agregatów danych archiwalnych; Serwer Danych > Obsługa danych procesowych Serwera Danych >  Aspad - Program Archiwizacji Danych).

horyzont_początek

Początek horyzontu wyliczanego agregatu. Może być wartością typu data i czas (DateTime) lub tekstem konwertowalnym na datę i czas. Dopuszczalne są formaty systemowe i OPC  (zobacz funkcje ToDateTime i OPCTime).

horyzont_koniec

Koniec horyzontu wyliczanego agregatu. Może być wartością typu data i czas (DateTime) lub tekstem konwertowalnym na datę i czas. Dopuszczalne są formaty systemowe i OPC  (zobacz funkcje ToDateTime i OPCTime).

okres_odświeżania

Okres ponawiania odczytu danych archiwalnych. Może być wartością typu zakres czasu (TimeSpan) lub tekstem konwertowalnym na zakres czasu (zobacz funkcję ToTimeSpan).

nazwa_zmiennej

Nazwa zmiennej, której wartości historyczne są pobierane. Można stosować sufiksowe nazwy zmiennych. W przypadku wariantu funkcji bez podania nazwy zmiennej używana jest zmienna wynikająca  z kontekstu użycia.

Przykład

                RangeAggregate(min,”HOUR”,”NOW”,”00:00:10”)

Funkcja zwraca minimalną wartość zmiennej kontekstowej z okresu od początku godziny do chwili bieżącej. Wartość funkcji jest przeliczana co 10 sekund.

                RangeAggregate(z1, average,”HOUR-1H”,”HOUR”,”00:01:00”)

Funkcja zwraca średnią wartość zmiennej z1 z okresu ostatniej zakończonej godziny. Wartość funkcji jest przeliczana co 1 minutę.

Zobacz też

- Funkcje HorizonAggregate, ToDateTime, OPCTime, ToTimeSpan,

-  Rodzaje agregatów danych archiwalnych

- Serwer Danych > Obsługa danych procesowych Serwera Danych >  Aspad - Program Archiwizacji Danych

 


RateOfChange

 

Przeznaczenie

Funkcja wylicza prędkość zmian wartości dowolnego wyrażenia. Typowo jest wykorzystywana w strategii warunkowej wykrywania alarmów jako część wyrażenia użytego w parametrach wykrywania.

Składnia

RateOfChange(wartość, okres_przeliczania)

Parametry

                wartość

                               Wyrażenie, którego prędkość zmian wartości jest monitorowana.

                okres_przeliczania

Okres czasu wyrażony w sekund określający, jak często wyliczana jest prędkość zmiany wartości monitorowanej.

Przykład

                RateOfChange(Variable(s1),5)>20

Co 5 sekund wyliczana jest średnia prędkość zmiany wartości w ostatnim okresie obliczeniowym. Następnie sprawdzane jest, czy ta prędkość jest większa niż 20 jednostek/sekundę.

Zobacz też

                - funkcje DeadBand,  DelayedState

- System_alarmów > 5.2 Strategia warunkowa

 


 

RelToAbsY

 

Przeznaczenie

Funkcja konwertuje współrzędną pionową lub wysokość z wartości względnej wyrażonej w pikselach na wartość bezwzględną (0 do 1 000 000). Ogólne zasady użycia są takie same jak w przypadku funkcji RelToAbsX.

Składnia

 RelToAbsY(współrzędna_Y)

Parametry

                współrzędna_Y

Współrzędna Y lub wysokość obiektu w jednostkach względnych(pikselach), którą należy przeliczyć na  wartość bexwzględną.

Zobacz też

- funkcje AbsToRelX, AbsToRelY, RelToAbsX

- Techniki_budowy_diagramów > 13 Animacja ruchu i zmiana rozmiaru obiektów

 

 

 


 

RawValue

 

Przeznaczenie

Funkcja zwraca bieżącą wartość surową zmiennej procesowej. Jest to oryginalna wartość zmiennej odczytana przez drajwer kanału komunikacyjnego przed zastosowaniem funkcji przeliczającej zdefiniowanej w bazie zmiennych w atrybucie Funkcja przeliczająca odczytu. Głównym zastosowaniem funkcji jest dostęp do wartości  zmiennej w wyrażeniach użytych w atrybucie Funkcja przeliczająca odczytu w celu przeliczenia wartości surowej zmiennej. Tak przeliczona wartość zmiennej jest potem dostępna poprzez funkcję Variable.

UWAGA: w przypadku korzystania z kanału komunikacyjnego Asix6, wartość zwracana przez funkcję jest już wstępnie przeliczona przez moduł  komunikacyjny Asmen na podstawie atrybutu Funkcja przeliczająca.

Składnia

RawValue ()

RawValue (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której bieżącą wartość surową należy zwrócić. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej odczytywana jest wartość zmiennej wynikającej  z kontekstu użycia. W przypadku użycia funkcji w wyrażeniu atrybutu Funkcja przeliczająca odczytu, zmienną kontekstową jest zmienna, której definicja atrybutu dotyczy.

Zobacz też

Funkcje  Variable, NewValue  


 

 

Reg

 

Przeznaczenie

Funkcja zwraca wartość wybranego rejestru diagramu lub wzorca. Rejestry pozwalają na optymalizację działania aplikacji poprzez centralne wyliczanie wyrażeń, których wartość jest potrzebna w wielu miejscach.

Składnia

 Reg(nazwa_rejestru)

Parametry

                nazwa_rejestru

Nazwa rejestru, którego wartość ma zostać zwrócona. Nazwa rejestru składa się z litery X i numeru kolejnego rejestru (licząc od 1). Jeżeli nazwa zostanie poprzedzona znakiem !, to oznacza to, że w przypadku użycia funkcji wewnątrz wzorca odwołanie dotyczy rejestru diagramu, na którym wzorzec został osadzony.

Zobacz też

- funkcja RegStatus

 

 

 

RegStatus

 

 

Przeznaczenie

Funkcja  zwraca wartość statusu dla wskazanego rejestru diagramu lub wzorca.

 Z wartością każdego rejestru diagramu lub wzorca związany jest jego status Opc. Zasady wyliczania statusów rejestrów są identyczne jak dla statusów właściwości lokalnych i zostały podane w opisie funkcji LocalPropertyStatus.

Składnia

RegStatus (nazwa_rejestru)

Parametry

                nazwa_właściwości

                               Nazwa właściwości lokalnej, której status należy pobrać.

                nazwa_obiektu

Nazwa rejestru X1, X2, … . Jeżeli w wywołaniu funkcji użytym wewnątrz wzorca, nazwa rejestru zostanie poprzedzona znakiem !, to oznacza to, odwołanie do rejestru diagramu, na którym obiekt został osadzony.

Zobacz też

                Funkcja LocalPropertyStatus

 

 


RelToAbsX

 

Przeznaczenie

Funkcja konwertuje współrzędną poziomą lub szerokość z wartości względnej wyrażonej w pikselach  na wartość bezwzględną (0 do 1 000 000). Wartości bezwzględne są przechowywane w definicjach współrzędnych. Przejście na wartości względne wykonywane jest w trakcie wyświetlania obiektu i jest dostosowywane do aktualnych rozmiarów diagramu. Współrzędna bezwzględna 1 000 000 odpowiada prawej krawędzi diagramu. Funkcja używana jest w przypadku implementacji ruchu lub zmiany rozmiaru obiektów.

Składnia

 RelToAbsX(współrzędna_X)

Parametry

               współrzędna_X

Współrzędna X lub szerokość obiektu w jednostkach względnych (pikselach), którą należy przeliczyć na  wartość bezwzględną.

Zobacz też

- funkcje AbsToRelX, AbsToRelY, RelToAbsY

- Techniki_budowy_diagramów > 13 Animacja ruchu i zmiana rozmiaru obiektów

 

 

 

Replace

 

Przeznaczenie

Funkcja tworzy napis poprzez zamianę wszystkich wystąpień wskazanego podciągu na inny ciąg znaków.

Składnia

Replace(napis, stary_tekst, nowy_tekst) 

 

Parametry

               napis

                Napis, na podstawie którego będzie tworzony napis zmodyfikowany.

stary_tekst

                Ciąg znaków, który należy zastąpić nową zawartością.

nowy_tekst

Nowy ciąg znaków, który zamieni poprzednią zawartość.

Zobacz też

                Funkcje Substring,  Concat

 

 

 

 

RoleDescription

 

Przeznaczenie

Funkcja zwraca napis opisujący rolę systemu zabezpieczeń.

Składnia

RoleDescription(rola)

Parametry

                rola

Identyfikator roli systemu zabezpieczeń, której opis należy zwrócić.

Zobacz też

                Funkcje HasRole

 

 

 

Round

 

Przeznaczenie

Funkcja zaokrągla liczbę zmiennoprzecinkową do podanej liczby cyfr ułamkowych.

Składnia

Round (wartość, liczba_cyfr)

Parametry

                wartość

Wartość, która ma być zaokrąglona.

liczba_cyfr

Liczba cyfr ułamkowych w zwracanej wartości.

Przykład

                Round (Variable(), 3)

Wywołanie zwraca wartość zmiennej kontekstowej zaokrągloną do 3 miejsc po przecinku. Jeżeli celem byłoby jedynie wyświetlenie zaokrąglonej wartości na ekranie, to można też użyć funkcji formatującej teksty Format - w poniższy sposób:

Format(”{0:f3}”,Variable())

Zobacz też

                Funkcja Format

 

 

 

 

ScriptValue

 

Przeznaczenie

Funkcja wywołuje wskazany skrypt i zwraca wynik jego działania ustawiony w skrypcie za pomocą funkcji SetReturnValue(..).

Składnia

ScriptValue(nazwa_skryptu, okres_wywoływania, parametry_skryptu…)

Parametry

                nazwa_skryptu

Nazwa wywoływanego skryptu

okres_wywoływania

Okres wywoływania skryptu [s]. Gdy zero to skrypt jest wykonywany tylko jednokrotnie.

parametry_skryptu

Parametry skryptu rozdzielone kolejnymi przecinkami.

 

Przykład

                ScriptValue("OdczytajPlik", 30, "dane.csv", 10)

Funkcja wywołyje skrypt o nazwie OdczytajPlik co 30 sekund podając jako jego parametr skryptu nazwę pliku dane.csv i numer wiersza w pliku (10).

Zobacz też

                Skrypty:  SetReturnValue

 

 

 

 

 

Sequence

 

Przeznaczenie

Funkcja zwraca tablicę elementów wypełnioną sekwencją liczb lub czasów. Może być wykorzystywana na przykład do przekazywania wartości serii dla obiektu Wykres Danych lub parametrów obiektu Kontener Wzorców.

Składnia

Sequence (first, last, step)

Parametry

              first

Pierwszy element sekwencji. Może być liczbą całkowitą, liczbą dziesiętną lub punktem w czasie (DateTime).

last

Ostatni element sekwencji. Może być liczbą całkowitą, liczbą dziesiętną lub punktem w czasie (DateTime).

step

Krok sekwencji. Może być liczbą całkowitą, liczbą dziesiętną lub czasem trwania (TimeSpan).

 

Przykład

                Sequence(0, 200, 20)

Zwraca tablicę 11 liczb z zakresu od 0 do 200 tworzących ciąg <0,20, 40, …, 180, 200>.

 

Sequence(15, 15, 5)

Zwraca tablicę 5 powtórzeń liczby 15 :  <15, 15, 15, 15, 15>.

 

Sequence(ToDateTime("14.05.2018 08:00:00"), ToDateTime("14.05.2018 12:00:00"), ToTimeSpan("30m"))

Zwraca tablicę 9 punktów w czasie (DateTime) tworzących ciąg <„14.05.2018 08:00:00”, „14.05.2018 08:30:00”, „14.05.2018 09:00:00”, …, „14.05.2018 12:00:00”>

 

 

 

 

Sin

 

Przeznaczenie

Funkcja wylicza wartość funkcji sinus.

Składnia

Sin (kąt)

Parametry

                kąt

Argument funkcji sinus wyrażony w radianach

Przykład

                Sin(PI() * Variable(z1) / 180)

Funkcja liczy sinus kąta podanego w stopniach i pobranego z wartości zmiennej z1.

Zobacz też

                Funkcje Cos, Tan, Pi  

 


 

Slide

 

Przeznaczenie

Funkcja symuluje płynną zmianę wartości pomiarowej. Funkcja reaguje na zmianę wartości wejściowej, stopniowo zwiększając wartość wynikową, aż do osiągnięcia wartości wejściowej. Funkcja może być stosowana do płynnej animacji ruchu elementów. Należy jednak pamiętać o tym, że jej użycie powoduje pewne opóźnienie wizualizacji stanu bieżącego kontrolowanego obiektu.

Składnia

Slide (wartość, czas_trwania)

Parametry

                wartość

Docelowa wartość funkcji.

                czas_trwania

Czas podany w milisekundach, po którym wartość funkcji osiągnie docelową wartość przekazaną w pierwszym parametrze.

 

Przykład

              SetPosition( RelToAbsX(100 + Slide(Variable(pos),1000)),null)

Akcja pozwala na płynny przesuw położenia obiektu w osi X. Należy użyć ją w obsłudze zdarzenia Animacja. Zmienna pos przekazuje żądaną pozycję w pikselach. Użycie funkcji Slide spowoduje, że przesunięcie obiektu na diagramie odbędzie się w sposób płynny.

 

 

 

SplitString

 

Przeznaczenie

Funkcja dzieli podany napis wejściowy na elementy składowe. Elementy składowe są rozdzielone podanym w wywołaniu separatorem. W zależności od sposobu wywołania, funkcja zwraca wskazany podciąg lub tablice wszystkich podciągów.

Składnia

SplitString(napis, separator)

SplitString(napis, separator, numer_elementu)

Parametry

                napis

Napis, który należy podzielić na elementy składowe.

separator

Separator służący do rozdzielenia napisu wejściowego ma elementy składowe.

numer_elementu

Numer podciągu składowego, który zostanie zwrócony w wyniku wykonania funkcji. Pierwszy podciąg ma numer 0. W przypadku wywołania funkcji bez tego parametru, zwrócona zostanie tablica wszystkich podciągów składowych.

 

 

SqlConnection

 

Przeznaczenie

Funkcja zwraca parametry zdefiniowanego w aplikacji połączenia SQL o zadanej nazwie. Połączenia SQL można definiować w ustawieniach stanowisk:  Eksplorator aplikacji > Ustawienia stanowiska > Połączenia SQL. Funkcja może zostać wykorzystana np. we właściwości „Parametry połączenia” obiektów Tabela Danych lub Wykres Danych.

Składnia

SqlConnection(id)

Parametry

                id

Identyfikator zdefiniowanego połączenia SQL.

Przykład

               SqlConnection("ProductsSqlServer")

 

 

Sqrt

 

Przeznaczenie

Funkcja wylicza wartość pierwiastka kwadratowego.

Składnia

Sqrt (argument)

Parametry

                argument

Argument funkcji pierwiastka kwadratowego.

Zobacz też

                Funkcja Pow


 

 

StationDiagInfo

 

Przeznaczenie

Funkcja zwraca wybrane informacje diagnostyczne dotyczącego wskazanego stanowiska zgromadzone na serwerze diagnostyki, np. status kanału komunikacyjnego, nazwę zalogowanego użytkownika itp.

Działanie funkcji wymaga zdefiniowania we właściwościach globalnych aplikacji nazwy serwera diagnostyki.

 

 

Składnia

StationDiagInfo(nazwa_stanowiska, typ_informacji)

StationDiagInfo(nazwa_stanowiska, typ_informacji, nazwa zasobu)

 

Parametry

              nazwa_stanowiska

Nazwa stanowiska, którego dane diagnostyczne mają zostać zwrócone. Dozwolone warianty przekazania parametru są następujące:

Nazwa_stanowiska – dotyczy konkretnego unikalnie zdefiniowanego w aplikacji stanowiska

Nazwa_stanowiska&Adres_IP – dotyczy stanowiska wielokrotnego (np. terminalowego) o konkretnym adresie IP

Nazwa_stanowiska&Nazwa_komputera – dotyczy stanowiska wielokrotnego (np. terminalowego) o konkretnej nazwie systemowej komputera

Nazwa_stanowiska&Nazwa_serwera_RDS#Numer_sesji – dotyczy stanowiska wielokrotnego (np. terminalowego) pracującego na serwerze RDS w sesji o podanym numerze

              typ_informacji

Nazwa typu informacji, które zostaną zwrócone przez funkcję. Lista dozwolonych nazw dostępna jest w okienku kreatora wyrażeń.

 

StationDiagInfo(station, data)

 

 

StationDiagInfo(station, data, param)

 

nazwa_zasobu

Dodatkowy parametr, którego podanie wymagane jest dla niektórych typów informacji, np. nazwa kanału komunikacyjnego, nazwa archiwum, nazwa domeny alarmów.

Przykład

              StationDiagInfo(SERV2, ChannelState, Silos1)

Wywołanie zwraca aktualny status pracy dla kanału o nazwie Silos1 na stanowisku o nazwie SERV2.

 

 

 

StationInfo

 

Przeznaczenie

Funkcja zwraca wybrane informacje o stanowisku aplikacji lub komputerze, np. nazwę i adres sieciowy komputera, nazwę użytkownika systemowego itp.


 

Składnia

StationInfo(typ_informacji)

Parametry

                Typ_informacji

Stała określająca, jakie informacje dotyczące stanowiska należy zwrócić. Lista dozwolonych stałych dostępna jest w okienku kreatora wyrażeń.

Przykład

                StationInfo($ApplicationName)

                Wywołanie zwraca nazwę wykonywanej aplikacji.

 

 

Switch

 

Przeznaczenie

Funkcja zwraca wartość przypisaną do pierwszej wartości porównywanej równej wartości sprawdzanej. W przypadku, gdy żadna wartość nie pasuje, to zwraca wartość domyślną (ostatni argument). Zaleca się stosowanie tej funkcji zamiast zagnieżdżonych operatorów warunkowych (‘?’ ‘:’).

Składnia

If(wartość_testowana, porównywana1, zwracana1, porównywana2, zwracana2, …, zwracana_domyślna)

Przykład

                =Switch(Variable("StanPracy"), 1, "Postój", 2, "Praca ciągła", 0, "Awaria", "Nieustalony")

Zobacz też

                Funkcje If, operator warunkowy ?:

 

 

 

 

 

Substring

 

Przeznaczenie

Funkcja zwraca napis będący fragmentem napisu podanego w wywołaniu funkcji.

Składnia

Substring(napis, początek)

Substring(napis, początek, długość)

Parametry

                napis

                Napis, z którego zostanie wycięty fragment.

początek

                Indeks pierwszego znaku wycinanego fragmentu. Pierwszy znak ma numer 0.

długość

Ilość wycinanych znaków. Brak parametru oznacza wycięcie wszystkich znaków aż do końca napisu.

Przykład

                Substring(Attribute(Description), 0, 10)+"..."

                Wyrażenie zwraca pierwsze 10 znaków opisu zmiennej kontekstowej uzupełnione o znaki ....

Zobacz też

                Funkcje Replace,  Concat


 

 

TableElement

 

Przeznaczenie

Funkcja zwraca wskazany element z wartości tablicowej. Funkcja przeznaczona głównie do uzyskania dostępu do elementów tablicowych zmiennych procesowych w wyrażeniach użytych we właściwościach obiektów.

Składnia

                TableElement(tablica, indeks)

Parametry

                tablica

Wartość tablicowa, której element należy pobrać. Typowo jest to wartość tablicowej zmiennej procesowej. Można również użyć napis - w tym przypadku zwrócony jest pojedynczy znak.

Gdy tablica jest dwuwymiarowa, zwracana jest podtablica zawierająca wszystkie elementy w drugim wymiarze odpowiadające wskazanemu indeksowi w pierwszym wymiarze.

indeks

Indeks elementu, który należy zwrócić. Pierwszy element ma indeks równy 0.

 

Przykład

                TableElement(Variable(),0)

                Funkcja zwraca pierwszy element z wartości tablicowej zmiennej kontekstowej.

Zobacz też

                funkcja TableLength

 

 


 

TableLength

 

Przeznaczenie

Funkcja zwraca liczbę elementów w wartości tablicowej.

 

Składnia

                TableLength (tablica)

Parametry

                tablica

Wartość tablicowa, której ilość elementów zostanie zwrócona. Typowo jest to wartość tablicowej zmiennej procesowej. Można również użyć napis - w tym przypadku zwrócona zostanie długość napisu.

Przykład

                TableLength(Variable())

                Funkcja zwraca ilość elementów w wartości zmiennej kontekstowej.

                TableLength(Attribute(Name))

                Zwraca długość nazwy zmiennej kontekstowej.

Zobacz też

                funkcja TableElement

               


 

 

Tan

 

Przeznaczenie

Funkcja wylicza wartość funkcji tangens.

Składnia

Tan (kąt)

Parametry

                kąt

Argument funkcji tangens wyrażony w radianach.

Zobacz też

                Funkcje Sin, Cos,Pi

 


 

 

Text

 

Przeznaczenie

Funkcja zwraca napis z puli napisów wielojęzycznych. Zwracany jest wariant napisu odpowiedni dla aktualnego języka pracy. Użycie funkcji w definicji właściwości Tekst obiektu Tekst spowoduje, że w momencie zmiany języka obiekt automatycznie zmieni wyświetlany napis.

Składnia

Text (identyfikator_napisu)

Parametry

               identyfikator_napisu

Identyfikator napisu wielojęzycznego  zdefiniowanego w aplikacji.

Zobacz też

Asix.Evo_Parametryzacja_aplikacji, 4 Parametryzacja aplikacji wielojęzycznych

 


 

TimetableRead


Przeznaczenie

Funkcja zwraca informacje dotyczące wskazanego harmonogramu.

Składnia

TimetableRead (identyfikator_harmonogramu, rodzaj_danej)

Parametry

               identyfikator_harmonogramu

Identyfikator harmonogramu, którego dotyczy wywołanie funkcji.

               rodzaj_danej

Parametr określa rodzaj zwracanej informacji. Możliwe jest użycie jednej z poniższych stałych:

$NextEventTime – żąda zwrócenia czasu następnego planowanego zdarzenia w postaci wartości typu DateTime.

$HasNextEvents – żąda zwrócenia informacji czy są jeszcze jakieś planowane zdarzenia dla harmonogramu. Zwracana jest wartość logiczna.

 

 

ToAsix6Date

 

Przeznaczenie

Funkcja przelicza  wartość typu data i czas (typ DateTime platformy .NET) lub  tekstowy opis daty i czasu na liczbę sekund, która upłynęła od 1.1.1970. Zwracana wartość jest liczbą 32-bitową bez znaku. Funkcja używana głównie przy konwersji aplikacji Asix6.

Składnia

ToAsix6Time (data_czas)

Parametry

                data_czas

Przeliczana data i czas, która może być:

·         wartością typu data i czas (DateTime)

·         tekstem, którego format jest zgodny z formatem stosowanym w funkcji ToDateTime

Zobacz też

                Funkcje ToDateTime, FromAsix6Date, OPCTime

 

 

 

ToAsix6Time 

 

Przeznaczenie

Funkcja przelicza wartość typu zakres czasu (typ TimeSpan platformy .NET) lub  tekstowy opis okresu czasu na liczbę milisekund. Zwracana wartość jest liczbą 32-bitową bez znaku.

Składnia

ToAsix6Time (zakres_czasu)

Parametry

                zakres_czasu

Przeliczany zakres czasu, który może być:

·         wartością typu zakres czasu (TimeSpan)

·         tekstem, którego format jest zgodny z formatem stosowanym w funkcji ToTimeSpan

Przykład

ToAsix6Time(”30:00”)

Uzyskana wartość jest równa ilości milisekund w 30-godzinnym okresie czasu.

Zobacz też

                Funkcje ToTimeSpan, FromAsix6Time, OPCTime

 

 

 

ToBool

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na wartość logiczną true/false.

Składnia

ToBool (wartość)


 

Parametry

                wartość

Konwertowana wartość. W przypadku wartości liczbowych, jeżeli wartość jest różna 0, to zwracana jest wartość true, w przeciwnym przypadku zwracane jest false. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę.

Przykład

                ToBool(Attribute(wazna))

Z bazy definicji zmiennych pobierana jest treść atrybutu wazna zmiennej kontekstowej. Następnie  treść atrybutu jest konwertowana na liczbę i zamieniana na wartość logiczną. Dopuszczalne jest także bezpośrednie umieszczenie w atrybucie tekstów true lub false.

 

 

 

 

ToDateTime

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na format liczbowy daty i czasu (typ DateTime platformy .NET)

Składnia

ToDateTime (data_czas)

Parametry

                data_czas

Data i czas w formacie tekstowym lub w postaci liczby zmiennoprzecinkowej. Dopuszczalny jest dowolny format tekstowy rozpoznawalny przez system jako data i czas. Jeżeli podany jest tylko czas, to jako data zostanie przyjęty dzień bieżący. W przypadku liczby zmiennoprzecinkowej w trakcie konwersji stosowana jest konwencja OLE Automation.

Przykład

DateTime(”15:10”)

Uzyskana zostanie wartość równoważna godzinie 15:10 i dacie dnia bieżącego.

DateTime(Variable(z1))

Wartość zmiennej z1 zostanie zwrócona w formacie daty i czasu. Wartość zmiennej musi być tekstem konwertowalnym na datę i czas lub liczbą zmiennoprzecinkową w konwencji OLE Automation.

Zobacz też

                Funkcje ToAsix6Date, FromAsix6Date, OPCTime

 


 

ToDouble 

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na liczbę zmiennoprzecinkową podwójnej precyzji.

Składnia

ToDouble (wartość)

Parametry

                wartość

Konwertowana wartość.

Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Jeżeli wartość jest typu DateTime, to jest konwertowana na odpowiednik daty OLE Automation.

Przykład

                ToDouble(Variable(i1))/Variable(i2)

Jeżeli zmienne i1 I i2 są całkowitoliczbowe, to dzielenie wartości tych zmiennych zwracało by także liczbę całkowitą, np. 4/8 = 0. Konwersja jednego z argumentów dzielenia na liczbę zmiennoprzecinkową powoduje, że wynik będzie dokładny, 4/8 = 0.5

Zobacz też

                Funkcja ToSingle

 


 

 

ToFullPath

 

Przeznaczenie

Funkcja zwraca bezwzględną ścieżkę do pliku dla ścieżki podanej względem katalogu definicyjnego aplikacji.

Składnia

                ToFullPath (nazwa_pliku)

Parametry

                nazwa_pliku

Nazwa pliku lub katalogu, która zostanie uzupełniona z uwzględnieniem pełnej ścieżki  katalogu aplikacji. Pusta nazwa pliku spowoduje zwrócenie ścieżki katalogu aplikacyjnego.

 

 

 

ToInt8

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 8-bitową liczbę całkowitą ze znakiem.

Składnia

ToInt8 (wartość)

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund. 

Zobacz też

                Funkcje ToInt16, ToInt32, ToInt64, ToUInt8, ToUInt16, ToUInt32, ToUInt64


 

 

ToInt16

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 16-bitową liczbę całkowitą ze znakiem.

Składnia

ToInt16 (wartość)

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Przykład

                ToInt16(Variable(z1)&0xffff)

                Operacja & powoduje, że wartość zmiennej z1 jest ograniczana do zakresu liczby 16-bitowej.

Zobacz też

                Funkcje ToInt8, ToInt32, ToInt64, ToUInt8, ToUInt16, ToUInt32, ToUInt64

 

 

 

ToInt32

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 32-bitową liczbę całkowitą ze znakiem.

Składnia

ToInt32 (wartość)


 

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Zobacz też

                Funkcje ToInt8, ToInt16, ToInt64, ToUInt8, ToUInt16, ToUInt32, ToUInt64

 


 

ToInt64

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 64-bitową liczbę całkowitą ze znakiem.

Składnia

ToInt64 (wartość)

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Jeżeli wartość jest typu DateTime, to jest konwertowana na odpowiednik typu FileTime systemu Windows.

Zobacz też

                Funkcje ToInt8, ToInt16, ToInt32, ToUInt8, ToUInt16, ToUInt32, ToUInt64

 

 

 

ToLocalTime

 

Przeznaczenie

Funkcja konwertuje wartość typu data i czas z czasu UTC na czas lokalny.

Składnia

ToLocalTime(czas_UTC)

Parametry

                czas_UTC

Wartość konwertowana. Musi to być wartość typu DateTime lub tekst, który można poprawnie zinterpretować, jako datę i czas.

Zobacz też

                Funkcje ToUTCTime

 

 

 

ToLower

 

Przeznaczenie

Funkcja zwraca napis, który powstał przez zamianę w napisie (przekazanym w parametrze) wszystkich wielkich liter na małe.

Składnia

ToLower(napis)

Parametry

                napis

Napis, który zostanie skonwertowany na małe litery.

Zobacz też

                Funkcje ToUpper

 

 


 

ToSingle

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na liczbę zmiennoprzecinkową pojedynczej precyzji.

Składnia

ToSingle (wartość)

Parametry

                wartość

Konwertowana wartość.

Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę.

 Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Zobacz też

                Funkcja ToDouble

 


 

 

ToString

 

Przeznaczenie

Funkcja konwertuje wartość liczbową interpretowaną jako sekwencję kodów ASCII na tekst Unicode.

Składnia

ToString (wartość)

Parametry

                wartość

Konwertowana wartość liczbowa. Obsługiwane są także tablice wartości.

Przykład

                ToString(Variable(msgtext))

Wartość zmiennej msgtext jest konwertowana na tekst. Zakładając, że ta wartość (typu 32-bitowa liczba całkowita) była równa 0x414243, to zwrócony zostanie tekst "CAB”. Kolejność znaków wynika z fizycznego ułożenia kolejnych bajtów liczby w pamięci - młodsze bajty występują jako pierwsze.

 

 

 

 

ToTable

 

Przeznaczenie

Funkcja zwraca tablicę elementów przekazanych jako kolejne argumenty jej wywołania. Może być wykorzystywana na przykład do przekazywania wartości serii dla obiektu Wykres Danych.

Składnia

ToTable (el1, el2, el3, …)

Parametry

                Elementy…

Wartości kolejnych elementów tablicy

Przykład

                ToTable(Variable("V1"), Variable("V2"), Variable("V3"))

Zwraca tablicę zbudowaną z bieżących wartości trzech wskazanych zmiennych procesowych.

 

 

 

 

ToTimeSpan

 

Przeznaczenie

Funkcja konwertuje tekstowy opis zakresu czasu na format zakresu czasu (typ TimeSpan platformy .NET)

Składnia

ToTimeSpan (zakres)

Parametry

                zakres

Zakres czasu przekazywany jest w formacie tekstowym. Obsługiwane są poniższe konwencje:

·                    d.h:m:s   h:m:s   h:m  , gdzie d, h, m, s są liczbami nieujemnymi oznaczającymi kolejno dni, godziny, minuty i sekundy,  np.: "3.10:5:4" lub "123:00"

·                    ciąg złożony ze składników ze zbioru (nd, nD, nh, nH, nm, nM, ns, nS), gdzie n jest liczbą nieujemną, a d, h, m, s oznaczają kolejno dni, godziny, minuty i sekundy, np.: "20d" lub "3D 4H  2M 1S" lub "15M10s"

Zobacz też

                Funkcje ToAsix6Time, FromAsix6Time

 


 

 

ToUInt8 

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 8-bitową liczbę całkowitą bez znaku.

Składnia

ToUInt8 (wartość)

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

 

Zobacz też

                Funkcje ToInt8, ToInt16, ToInt32, ToInt64, ToUInt8, ToUInt16, ToUInt32, ToUInt64

 


 

 

ToUInt16

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 16-bitową liczbę całkowitą bez znaku.

Składnia

ToUInt16 (wartość)

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Zobacz też

                Funkcje ToInt8, ToInt16, ToInt32, ToInt64, ToUInt8, ToUInt16, ToUInt32, ToUInt64

 


 

ToUInt64

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 64-bitową liczbę całkowitą bez znaku.

Składnia

ToUInt64 (wartość)

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Jeżeli wartość jest typu DateTime, to jest konwertowana na odpowiednik typu FileTime systemu Windows.

Zobacz też

                Funkcje ToInt8, ToInt16, ToInt32, ToInt64, ToUInt8, ToUInt16, ToUInt32

 


 

ToUInt32

 

Przeznaczenie

Funkcja konwertuje wartość przekazaną w parametrze na 32-bitową liczbę całkowitą bez znaku.

Składnia

ToUInt32 (wartość)

Parametry

                wartość

Konwertowana wartość. Jeżeli parametr jest tekstem, to najpierw wykonywana jest próba konwersji na liczbę. W przypadku konwersji z liczb zmiennoprzecinkowych wartość jest zaokrąglana. Nie można konwertować liczb zbyt dużych dla docelowego formatu.

Jeżeli wartość jest typu TimeSpan, to jest konwertowana na liczbę sekund.

Zobacz też

                Funkcje ToInt8, ToInt16, ToInt32, ToInt64, ToUInt8, ToUInt16, ToUInt64

 


 

ToUpper

 

 

Przeznaczenie

Funkcja zwraca napis, który powstał przez zamianę w napisie (przekazanym w parametrze) wszystkich małych liter na wielkie.

Składnia

ToUpper(napis)

Parametry

                napis

Napis, który zostanie skonwertowany na wielkie litery.

Zobacz też

                Funkcje ToLower

 

 

 

ToUTCTime

 

Przeznaczenie

Funkcja konwertuje wartość typu data i czas z czasu lokalnego na czas UTC.

Składnia

ToUTCTime(czas_lokalny)

Parametry

                czas_lokalny

Wartość konwertowana. Musi to być wartość typu DateTime lub tekst, który można poprawnie zinterpretować, jako datę i czas.

Zobacz też

                Funkcje ToLocalTime

 

 

 

 

Truncate

 

 

Przeznaczenie

Funkcja zwraca część całkowitą liczby.

Składnia

Truncate (wartość)

Parametry

                wartość

Argument funkcji

Zobacz też

                Funkcja Round

 

 

 

 

ValueOrDefault

 

 

Przeznaczenie

Funkcja zwraca wartość przekazaną w parametrze wywołania lub wartość domyślną (zastępczą) w przypadku, gdy wartość podstawowa jest niezdefiniowana, niepoprawna lub posiada status QualityBad. Funkcja pozwala uprościć niektóre wyrażenia wykorzystujące konstrukcje warunkowe.

Składnia

ValueOrDefault (wartość, wartość_domyślna)

Parametry

wartość

Wartość podstawowa, zwracana przez funkcję, gdy jest różna od null (jest ustawiona), posiada status różny od QualityBad i w przypadku liczby zmiennoprzecinkowej jest liczbą poprawną.

wartość_domyślna

Wartość zastępcza zwracana, gdy pierwszy argument wywołania funkcji jest równy null  (nieustawiony) lub jest niepoprawną liczbą zmiennoprzecinkową lub posiada status QualityBad.

Przykład

                ValueOrDefault( Variable(v1), -1)

Wyrażenie zwraca wartość zmiennej v1, jeżeli została ona już odczytana i jest poprawna. W przeciwnym wypadku zwraca wartość -1. Powyższe wyrażenie jest równoważne wyrażeniu warunkowemu Variable(v1)!=null && VarIsGood(v1) ? Variable(v1) : -1

Zobacz też

Funkcja LocalPropertyStatus

 

 

VarBit 

 

Przeznaczenie

Funkcja  zwraca stan (True/False) wskazanego bitu zmiennej procesowej.

Składnia

VarBit(numer_bitu)

VarBit(nazwa_zmiennej, numer_bitu)

Parametry

                numer_bitu

Numer bitu (pierwszy to 0), którego chcemy stan sprawdzić.

Przykład

                VarBit(3)

Funkcja zwraca wartość true lub false odpowiadającą stanowi czwartego bitu kontekstowej.

 

 

 

 

 

 

VarChanged

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą o zmianie wartości zmiennej procesowej w ostatnim okresie czasu. Funkcja ma dwa przeznaczenia. Jeżeli wartość okresu sprawdzania jest większa od 0, to funkcja jest typowo używana w warunkach stanów obiektów (lub wyrażeniach warunkowych) - służy do sygnalizowania na diagramie faktu niedawnej zmiany wartości. Jeżeli okres sprawdzania  jest równy 0, to funkcja używana jest w wyrażeniach warunków terminarza akcji. Pozwala to na uruchamianie akcji operatorskiej w reakcji na każdorazową zmianę wartości zmiennej.

Składnia

VarChanged (okres)

VarChanged (nazwa_zmiennej, okres)


 

Parametry

nazwa_zmiennej

Nazwa zmiennej, dla której wyliczany jest status zmiany wartości. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, kontrolowana jest wartość zmiennej wynikającej  z kontekstu użycia.

okres

Okres w sekundach, przez jaki wartość funkcji będzie równa true po wykryciu zmiany wartości zmiennej. Wartość 0 oznacza chwilowe ustawienie wartości true i niezwłoczny powrót do stanu false.

Zobacz też

Funkcja VarTime, Terminarz

 

 

 

Variable

 

Przeznaczenie

Funkcja zwraca bieżącą wartość zmiennej procesowej po zastosowaniu wszystkich przeliczeń wynikających z definicji zmiennej w bazie definicji zmiennych. Dostęp do wartości nieprzeliczonej dostępny jest poprzez funkcję RawValue.

Składnia

Variable ()

Variable (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której bieżącą wartość należy zwrócić. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, odczytywana jest wartość zmiennej wynikającej  z kontekstu użycia.

Przykład

                Variable(”r;#_lmt”)

Odczytywana jest wartość zmiennej procesowej o nazwie zbudowanej przez dodanie sufiksu _lmt do nazwy zmiennej wynikającej z kontekstu użycia. Jeżeli wyrażenie jest użyte w miejscu, które będzie wymagało przejścia na postać tekstową, to konwersja zostanie wykonana w sposób domyślny dla typu wartości. Jeżeli wymagana jest kontrola formatowania, to należy stosować funkcje VarStringValue lub Format.

Zobacz też

Funkcje  VarIsGood, VarIsNotGood, VarStatus, VarTime, RawValue, VarStringValue, Format

 


VariableOrDefault

 

Przeznaczenie

Funkcja zwraca bieżącą wartość zmiennej procesowej po zastosowaniu wszystkich przeliczeń wynikających z definicji zmiennej w bazie definicji zmiennych (identycznie jak funkcja Variable). Jeżeli zmienna o podanej nazwie nie istnieje, to zwracana jest wartość domyślna.

Składnia

VariableOrDefault (nazwa_zmiennej, wartość_domyślna)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której bieżącą wartość należy zwrócić. Można stosować sufiksowe nazwy zmiennych. 

 wartość_domyślna

Wartość zastępcza zwracana, gdy zmienna nie istnieje. 

 

 

VarIsBad

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą czy status wartości zmiennej jest niepoprawny. W typowym zastosowaniu funkcja jest używana w warunkach stanów obiektów.

Składnia

VarIsBad()

VarIsBad(nazwa_zmiennej)

 

Parametry

                Nazwa_zmiennej

Nazwa zmiennej, której status poprawności jest zwracany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, sprawdzany jest status zmiennej wynikającej  z kontekstu użycia.

 

Zobacz też

                Funkcje VarIsNotGood, VarStatus, VarTime, VarIsUncertain

 

 

 

 

VarIsGood

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą czy status wartości zmiennej jest poprawny. W typowym zastosowaniu funkcja jest używana w warunkach stanów obiektów.

Składnia

VarIsGood ()

VarIsGood (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której status poprawności jest zwracany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, sprawdzany jest status zmiennej wynikającej  z kontekstu użycia.

Zobacz też

Funkcje  VarIsNotGood, VarStatus, VarTime

 

 

 

 

VarIsNotGood 

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą, czy status wartości zmiennej jest niepoprawny - czyli aktualna wartość zmiennej jest niewiarygodna. W typowym zastosowaniu funkcja jest używana w warunkach stanów obiektów.

Składnia

VarIsNotGood ()

VarIsNotGood (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której status poprawności jest zwracany. W przypadku wariantu funkcji bez podania nazwy zmiennej, sprawdzany jest status zmiennej wynikającej  z kontekstu użycia.

Zobacz też

Funkcje  VaIsGood, VarStatus, VarTime

 

 

 

 

VarIsUncertain

 

Przeznaczenie

Funkcja zwraca wartość logiczną informującą czy status wartości zmiennej jest niepewny. W typowym zastosowaniu funkcja jest używana w warunkach stanów obiektów.

Składnia

VarIsUncertain()

VarIsUncertain (nazwa_zmiennej)

 

Parametry

                Nazwa_zmiennej

Nazwa zmiennej, której status poprawności jest zwracany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, sprawdzany jest status zmiennej wynikającej  z kontekstu użycia.

 

Zobacz też

                Funkcje  VarIsNotGood, VarStatus, VarTime, VarIsBad

 

 

 

VarName

 

Przeznaczenie

Zwraca nazwę zmiennej o wskazanej wartości atrybutu nazwy zastępczej (alias). Atrybut zastępczy nazwy zmiennej można skonfigurować w ustawieniach globalnych aplikacji.

Składnia

VarName(alias)

Parametry

alias

Wartość atrybutu nazwy zastępczej zmiennej

 

 

 

VarNames 

 

Przeznaczenie

Zwraca tablicę nazw zmiennych spełniających określone kryteria. Przydatna na przykład do wypełniania listy wartości parametrów obiektu Kontener wzorców.

Składnia

VarNames(criteria…)

Parametry

Criteria…

Jeden lub więcej warunków selekcji zmiennych rozdzielone przecinkami. Każdy warunek jest postaci <nazwa atrybutu>=<wartość atrybutu>. Można stosować wieloznaczniki ’*’ i ’?’.

Przykłady

VarNames("Channel=S7")

Wszystkie zmienne z kanału S7

VarNames("Channel=S7", "Channel=MODBUS")

Wszystkie zmienne z kanału S7_TCP lub MODBUS

VarNames("Linia=Linia1", "Unit=kV")

Wszystkie zmienne z linii 1 i z jednostką kV

VarNames("Name=IPC*")

Wszystkie zmienne o nazwie rozpoczynającej się od liter „IPC”

VarNames("Channel=S7", "Name=*_Min")

                Wszystkie zmienne z kanału S7 o nazwie kończącej się na „_Min”

 


 

 

VarStatus 

 

Przeznaczenie

Funkcja zwraca pełny numeryczny status wartości zmiennej zgodny ze standardem OPC. W typowym zastosowaniu funkcja jest używana w warunkach stanów obiektów.

Składnia

VarStatus ()

VarStatus (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której status wartości jest zwracany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, zwracany jest status zmiennej wynikającej  z kontekstu użycia.

Przykład

                (VarStatus()&0xc0)==0xc0

Działanie powyższego wywołania jest identyczne z użyciem funkcji VarIsGood()

Zobacz też

Funkcje  VarIsGood, VarIsNotGood, VarTime

 


 

VarStringValue

 

Przeznaczenie

Funkcja zwraca wartość tekstową  zmiennej procesowej utworzoną na podstawie formatu zdefiniowanego w bazie definicji zmiennych. Alternatywną metodą formatowania wartości jest funkcja Format.

Składnia

VarStringValue ()

VarStringValue (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której bieżącą wartość należy zwrócić w formacie tekstowym. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej, odczytywana jest wartość zmiennej wynikającej  z kontekstu użycia.

Przykład

                Concat (VarStringValue(), ” ”, Attribute(Unit))

Zwracany jest napis złożony ze sformatowanej wartości zmiennej procesowej i nazwy jednostki pobranej z bazy definicji zmiennych.

VarStringValue(z1)

Zwraca wartość zmiennej z1 w tekstowej formie. Jeżeli nie jest wymagana dodatkowa funkcjonalność, to w definicji właściwości obiektu identyczny efekt można uzyskać poprzez skrótową notację:

&z1

Zobacz też

Funkcje  Variable, Format

 



 

VarTime

 

Przeznaczenie

Funkcja zwraca czas ostatniej aktualizacji wartości zmiennej procesowej. W przypadku typowych kanałów komunikacyjnych jest to czas ostatniego odświeżenia. Czas zmiennej może się zmienić nawet wtedy, gdy nie zmienia się wartość zmiennej. W przypadku kanału wirtualnego czas aktualizacji jest czasem ostatniego zapisu zmiennej.

Czas ostatniej zmiany wartości zmiennej może być pobrany przy pomocy funkcji GetValueChangeTime.

 

Składnia

VarTime ()

VarTime (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której czas aktualizacji wartości jest zwracany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej zwracany jest czas aktualizacji zmiennej wynikającej  z kontekstu użycia.

Zobacz też

Funkcje  VaIsGood, VarIsNotGood, VarStatus, Variable, VarValueChangeTime, VarTimeUtc

 

 

 

VarTimeUtc

 

Przeznaczenie

Funkcja zwraca czas UTC ostatniej aktualizacji wartości zmiennej procesowej. W przypadku typowych kanałów komunikacyjnych jest to czas ostatniego odświeżenia. Czas zmiennej może się zmienić nawet wtedy, gdy nie zmienia się wartość zmiennej. W przypadku kanału wirtualnego czas aktualizacji jest czasem ostatniego zapisu zmiennej.

Składnia

VarTimeUtc ()

VarTimeUtc (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której czas UTC aktualizacji wartości jest zwracany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej zwracany jest czas UTC aktualizacji zmiennej wynikającej  z kontekstu użycia.

Zobacz też

Funkcje  VarIsGood, VarIsNotGood, VarStatus, Variable, VarTime

 



VarValueChangeTime

 

Przeznaczenie

Funkcja zwraca czas ostatniej zmiany wartości lub statusu zmiennej procesowej.

Składnia

VarValueChangeTime ()

VarValueChangeTime (nazwa_zmiennej)

Parametry

nazwa_zmiennej

Nazwa zmiennej, której czas zmiany wartości lub statusu jest zwracany. Można stosować sufiksowe nazwy zmiennych.  W przypadku wariantu funkcji bez podania nazwy zmiennej zwracany jest czas zmiany zmiennej wynikającej  z kontekstu użycia.

Zobacz też

Funkcje   VarTime

 


 

XOnScreen

 

Przeznaczenie

Funkcja przelicza współrzędną poziomą z wartości względnej dla wskazanego monitora na wartość bezwzględną dla pełnego pulpitu. Funkcja przeznaczona do użycia w akcjach OpenWindow i OpenDiagram. Pozwala na pozycjonowanie otwieranych okien na wybranych monitorach bez konieczności znajomości dokładnej konfiguracji systemu.

Składnia

XOnScreen( współrzędna_X, monitor)

Parametry

                współrzędna_X

Wartość względnej koordynaty poziomej.

monitor

Numer monitora, względem którego nastąpi przeliczenie koordynaty względnej współrzędna_X na koordynatę bezwzględną pulpitu. Wartość 0 oznacza użycie monitora, na którym znajduje się kursor myszki. Wartości większe od 0 to numery monitorów zgodne z numeracją systemu operacyjnego.

Przykład

OpenDiagram ( diag1, pokoj=11, null, $Dialog, XOnScreen(0,2),  YOnScreen(0,2), ”r;NoTitleBar,FixedSize”, $None )

Akcja spowoduje otwarcie okna diagramu w lewym górnym narożniku drugiego monitora.

Zobacz też

- funkcja YOnScreen

- Akcje operatorskie, akcje OpenDiagram, OpenWindow

 



 

XorColor

 

Przeznaczenie

Funkcja zwraca dopełnienie (XOR) podanego koloru.

Składnia

XorColor (kolor)

Parametry

                kolor

Parametr koloru może być wartością numeryczną pobraną z właściwości obiektu lub uzyskaną przy pomocy funkcji Color. Kolor można podać też w postaci tekstowej, jako nazwę koloru lub wartości liczbowe składowych rozdzielone znakami średnika.

Przykład

                XorColor (red)

                Wywołanie zwraca dopełnienie koloru czerwonego.

XorColor(LocalProperty("Color"))

Wywołanie zwraca dopełnienie koloru pobranego z właściwości Color  obiektu.

Zobacz też

                Funkcja Color

 


 

 

YOnScreen

 

Przeznaczenie

Funkcja przelicza współrzędną pionową z wartości względnej dla wskazanego monitora na wartość bezwzględną dla pełnego pulpitu. Ogólne zasady użycia są identyczne jak dla funkcji XOnScreen.

Składnia

YOnScreen( współrzędna_Y, monitor)

 

Parametry

               współrzędna_Y

Wartość względnej koordynaty pionowej.

monitor

Numer monitora, względem którego nastąpi przeliczenie koordynaty względnej współrzędna_Y na koordynatę bezwzględną pulpitu. Wartość 0 oznacza użycie monitora, na którym znajduje się kursor myszki. Wartości większe od 0 to numery monitorów zgodne z numeracją systemu operacyjnego.

Zobacz też

- funkcja XOnScreen

- Asix.Evo_Akcje.PDF/CHM, akcje OpenDiagram, OpenWindow