Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Add - metoda objektu PmaSequencer

Popis:
Zařadí novou položku do fronty.
Syntaxe:
Boolean Add(Variant Timeout, Variant Val1, [Variant Val2], [Variant Val3], [String Params])
Parametry:
Timeout(Variant) Určuje kdy se položka uvolní a tedy kdy je vyvolána událost onStep (pokud k tomu nedojde dřív metodou Release).
 
Pokud je to číselná hodnota (typu Integer, Long, Single, atd.), pak je to počet sekund, za jak dlouho uvolnit položku (0=nečeká se, -1=čeká se nekonečně dlouho).
Význam této hodnoty závisí na nastavení konfigurátoru "Typ spouštění položek" v kartě "Sequencer":
Pokud je nastaveno "0 = položky se spouští nezávisle, každá podle svého timeoutu", pak je to čas od volání metody Add.
Pokud je nastaveno "1 = položky se spouští postupně, timeout je prodleva mezi nimi", pak je to čas od uvolnění poslední položky. V tom případě zde zadaný timeout musí být menší nebo rovno 21 dnů (tzn. 1814400 sekund).
Případná změna času počítače nemá vliv na timeout položek, tzn. počet sekund do spuštění bude dodržen.
 
Pokud je to hodnota typu Date, pak je to datum a čas, kdy uvolnit položku. Nelze zadávat typ Date pokud je nastaveno "1 = položky se spouští postupně, timeout je prodleva mezi nimi". Případná změna času počítače nemá vliv na absolutní čas spuštění položek, položky budou spuštěny v zadaném absolutním čase (už podle nového času). Například položka, která měla být spuštěna ve 14:00:00, bude spuštěna ve 14:00:00 nového času.
Val1(Variant) 1. hodnota položky. Tuto hodnotu lze nastavit pro další použití v události onStep.
Val2[nepovinné] (Variant) 2. hodnota položky. Použití viz Val1
Val3[nepovinné] (Variant) 3. hodnota položky. Použití viz Val1
Params[nepovinné] (String) Dodatečné parametry vytvářené položky. Údaje jsou zde ve formátu KeyVal, například thread:main;.
"thread:xxx;" - Určuje vlákno (thread), ve kterém je vyvolána událost onStep pro tuto položku. Volba má ale smysl pouze pokud objekt PmaSequencer používá pracovní vlákno (viz konfigurátor "Použité vlákno (thread)"), v jiném případě je ignorována. Použití této volby viz PmaSequencer a Jak spouštět vybrané skripty v jiném vlákně (threadu).
"thread:work;" (přednastaveno) - událost je vyvolána v pracovním vlákně
"thread:main;" - událost je vyvolána v hlavním vlákně
Vrácená hodnota:
true - Položka se zařadila
false - Položka se nezařadila. Důvod: pokud překročen maximální počet položek (viz vlastnost MaxSize) nebo špatně nastaven parametr Timeout. Toto se zapíše do globálních chyb v INFO systému.
Viz také:
Příklad1:
Do objektu přidáme položku, která se uvolní za 10 sekund:
JavaScriptVBScriptVyber a zkopíruj do schránky

var oSeq = pMe.Pm("/Sequencer");
oSeq.Add(10, "ID1", 1);

Historie:
Pm9.00.08: Metoda Params vracela ve verzích PROMOTIC 9.0.X chybně vždy false.
Pm8.00.03: Nový parametr Params
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice