From OpenSCADAWiki
Revision as of 11:49, 14 September 2021 by FuzzyBot (Talk | contribs) (Importing a new version from external source)
Public methods:
- TMArchivator( const string &id, const string &db, TElem *cf_el ); — Initializing constructor of the messages' archiver with the ID id, for the storage in the database db with the structure <cf_el>.
- string id( ); — Archiver's ID.
- string workId( ); — Working identifier, it includes the name of the module.
- string name( ); — Archiver's name.
- string dscr( ); — Archiver's description.
- bool toStart( ); — The sign "To start the archiver".
- bool startStat( ); — Archivers' status "Run".
- string &addr( ) const; — Address of the archiver's storage.
- int &level( ); — The level of messages, serviced by the archiver.
- void categ( vector<string> &list ); — Categories (templates) of messages, serviced by the archiver.
- string DB( bool qTop = false ) const; — Storage address of the archiver, qTop for the storage queue top.
- string tbl( ); — Table address of the archiver's DB.
- string fullDB( bool qTop = false ); — The full table address of the archiver's storage, qTop for the storage queue top.
- void setName( const string &vl ); — Setting the archiver's name.
- void setDscr( const string &vl ); — Setting the archiver's description.
- void setToStart( bool vl ); — Setting the sign "To start the archiver".
- void setAddr( const string &vl ); — Setting the address of the archiver's storage.
- void setLevel( int lev ); — Setting the level of messages, serviced by the archiver.
- void setDB( const string &vl, bool qTop = false ); — Setting the storage address of the archiver, qTop for the storage queue top.
- time_t redntTm( ); — Time of the last redundancy operation.
- bool redntUse( ); — Getting the data from the backup station mode.
- void setRedntUse( bool vl ); — Changing of the getting the data from the backup station mode.
- Redundant redntMode( ); — Redundancy mode ("<high>", "<low>", "<optimal>", {ForceStation}), enabling.
- void setRedntMode( Redundant vl ); — Setting of the redundancy mode, enabling.
- string redntRun( ); — Configuration of the preferred execution.
- void setRedntRun( const string &vl ); — Setting the configuration of the preferred execution.
- virtual void redntDataUpdate( ); — An operation of the data receiving from the backup station execution. It is called automatically by the service procedure of the redundancy scheme of the subsystem.
- virtual void start( ); — Start of the archiver.
- virtual void stop( ); — Stop of the archiver.
- virtual time_t begin( ); — The beginning of the archive of the specified archiver.
- virtual time_t end( ); — The end of the archive of the specified archiver.
- virtual bool put( vector<TMess::SRec> &mess, bool force = false ); — Place the group of messages in the messages' archive of the specified archivator. Return "true" on successful operation. force for direct writing to the archivator omit the redundancy.
- virtual time_t get( time_t bTm, time_t eTm, vector<TMess::SRec> &mess, const string &category = "", char level = 0, time_t upTo = 0 ); — Get the messages from the archive of the specified archiver for the specified filter parameters. Return time of the request stop, useful for continue from the point.
- TTypeArchivator&owner( ) const; — Archiver's type – the owner of the messages' archiver.