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

'''Public methods:'''
* ''TVArchive( const string &id, const string &db, TElem *cf_el );'' — Initializing constructor of the archive, where ''id'' — archive ID, ''db'' — DB for storage and ''cf_el'' — DB structure of the values' archives.
* ''string id( );'' — Archive's ID.
* ''string name( );'' — Archive's name.
* ''string dscr( );'' — Archive's description.
* ''SrcMode srcMode( );'' — Linkage mode with the data source.
* ''AutoHD<TVal> srcPAttr( bool force = false, const string &ipath = "" );'' — Connect to associated attribute of parameter of data source.
* ''string srcData( );'' — Parameters of the data source, in the case of access mode to the parameter this is the address of the parameter.
* ''bool toStart( );'' — Sign: "Start the archive when starting the system".
* ''bool startStat( );'' — Status: "Archive started".
* ''string DB( bool qTop = false ) const;'' — Storage address of the values' archive, ''qTop'' for the storage queue top.
* ''string tbl( );'' — DB table of the values' archive.
* ''string fullDB( bool qTop = false );'' — Full name of the storage table of the values' archive, ''qTop'' for the storage queue top.
* ''int64_t end( const string &arch = ARCH_BUF );'' — End of the archive time at whole (arch="") or the specified archiver, buffer (arch="<bufer>").
* ''int64_t begin( const string &arch = ARCH_BUF );'' — Start of the archive time at whole (arch="") or the specified archiver, buffer (arch="<bufer>").
* ''int64_t period( const string &arch = ARCH_BUF );'' — Periodicity of the archive buffer or the specified archiver (microseconds).
* ''TFld::Type valType( bool full = false );'' — Type of the archived value. ''full'' — request full type, else only generic.
* ''bool hardGrid( );'' — Using of the hard grid in the archive buffer.
* ''bool highResTm( );'' — Using of the high-resolution time in the archive buffer (microseconds).
* ''bool fillLast( );'' — Fill pass points to a last value. Mostly the pass values fill by EVAL but sometime the source's data periodicity greater to the archive's one and it is normal.
* ''int size( );'' — Archive buffer size (units).
* ''void setName( const string &inm );'' — Setting the name of the archive.
* ''void setDscr( const string &idscr );'' — Setting the description of the archive.
* ''void setSrcMode( SrcMode vl = SaveCur, const string &isrc = "<*>", bool noex = false );'' — Setting the linkage mode with the data source.
* ''void setToStart( bool vl );'' — Setting the sign: "Start the archive when starting the system".
* ''void setDB( const string &vl, bool qTop = false );'' — Setting the storage address of the values' archive, ''qTop'' for the storage queue top.
* ''void setValType( TFld::Type vl );'' — Setting the type of the archived value.
* ''void setHardGrid( bool vl );'' — Setting the using of the hard grid in the archive buffer.
* ''void setHighResTm( bool vl );'' — Setting of using of the high-resolution time in the archive buffer (microseconds).
* ''void setFillLast( bool vl );'' — Set to fill pass points to a last value.
* ''void setSize( int vl );'' — Setting of the archive buffer size (units).
* ''void setPeriod( int64_t vl );'' — Setting the periodicity of the archive buffer.
* ''void start( );'' — Start of the archive.
* ''void stop( bool full_del = false );'' — Stop of the archive with it's completely deleting ''full_del''.
* ''TVariant getVal( int64_t *tm = NULL, bool up_ord = false, const string &arch = "", bool onlyLocal = false );'' — Request of the single value for the time ''tm'' and with the sign of the moving to the top ''up_ord'' from the specified archiver ''arch'', buffer (arch = "<bufer>") or from all archivers in the course of falling quality (arch =""). To process the request only by the local station ''onlyLocal'' is set.
* ''void getVals( TValBuf &buf, int64_t beg = 0, int64_t end = 0, const string &arch = "", int limit = 100000, bool onlyLocal = false );'' — Request of the values' frame ''buf'' for the time from ''beg'' to ''end'' from the specified archiver ''arch'', buffer (arch = "<bufer>") or from the all archivers in the course of falling quality (arch =""), limiting the size of the request ''limit'' of the record. To request only the local archives, without compensation gaps in the archives from the backup stations, set ''onlyLocal''.
* ''void setVals( TValBuf &buf, int64_t beg, int64_t end, const string &arch );'' — Set of the values' frame ''buf'' for the time from ''beg'' to ''end'' to the specified archiver ''arch'', buffer (arch = "<bufer">) or to all archivers (arch ="").
* ''void getActiveData( const int64_t &tm = 0 );'' — To interrogate the data source with forcing time-stamp to ''tm'' (not zero). Is used for periodic data acquisition by the active archives in the subsystem.
* ''void archivatorList( vector<string> &ls );'' — List of archivers which serves the archive.
* ''bool archivatorPresent( const string &arch );'' — Check the archiver for it's servicing of the given archive.
* ''void archivatorAttach( const string &arch );'' — Connecting the archive to be served by the specified archiver.
* ''void archivatorDetach( const string &arch, bool full = false );'' — Disabling this archive from the servicing of the specified archiver.
* ''void archivatorSort( );'' — Sort of the serving archivers in the order of decreasing quality.
* ''string makeTrendImg( int64_t beg, int64_t end, const string &arch, int hsz = 650, int vsz = 230 );'' — Building of the (pdf) image of the trend for the specified amount of time ''beg, end'' and for this archiver ''arch''.
* ''TArchiveS &owner( ) const;'' — Subsystem "Archives" - the owner of the archive of values.