From OpenSCADAWiki
Jump to: navigation, search

Public methods:

  • int subVer( ); — Subsystem's version.
  • void inTrList( vector<string> &ls ); — Full list of input transports.
  • void outTrList( vector<string> &ls ); — Full list of output transports.
  • AutoHD<TTransportOut> outAt( const string &addr ); — Unified function of the output transport generic obtaining at that address addr in the form:
"{TrModule}.[out_]{TrID}[:{TrAddr}]" — typical output with automatic creation TrID at it missing and allowing TrAddr;
"{TrModule}.in_{TrID}:{RemConId}" — initiative input with the connection identifier in RemConId.
  • string extHostsDB( ); — Database for the storing the list of external hosts.
  • void extHostList( const string &user, vector<ExtHost> &list, bool andSYS = false, int upRiseLev = -1, const string &lang = "" ); — The list of external hosts for user, include system andSYS, the uprising level upRiseLev (-1 - starting from the host's entry level) and for the language lang.
  • ExtHost extHostGet( const string &user, const string &id, bool andSYS = false ); — Getting the information object from the external host id on behalf of the user user, include system andSYS ( "*" — for the system hosts).
  • ExtHost extHostSeek( const string &id, int lev ); — Direct hosts scanning at the station id and the level lev. The scanning starts at lev in 0 and stops at return empty host ID.
  • AutoHD<TTransportOut> extHost( TTransportS::ExtHost host, const string &pref = "" ); — Creation - request of the output transport to service the external host host with the prefix of the identification of the system node pref.
  • void extHostSet( const ExtHost &host, bool andSYS = false ); — Setting of the external host/station host, include system andSYS.
  • void extHostDel( const string &user, const string &id, bool andSYS = false ); — Deleting of the external host/station id on behalf of the user user, include system andSYS ( "*" — for the system hosts).
  • int cntrIfCmd( XMLNode &node, const string &senderPref, const string &user = "" ); — Transfer of the control area request of the OpenSCADA node to the remote station.
  • void subStart( ); — Start of the subsystem.
  • void subStop( ); — Stop of the subsystem.
  • TElem &inEl( ); — DB structure of the input transports.
  • TElem &outEl( ); — DB structure of the output transports.
  • AutoHD<TTypeTransport> at( const string &id ) const; — Addressing/connection to the type of transport id.
  • static TVariant prm( string &cnt, const string &id, const TVariant &val = TVariant(), bool toWr = false ); — Getting for value the addition parameter id with default one val, or setting to the value val at toWr. The additional parameters can store the connection time parameters at pointing id in the form "{id}\n{SRC}[\n{NAME}[\n{HELP}]]". The additional parameters stored in the XML-container cnt and this function used from TTransportIn::prm() and TTransportOut::prm() for the configuration field "A_PRMS" as a container.
  • static string cntrCmdPrm( XMLNode *opt, const string &path, const string &cnt ); — Providing the OpenSCADA Control Interface in opt and path for the addition parameters in the input container. Changed container content is returned.
Retrieved from "http://oscada.org/wiki/index.php?title=Translations:Documents/API/132/en&oldid=81164"