English Version
Óêðà¿íñüêà âåðñ³ÿ

Ìîäóëü ïîäñèñòåìû “Ñïåöèàëüíûå” <FLibSYS>

Ââåäåíèå

Ñïåöèàëüíûé ìîäóëü FLibSYS ïðåäîñòàâëÿåò â ñèñòåìó OpenSCADA ñòàòè÷åñêóþ áèáëèîòåêó ôóíêöèé äëÿ ðàáîòû ñ ñèñòåìîé OpenSCADA, íà óðîâíå å¸ ñèñòåìíîãî API. Ýòè ôóíêöèè ìîãóò èñïîëüçîâàòüñÿ â ñðåäå ïîëüçîâàòåëüñêîãî ïðîãðàììèðîâàíèÿ ñèñòåìû OpenSCADA äëÿ îðãàíèçàöèè íåîðäèíàðíûõ àëãîðèòìîâ âçàèìîäåéñòâèÿ.

Äëÿ àäðåñàöèè ê ôóíêöèÿì ýòîé áèáëèîòåêè ìîæíî èñïîëüçîâàòü ñòàòè÷åñêèé àäðåñ âûçîâà "Special.FLibSYS.{Func}()" èëè äèíàìè÷åñêèé "SYS.Special.FLibSYS["{Func}"].call()", "SYS.Special.FLibSYS.{Func}()". Ãäå {Func} — èäåíòèôèêàòîð ôóíêöèè â áèáëèîòåêå.

Íèæå ïðèâåäåíî îïèñàíèå êàæäîé ôóíêöèè áèáëèîòåêè. Äëÿ êàæäîé ôóíêöèè ïðîèçâîäèëàñü îöåíêà âðåìåíè èñïîëíåíèÿ. Èçìåðåíèå ïðîèçâîäèëîñü íà ñèñòåìå ñî ñëåäóþùèìè ïàðàìåòðàìè: Athlon 64 3000+ (ALTLinux 4.0(32áèò)) ïóò¸ì çàìåðà îáùåãî âðåìåíè èñïîëíåíèÿ ôóíêöèè ïðè âûçîâå å¸ 1000 ðàç. Âûáîðêà ïðîèçâîäèëàñü èç ïÿòè âû÷èñëåíèé ñ îêðóãëåíèåì äî ìåíüøåãî öåëîãî. Âðåìÿ çàêëþ÷àåòñÿ â óãëîâûå ñêîáêè è èçìåðÿåòñÿ â ìèêðîñåêóíäàõ.

1. Îáùåñèñòåìíûå ôóíêöèè

1.1. Âûçîâ êîíñîëüíûõ êîìàíä è óòèëèò îïåðàöèîííîé ñèñòåìû (sysCall)

Îïèñàíèå: Îñóùåñòâëÿåò âûçîâû êîíñîëüíûõ êîìàíä ÎÑ. Ôóíêöèÿ îòêðûâàåò øèðîêèå âîçìîæíîñòè ïîëüçîâàòåëþ OpenSCADA ïóò¸ì âûçîâà ëþáûõ ñèñòåìíûõ ïðîãðàìì, óòèëèò è ñêðèïòîâ, à òàêæå ïîëó÷åíèÿ ïîñðåäñòâîì íèõ äîñòóïà ê îãðîìíîìó îáú¸ìó ñèñòåìíûõ äàííûõ. Íàïðèìåð êîìàíäà "ls -l" âåðí¸ò äåòàëèçèðîâàííîå ñîäåðæèìîå ðàáî÷åé äèðåêòîðèè.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
test=sysCall("ls -l");
messPut("Example",0,"Example: "+test);

1.2. SQL çàïðîñ (dbReqSQL)

Îïèñàíèå: Ôîðìèðîâàíèå SQL-çàïðîñà ê ÁÄ.
Ïàðàìåòðû:

1.3. Óçåë XML (xmlNode)

Îïèñàíèå: Ñîçäàíèå îáúåêòà óçëà XML.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
//Ñîçäàíèå îáüåêòà "get" óçëà XML.
req = xmlNode("get");
//Ñîçäàíèå îáüåêòà "get" óçëà XML ñ ñîçäàíèåì àòðèáóòîâ.
//sub_DAQ/mod_ModBus/cntr_1/prm_1 — ïóòü ñîãëàñíî ñòðóêòóðå ïðîåêòà
req = xmlNode("get").setAttr("path",);

1.4. Çàïðîñ èíòåðôåéñà óïðàâëåíèÿ (xmlCntrReq)

Îïèñàíèå: Çàïðîñ èíòåðôåéñà óïðàâëåíèÿ ê ñèñòåìå ïîñðåäñòâîì XML. Îáû÷íûé çàïðîñ çàïèñûâàåòñÿ â âèäå "<get path="/OPath/%2felem"/>". Ïðè óêàçàíèè ñòàíöèè îñóùåñòâëÿåòñÿ çàïðîñ ê âíåøíåé ñòàíöèè.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
//Ïîëó÷åíèå ïðèçíàêà "Âêëþ÷åí/Âûêëþ÷åí" ïàðàìåòðà "1" êîíòðîëëåðà "1" ìîäóëÿ "ModBus".
//sub_DAQ/mod_ModBus/cntr_1/prm_1 — ïóòü ñîãëàñíî ñòðóêòóðå ïðîåêòà
req = xmlNode("get").setAttr("path",);
rez = xmlCntrReq(req);
messPut("test",0,"Çíà÷åíèå: "+req.text());

//Óñòàíîâêà ïðèçíàêà "Âêëþ÷åí" ïàðàìåòðà "1" êîíòðîëëåðà "1" ìîäóëÿ "ModBus".
req = xmlNode("set").setAttr("path",).setText(1);
rez = xmlCntrReq(req);

//Óñòàíîâêà ïðèçíàêà "Âûêëþ÷åí" ïàðàìåòðà "1" êîíòðîëëåðà "1" ìîäóëÿ "ModBus".
req = xmlNode("set").setAttr("path",).setText(0);
rez = xmlCntrReq(req);

1.5. Àðõèâ çíà÷åíèé (vArh)

Îïèñàíèå: Ïîëó÷åíèå îáúåêòà àðõèâà çíà÷åíèé (VArchObj) ïóò¸ì ïîäêëþ÷åíèÿ ê àðõèâó ïî åãî àäðåñó.
Ïàðàìåòðû:

Îáúåêò VArchObj

Ôóíêöèè:

• bool isNull() — îáúåêò íå èíèöèèðîâàí.
• int begin( int usec = 0, string archivator = "" ) — ïîëó÷åíèå âðåìåíè íà÷àëà àðõèâà ïóò¸ì âîçâðàòà ñåêóíä è ìèêðîñåêóíä usec äëÿ àðõèâàòîðà archivator.
• int end( int usec = 0, string archivator = "" ) — ïîëó÷åíèå âðåìåíè îêîí÷àíèÿ àðõèâà ïóò¸ì âîçâðàòà ñåêóíä è ìèêðîñåêóíä usec äëÿ àðõèâàòîðà archivator.
• int period( int usec = 0, string archivator = "" ) — ïîëó÷åíèå ïåðèîäè÷íîñòè àðõèâà ïóò¸ì âîçâðàòà ñåêóíä è ìèêðîñåêóíä usec äëÿ àðõèâàòîðà archivator.
• ValObj get( int sec, int usec, bool upOrd = false, string archivator = "" ) — ïîëó÷åíèå çíà÷åíèÿ èç àðõèâà íà âðåìÿ sec:usec ñ ïðèâÿçêîé ê âåðõó upOrd è äëÿ àðõèâàòîðà archivator. Ðåàëüíîå âðåìÿ ïîëó÷åííîãî çíà÷åíèÿ óñòàíàâëèâàåòñÿ â sec:usec.
• bool set( ValObj val, int sec, int usec ) — çàïèñü çíà÷åíèÿ val â áóôåð àðõèâà íà âðåìÿ sec:usec.
• bool copy( VArchObj src, int begSec, int begUSec, int endSec, int endUSec, string archivator = "" ) — êîïèðîâàíèå ÷àñòè èñõîäíîãî src àðõèâà èëè åãî áóôåðà â òåêóùèé íà÷èíàÿ ñ begSec:begUSec è çàêàí÷èâàÿ endSec:endUSec äëÿ àðõèâàòîðà archivator.
• ArrayObj FFT( int tm, real size, string archivator = "", int tm_usec = 0 ) — âûïîëíÿåò ðàçëîæåíèå â ðÿä Ôóðüå ñ ïîìîùüþ FFT àëãîðèòìà. Âîçâðàùàåòñÿ ìàññèâ àìïëèòóä ÷àñòîò äëÿ îêíà çíà÷åíèé èç àðõèâà ñ âðåìåíåì íà÷àëà tm:tm_usec (ñåêóíäû:ìèêðîñåêóíäû), ãëóáèíîé â èñòîðèþ àðõèâà size (ñåêóíä) è äëÿ àðõèâàòîðà archivator.

Ïðèìåð:

using Special.FLibSYS;
val = vArh(strPath2Sep(addr)).get(time,uTime,0,archivator);
return val.isEval() ? "Ïóñòî" : real2str(val,prec);

1.6. Áóôåð àðõèâà çíà÷åíèé (vArhBuf)

Îïèñàíèå: Ïîëó÷åíèå îáúåêòà áóôåðà àðõèâà çíà÷åíèé (VArchObj) äëÿ âûïîëíåíèÿ ïðîìåæóòî÷íûõ îïåðàöèé íàä êàäðàìè äàííûõ.
Ïàðàìåòðû:

1.7. Ââîä/Âûâîä (IO)

Îïèñàíèå: Ââîä/Âûâîä â: ôàéë, ñòðîêîâûé ïîòîê.
Ïàðàìåòðû:

IO îáúåêò

Çíà÷åíèÿ:

• valType — òèïû çíà÷åíèé:
  • "uchar", "uint8", "unsigned char";
  • "uint16", "ushort";
  • "uint32", "uint", "ulong";
  • "uint64";
  • "char", "int8", "schar", "signed char", "integer*1";
  • "int16", "short", "integer*2";
  • "int32", "int", "long", "integer*4", "integer";
  • "int64", "integer*8";
  • "float", "float32", "single", "real*4";
  • "double", "float64", "real*8", "real";
• accs — ðåæèì äîñòóïà è òèï:
  • '' — ñòðîêîâûé ïîòîê;
  • 'r[+]' — ÷òåíèå;
  • 'w[+]' — çàïèñü ñ íóëÿ;
  • 'a[+]' — äîáàâëåíèå.
• mFormat — ôîðìàò äàííûõ ìàøèíû:
  • 'n' — íàòèâíûé;
  • 'l' — LittleEndian;
  • 'b' — BigEndian.

Ñâîéñòâà:

• length — äëèíà ïîòîêà;
• pos (w) — ïîçèöèÿ ÷òåíèÿ/çàïèñè ïîòîêà.
• string (w) — ïîëíîå çíà÷åíèå ñòðîêîâîãî ïîòîêà;
• mFormat (w) — ôîðìàò äàííûõ ìàøèíû;
• stringEncode (w) — êîäèðîâêà ïîäñòðîê ôàéëà/ñòðîêè.

Ôóíêöèè:

• bool open(string name = "", string accs = "", string mFormat = "n", string enc = ""); — Îòêðûòèå íîâîãî ïîòîêà äëÿ ñòðîêè èëè ôàéëà name.
• bool close(); — Çàêðûòèå ïîòîêà.
• {string|int|real|Array[int|real]} read(string valType = "char", int cnt = -1, string mFormatEnc = "n|NoEnc"); — ×òåíèå çíà÷åíèÿ òèïà valType â êîëè÷åñòâå cnt äëÿ ôîðìàòà ìàøèíû èëè âõîäíîé êîäèðîâêè ñòðîêè mFormatEnc.
• {int|IO} {write|wr}({string|int|double|Array} vals, string valType = "char", string mFormatEnc = "n|NoEnc", int cnt = 1); — Çàïèñü çíà÷åíèÿ(èé) vals äëÿ òèïà valType äëÿ ôîðìàòà ìàøèíû èëè âõîäíîé êîäèðîâêè ñòðîêè mFormatEnc, è ïîâòîðà ñêàëÿðíûõ çíà÷åíèé â êîëè÷åñòâå cnt.

2. Ôóíêöèè äëÿ ðàáîòû ñ àñòðîíîìè÷åñêèì âðåìåíåì

2.1. Ñòðîêà âðåìåíè (tmFStr) <3047>

Îïèñàíèå: Ïðåîáðàçóåò àáñîëþòíîå âðåìÿ â ñòðîêó íóæíîãî ôîðìàòà. Çàïèñü ôîðìàòà ñîîòâåòñòâóåò POSIX-ôóíêöèè strftime.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
test=tmFStr(SYS.time(),);
messPut("Example",0,"tmFStr(): "+test);

2.2. Ïîëíàÿ äàòà (tmDate) <973>

Îïèñàíèå: Âîçâðàùàåò ïîëíóþ äàòó â ñåêóíäàõ, ìèíóòàõ, ÷àñàõ è ò.ä, èñõîäÿ èç àáñîëþòíîãî âðåìåíè â ñåêóíäàõ îò ýïîõè 1.1.1970.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
curMin=curHour=curDay=curMonth=curYear=0;
tmDate(tmTime(),0,curMin,curHour,curDay,curMonth,curYear);
messPut("test",0,"Òåêóùàÿ ìèíóòà: "+curMin);
messPut("test",0,"Òåêóùèé ÷àñ : "+curHour);
messPut("test",0,"Òåêóùèé äåíü: "+curDay);
messPut("test",0,"Òåêóùèé ìåñÿö: "+curMonth);
messPut("test",0,"Òåêóùèé ãîä: "+curYear);

2.3. Àáñîëþòíîå âðåìÿ (tmTime) <220>

Îïèñàíèå: Âîçâðàùàåò àáñîëþòíîå âðåìÿ â ñåêóíäàõ îò ýïîõè 1.1.1970 è ìèêðîñåêóíäàõ, åñëè usec óñòàíîâëåí â íåîòðèöàòåëüíîå çíà÷åíèå.
Ïàðàìåòðû:

2.4. Êîíâåðòàöèÿ âðåìåíè èç ñèìâîëüíîãî ïðåäñòàâëåíèè âî âðåìÿ â ñåêóíäàõ, îò ýïîõè 1.1.1970 (tmStrPTime) <2600>

Îïèñàíèå: Âîçâðàùàåò âðåìÿ â ñåêóíäàõ îò ýïîõè 1.1.1970, èñõîäÿ èç ñòðîêîâîé çàïèñè âðåìåíè, â ñîîòâåòñòâèè ñ óêàçàííûì øàáëîíîì. Íàïðèìåð, øàáëîíó "%Y-%m-%d %H:%M:%S" ñîîòâåòñòâóåò âðåìÿ "2006-08-08 11:21:55". Îïèñàíèå ôîðìàòà øàáëîíà ìîæíî ïîëó÷èòü èç äîêóìåíòàöèè íà POSIX-ôóíêöèþ "strptime".
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
curMin=curHour=curDay=curMonth=curYear=0;
tmDate(tmTime(),0,curMin,curHour,curDay,curMonth,curYear);
test = tmStrPTime(""+curYear+"-"+(curMonth+1)+"-"+curDay+" 9:0:0",);
messPut("Example",0,"tmStrPTime(): "+test);

2.5. Ïëàíèðîâàíèå âðåìåíè â ôîðìàòå Cron (tmCron)

Îïèñàíèå: Âîçâðàùàåò âðåìÿ ñïëàíèðîâàííîå â ôîðìàòå ñòàíäàðòà Cron íà÷èíàÿ îò áàçîâîãî âðåìåíè èëè îò òåêóùåãî åñëè áàçîâîå íå óêàçàíî.
Ïàðàìåòðû:

2.6. Ñîí (tmSleep)

Îïèñàíèå: Êîðîòêèé ñîí îò íàíîñåêóíä è äî STD_INTERF_TM (5 ñåêóíä).
Ïàðàìåòðû:

3. Ôóíêöèè ðàáîòû ñ ñîîáùåíèÿìè

3.1. Çàïðîñ ñîîáùåíèé (messGet)

Îïèñàíèå: Çàïðîñ ñèñòåìíûõ ñîîáùåíèé.
Ïàðàìåòðû:

3.2. Ãåíåðàöèÿ ñîîáùåíèÿ (messPut)

Îïèñàíèå: Ôîðìèðîâàíèå ñèñòåìíîãî ñîîáùåíèÿ.
Ïàðàìåòðû:

Ïðèìåð:

rnd_sq_gr11_lineClr="red";
Special.FLibSYS.messPut("Example",1,"Event: "+rnd_sq_gr12_leniClr);

4. Ôóíêöèè ðàáîòû ñ ñòðîêàìè

4.1. Ïîëó÷åíèå ðàçìåðà ñòðîêè (strSize) <114>

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ ïîëó÷åíèÿ ðàçìåðà.
Ïàðàìåòðû:

Ïðèìåð:

Special.FLibSYS.messPut("Example",1,"ReturnString: "+strSize("Example"));

4.2. Ïîëó÷åíèå ÷àñòè ñòðîêè (strSubstr) <413>

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ ïîëó÷åíèÿ ÷àñòè ñòðîêè.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
test=strSubstr("Example", 0, strSize("Example")-1);
messPut("Example",1,"ReturnString: "+test);

4.3. Âñòàâêà îäíîé ñòðîêè â äðóãóþ (strInsert) <1200>

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ âñòàâêè îäíîé ñòðîêè â äðóãóþ.
Ïàðàìåòðû:

4.4. Çàìåíà ÷àñòè ñòðîêè äðóãîé (strReplace) <531>

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ çàìåíû ÷àñòè ñðîêè äðóãîé ñòðîêîé.
Ïàðàìåòðû:

4.5. Ðàçáîð ñòðîêè ïî ðàçäåëèòåëþ (strParse) <537>

Îïèñàíèå: Èñïîëüçóåòñÿ â ðàçáîðå ñòðîêè ïî ðàçäåëèòåëþ.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
ExapleString="Example:123";
test=strParse(ExapleString,1,":");
messPut("Example",0,"strParse(): "+test);

4.6. Ðàçáîð ïóòè (strParsePath) <300>

Îïèñàíèå: Èñïîëüçóåòñÿ â ðàçáîðå ïóòè íà ýëåìåíòû.
Ïàðàìåòðû:

Ïðèìåð:

using Special.FLibSYS;
test=strParsePath(path,0,"/");
messPut("Example",1,"strParsePath(): "+test);

4.7. Ïóòü â ñòðîêó ñ ðàçäåëèòåëåì (strPath2Sep)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ ïðåîáðàçîâàíèÿ ïóòè â ñòðîêó ñ ðàçäåëèòåëåì.
Ïàðàìåòðû:

Ïðèìåð:

//Ïðåîáðàçóåì çíà÷åíèå "/ses_AGLKS/pg_so" àòðèáóòà "path" â çíà÷åíèå "ses_AGLKS.pg_so"
using Special.FLibSYS;
test = strPath2Sep(path);
messPut("Example",0,"path: "+path);
messPut("Example",0,"strPath2Sep(): "+test);

4.8. Êîäèðîâàíèå ñòðîêè â HTML (strEnc2HTML)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ êîäèðîâàíèÿ ñòðîêè äëÿ èñïîëüçîâàíèÿ â èñõîäíèêå HTML.
Ïàðàìåòðû:

4.9. Êîäèðîâàíèå òåêñòà â áèíàðíûé âèä (strEnc2Bin)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ êîäèðîâàíèÿ òåêñòà â áèíàðíûé âèä, èç ôîðìàòà <00 A0 FA DE>.
Ïàðàìåòðû:

4.10. Äåêîäèðîâàíèå òåêñòà èç áèíàðíîãî âèäà (strDec4Bin)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ äåêîäèðîâàíèÿ òåêñòà èç áèíàðíîãî âèäà â ôîðìàò <00 A0 FA DE>.
Ïàðàìåòðû:

4.11. Ïðåîáðàçîâàíèå âåùåñòâåííîãî â ñòðîêó (real2str)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ ïðåîáðàçîâàíèÿ âåùåñòâåííîãî â ñòðîêó.
Ïàðàìåòðû:

4.12. Ïðåîáðàçîâàíèå öåëîãî â ñòðîêó (int2str)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ ïðåîáðàçîâàíèÿ öåëîãî â ñòðîêó.
Ïàðàìåòðû:

4.13. Ïðåîáðàçîâàíèå ñòðîêè â âåùåñòâåííîå (str2real)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ ïðåîáðàçîâàíèÿ ñòðîêè â âåùåñòâåííîå.
Ïàðàìåòðû:

4.14. Ïðåîáðàçîâàíèå ñòðîêè â öåëîå (str2int)

Îïèñàíèå: Èñïîëüçóåòñÿ äëÿ ïðåîáðàçîâàíèÿ ñòðîêè â öåëîå.
Ïàðàìåòðû:

4.15. Öèêëè÷åñêèé Èçáûòî÷íûé Êîä (CRC)

Îïèñàíèå: Ðåàëèçàöèÿ Öèêëè÷åñêîãî Èçáûòî÷íîãî Êîäà äëÿ äëèí 8-64 áèò.
Ïàðàìåòðû:

5. Ôóíêöèè ðàáîòû ñ âåùåñòâåííûì

5.1. Ðàçäåëåíèå float íà ñëîâà (floatSplitWord) <56>

Îïèñàíèå: Ðàçäåëåíèå float (4 áàéòîâ) íà ñëîâà (2 áàéòà).
Ïàðàìåòðû:

5.2. Îáúåäèíåíèå float èç ñëîâ (floatMergeWord) <70>

Îïèñàíèå: Îáúåäèíåíèå float (4 áàéòîâ) èç ñëîâ (2 áàéòà).
Ïàðàìåòðû:

6. API ïîëüçîâàòåëüñêîãî ïðîãðàììèðîâàíèÿ

Íåêîòîðûå îáúåêòû ìîäóëÿ ïðåäîñòàâëÿþò ôóíêöèè ïîëüçîâàòåëüñêîãî ïðîãðàììèðîâàíèÿ.

Îáúåêò "Áèáëèîòåêà ôóíêöèé" (SYS.Special.FLibSYS)

• ElTp {funcID}(ElTp prm1, ...) — âûçîâ ôóíêöèè áèáëèîòåêè {funcID}. Âîçâðàùàåò ðåçóëüòàò âûçûâàåìîé ôóíêöèè.

Îáúåêò "Ïîëüçîâàòåëüñêàÿ ôóíêöèÿ" (SYS.Special.FLibSYS["funcID"])

• ElTp call(ElTp prm1, ...) — âûçîâ äàííîé ôóíêöèè ñ ïàðàìåòðàìè <prm{N}>. Âîçâðàùàåò ðåçóëüòàò âûçûâàåìîé ôóíêöèè.

Ññûëêè