EDA_SetPeriods

EDA_SetPeriods

Funkcia vytvorí (existujúcu prepíše) alebo zruší definíciu periód. Perióda je definovaná pomocou začiatočného času, od ktorého sa potom aplikuje daný počet základných krokov. V prípade, že krok je definovaný ako násobok sekúnd, pracuje sa vždy v monotónnom čase, inak (násobok dní/mesiacov) sa pracuje v lokálnom čase.

Parameter časové pásmo slúži na správnu identifikáciu hraníc dňa a prechodov medzi zimným a letným časom.

Takto definovanú periódu je možné použiť na načítanie vektora alebo v ktorejkoľvek EDA-L funkcii pracujúcej s krokom - ako parameter krok sa zadá textový kód periódy. Pretože definícia periódy v sebe už zahŕňa časové pásmo, aj prípadný začiatok dňa či týždňa, sú tieto parametre (vo funkciách, ktoré tieto parametre obsahujú) pri použití preddefinovanej periódy ignorované.

Upozornenie: Nie je možné vytvoriť periódy so začiatkom v dni/čase, ktorý neexistuje v každom ďalšom krokom danom intervale - teda 29-31 deň mesiaca, ak každý ďalší mesiac nemá aspoň toľko dní, resp. v čase posunu zo zimného na letný čas.

Deklarácia

%EDA_SetPeriods( REC in _periods, INT out _errorCode );

Parametre

 

Parameter

Dátový typ

Typ

Popis

1

periods

RECORD

IN

Štruktúra definície periód s príznakom vytvorenia alebo zrušenia periódy (minimálne 7-stĺpcová).

2

errorCode

INT

OUT

Návratový kód.

Popis štruktúry definície periód:

 

Parameter

Dátový typ

Popis

1

code

TEXT(64)

Unikátny kód periódy.

2

title

TEXT (64)

Názov periódy, ktorý sa zobrazuje užívateľovi.

3

beginTime 

TIME

Začiatočný čas, od ktorého sa aplikuje krok.

4

timeZone

INT

Časové pásmo zadané ako offset od UTC času.

5

stepBase

INT

Základ kroku periódy.

6

stepCount

INT

Kladný násobok základného kroku.

7

create

BOOL

Príznak vytvorenia (@TRUE) alebo zrušenia (@FALSE) periódy. V prípade zrušenia periódy je braný do úvahy len parameter code, ostatné sú ignorované.

Príklad použitia