OpenSCADAWiki: Home Page En/Doc/API/part15 ...

15. XML in the OpenSCADA system (XMLNode)

XML in the OpenSACDA system is represented by the object of the XML-tag - XMLNode.

15.1. XML-tag (XMLNode)

Data:
Îïöèè ôóíêöèè ãåíåðàöèè XML-ôàéëà (enum - XMLNode::SaveView):

• XMLNode::BrOpenPrev -- âñòàâëÿòü êîíåö ñòðîêè ïåðåä òåãîì îòêðûòèÿ;
• XMLNode::BrOpenPast -- âñòàâëÿòü êîíåö ñòðîêè ïîñëå òåãà îòêðûòèÿ;
• XMLNode::BrClosePast -- âñòàâëÿòü êîíåö ñòðîêè ïîñëå òåãà çàêðûòèÿ;
• XMLNode::BrTextPast -- âñòàâëÿòü êîíåö ñòðîêè ïîñëå òåêñòà òåãà;
• XMLNode::BrPrcInstrPast -- âñòàâëÿòü êîíåö ñòðîêè ïîñëå âû÷èñëèòåëüíîé èíñòðóêöèè;
• XMLNode::BrAllPast -- âñòàâëÿòü êîíåö ñòðîêè ïîñëå âñåõ ýëåìåíòîâ.
• XMLNode::XMLHeader -- âñòàâëÿòü xml-çàãîëîâîê ñ âåðñèåé.
• XMLNode::InclNode -- ñëóæåáíûé ôëàã äëÿ èäåíòèôèêàöèè êîðíÿ XML-äåðåâà ïðè ñîõðàíåíèè.

Ïóáëè÷íûå ìåòîäû:

• XMLNode( const string &name = "" ); -- Èíèöèàëèçàöèÿ òåãà ñ èìåíåì <name>.
• XMLNode &operator=( XMLNode &prm ); -- Êîïèðîâàíèå âåòêè XML-äåðåâà èç <prm>.
• string name( ) const; -- Èìÿ òåãà.
• XMLNode* setName( const string &s ); -- Óñòàíîâêà èìåíè òåãà â <s>.
• string text( ) const; -- Òåêñò òåãà.
• XMLNode* setText( const string &s ); -- Óñòàíîâêà òåêñòà òåãà â <s>.
• void attrList( vector<string> & list ) const; -- Ñïèñîê àòðèáóòîâ <list> â òåãå.
• XMLNode* attrDel( const string &name ); -- Óäàëåíèå àòðèáóòà <name>.
• void attrClear( ); -- Î÷èñòêà àòðèáóòîâ òåãà.
• string attr( const string &name ) const; -- Ïîëó÷åíèå àòðèáóòà <name>.
• XMLNode* setAttr( const string &name, const string &val ); -- Óñòàíîâêà/ñîçäàíèå àòðèáóòà <name> ñî çíà÷åíèåì <val>.
• void prcInstrList( vector<string> &list ) const; -- Ñïèñîê èñïîëíèìûõ èíñòðóêöèé <list> â òåãå.
• void prcInstrDel( const string &target ); -- Óäàëåíèå èñïîëíèìîé èíñòðóêöèè <target> èç òåãà.
• void prcInstrClear( ); -- Î÷èñòêà èíñòðóêöèé òåãà.
• string prcInstr( const string &target ) const; -- Ïîëó÷åíèå èñïîëíèìîé èíñòðóêöèè <target> òåãà.
• XMLNode* setPrcInstr( const string &target, const string &val ); -- Óñòàíîâêà èñïîëíèìîé èíñòðóêöèè òåãà <target>.
• void load( const string &vl ); -- Çàãðóçêà/ïàðñèíã XML-ôàéëà.
• string save( unsigned char flgs = 0 ); -- Ñîõðàíåíèå/ñîçäàíèå XML-ôàéëà ñ ïàðàìåòðàìè ôîðìàòèðîâàíèÿ <flgs>.
• XMLNode* clear( ); -- Î÷èñòêà òåãà (ðåêóðñèâíî, âêëþ÷àÿ âñå âëîæåíèÿ).
• int childSize( ) const; -- Êîëè÷åñòâî âëîæåííûõ òåãîâ.
• void childAdd( XMLNode *nd ); -- Äîáàâëåíèå âëîæåííîãî òåãà.
• XMLNode* childAdd( const string &name = "" ); -- Äîáàâëåíèå âëîæåííîãî òåãà.
• int childIns( unsigned id, XMLNode *nd ); -- Âñòàâêà âëîæåííîãî òåãà â ïîçèöèþ <id>.
• XMLNode* childIns( unsigned id, const string &name = "" ); -- Âñòàâêà âëîæåííîãî òåãà ñ èìåíåì <name> â ïîçèöèþ <id>.
• void childDel( const unsigned id ); -- Óäàëåíèå âëîæåííîãî òåãà <id>.
• void childDel( XMLNode *nd ); -- Óäàëåíèå âëîæåííîãî òåãà ïî åãî àäðåñó <nd>.
• void childClear( const string &name = "" ); -- Î÷èñòêà âëîæåííîãî òåãà <name>.
• XMLNode* childGet( const int, bool noex = false ) const; -- Ïîëó÷åíèå âëîæåííîãî òåãà ïî ïîðÿäêîâîìó íîìåðó.
• XMLNode* childGet( const string &name, const int numb = 0, bool noex = false ) const; -- Ïîëó÷åíèå âëîæåííîãî <numb> ïîðÿäêîâîãî òåãà ïî èìåíè òåãà <name>. <noex> óêàçûâàåò íà çàïðåò ãåíåðàöèè èñêëþ÷åíèÿ â ñëó÷àå îòñóòñòâèÿ òåãà.
• XMLNode* childGet( const string &attr, const string &name, bool noex = false ) const; -- Ïîëó÷åíèå âëîæåííîãî <numb> ïîðÿäêîâîãî òåãà ïî çíà÷åíèþ <name> àòðèáóòà <attr>. <noex> óêàçûâàåò íà çàïðåò ãåíåðàöèè èñêëþ÷åíèÿ â ñëó÷àå îòñóòñòâèÿ òåãà.
• XMLNode* parent( ); -- Ðîäèòåëüñêèé òåã äàííîãî òåãà.