Difference between revisions of "Translations:Documents/API/117/en"

'''Public methods:'''
* ''TVArchivator( const string &id, const string &db, TElem *cf_el );'' — Initializing constructor of the values' 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.
* ''string addr( ) const;'' — Address of the archiver's storage.
* ''double valPeriod( );'' — Frequency of values of the archiver (microseconds).
* ''int archPeriod( );'' — Frequency of the values' archiving by the archiver. Time after which the archiver makes archiving of the frame of values from the archive's buffer.
* ''int selPrior( );'' — Selection priority for mode "All" archivers.
* ''bool toStart( );'' — The sign "To start the archiver".
* ''bool startStat( );'' — Archivers' status "Run".
* ''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 &inm );'' — Setting the archiver's name.
* ''void setDscr( const string &idscr );'' — Setting the archiver's description.
* ''void setAddr( const string &vl );'' — Setting the address of the archiver's storage.
* ''void setValPeriod( double iper );'' — Setting the frequency of values of the archiver (microseconds).
* ''void setArchPeriod( int iper );'' — Setting the frequency of the values' archiving by the archiver. Time after which the archiver makes archiving of the frame of values from the archive's buffer.
* ''void setSelPrior( int vl );'' — Set selection priority for mode "All" archivers.
* ''void setToStart( bool vl );'' — Setting the sign "To start the archiver".
* ''void setDB( const string &vl, bool qTop = false );'' — Setting the storage address of the archiver, ''qTop'' for the storage queue top.
* ''virtual void start( );'' — starting the archiver object, the archiver starts for receiving values and placing them into the storage.
* ''virtual void stop( bool full_del = false );'' — stopping the archiver object with the ability to completely remove its data from the storage at ''full_del''.
* ''void archiveList( vector<string> &ls );'' — The archive's list, serviced by the archiver.
* ''bool archivePresent( const string &iid );'' — Check for the servicing of the specified archive by the specified archiver.
* ''TTypeArchivator &owner( ) const;'' — Archiver's type – the owner of the values' archiver.