fwConfigs
Functions | Variables
fwArchive config library

The library to handle WinCC OA archiving. More...

Functions

 fwArchive_deleteMultiple (dyn_string dpes, dyn_string &exceptionInfo)
 
 fwArchive_deleteMany (dyn_string dpes, dyn_string &exceptionInfo)
 
 fwArchive_delete (string dpe, dyn_string &exceptionInfo)
 
 _fwArchive_setOrConfig (dyn_string dpes, bool startArchiving, dyn_string archiveClassDpName, dyn_int archiveType, dyn_int smoothProcedure, dyn_float deadband, dyn_float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, bool configureOnly=FALSE)
 
 fwArchive_setMultiple (dyn_string dpes, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, bool activateArchiving=TRUE)
 
 fwArchive_setMany (dyn_string &dpes, dyn_string &archiveClassName, dyn_int &archiveType, dyn_int &smoothProcedure, dyn_float &deadband, dyn_float &timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, bool activateArchiving=TRUE, bool configureOnly=false)
 
 fwArchive_set (string dpe, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE)
 
 fwArchive_configMultiple (dyn_string dpes, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE)
 
 fwArchive_configMany (dyn_string dpes, dyn_string archiveClassName, dyn_int archiveType, dyn_int smoothProcedure, dyn_float deadband, dyn_float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE)
 
 fwArchive_config (string dpe, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE)
 
 fwArchive_getMany (dyn_string &dpes, dyn_bool &configExists, dyn_string &archiveClass, dyn_int &archiveType, dyn_int &smoothProcedure, dyn_float &deadband, dyn_float &timeInterval, dyn_bool &isActive, dyn_string &exceptionInfo)
 
 fwArchive_get (string dpe, bool &configExists, string &archiveClass, int &archiveType, int &smoothProcedure, float &deadband, float &timeInterval, bool &isActive, dyn_string &exceptionInfo)
 
 fwArchive_startMultiple (dyn_string dpes, dyn_string &exceptionInfo)
 
 fwArchive_start (string dpe, dyn_string &exceptionInfo)
 
 fwArchive_stopMultiple (dyn_string dpes, dyn_string &exceptionInfo)
 
 fwArchive_stop (string dpe, dyn_string &exceptionInfo)
 
 _fwArchive_set (string dpe, bool startArchive, string archiveClassDpName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo)
 
 _fwArchive_setMany (dyn_string dpes, bool startArchive, dyn_string archiveClassDpName, dyn_int archiveType, dyn_int smoothProcedure, dyn_float deadband, dyn_float timeInterval, dyn_string &exceptionInfo, bool configureOnly=false)
 
 fwArchive_convertClassNameToDpName (string archiveClassName, string &archiveDpName, dyn_string &exceptionInfo, string searchSystem="")
 
 fwArchive_convertDpNameToClassName (string archiveDpName, string &archiveClassName, dyn_string &exceptionInfo)
 
 fwArchive_checkClass (string archiveClassDpName, dyn_string dpesToAdd, dyn_string &exceptionInfo)
 
 fwArchive_getClassState (string archiveClassDpName, int &archiveState, string &archiveStateText, dyn_string &exceptionInfo)
 
 fwArchive_getClassStatistics (string archiveClassDpName, int &currentDpes, int &dpesAfterFileSwitch, int &maximumDpes, dyn_string &exceptionInfo, bool refreshClass=TRUE)
 
 fwArchive_getClassFreeSpace (string archiveClassDpName, int &freeSpace, dyn_string &exceptionInfo, bool refreshClass=TRUE)
 
 fwArchive_checkDpesArchived (string archiveClassDpName, dyn_string dpesToCheck, dyn_bool &areArchived, dyn_string &exceptionInfo)
 
 _fwArchive_flagEndOfRefresh (string dpe, int value)
 
 fwArchive_convertDpNameToRDBClassName (string rdbArchiveGroupDpName, string &rdbClassName, dyn_string &exceptionInfo)
 
 fwArchive_convertRDBClassNameToDpName (string rdbClassName, string &rdbArchiveGroupDpName, dyn_string &exceptionInfo, string searchSystem="")
 
 fwArchive_getAllValueArchiveClasses (dyn_string readFromSystems, dyn_string &archiveClasses, dyn_string &archiveClassDps, dyn_string &exceptionInfo)
 
 fwArchive_getAllRDBArchiveClasses (dyn_string readFromSystems, dyn_string &archiveClasses, dyn_string &archiveGroupDps, dyn_string &exceptionInfo, bool includeAlertGroups=FALSE)
 

Variables

const int fwArchive_CLASS_STOPPED = 0
 
const int fwArchive_CLASS_ONLINE = 1
 
const int fwArchive_CLASS_SWAPPED_OUT = 2
 
const int fwArchive_CLASS_DELETED = 3
 
const string fwArchive_VALARCH_CLASS_DPTYPE = "_ValueArchive"
 
const string fwArchive_RDB_CLASS_DPTYPE = "_RDBArchiveGroups"
 
const int fwArchive_MANAGER_NUMBER_OFFSET = 2
 
bool fwArchive_REFRESH_IN_PROGRESS = FALSE
 

Detailed Description

The library to handle WinCC OA archiving.

Since
Creation Date 28/03/2000
Author
Marco Boccioli, Piotr Golonka, Oliver Holme, Niko Karlson, Herve Milcent, Sascha Schmeling, Fernando Varela
Modification History

Description

The fwArchiveConfig library provides a set of functions to configure and manipulate the archiving. Both, the value archive as well as Oracle RDB Archive are supported.

Constants used by fwArchiveConfig library

Constants for archive type

The following WinCC OA builtin constants (of type int) are used to specify the type of archiving:

Constants for archive smoothing procedure

The following WinCC OA builtin constants (of type int) are used in the functions to refer to various smoothing procedures:

Function Documentation

fwArchive_deleteMultiple ( dyn_string  dpes,
dyn_string &  exceptionInfo 
)
Deletes the archive config for the given data point elements
Parameters
dpeslist of data point elements
exceptionInfodetails of any errors are returned here
fwArchive_deleteMany ( dyn_string  dpes,
dyn_string &  exceptionInfo 
)
Deletes the archive config for the given data point elements
Parameters
dpeslist of data point elements
exceptionInfodetails of any errors are returned here
fwArchive_delete ( string  dpe,
dyn_string &  exceptionInfo 
)
Deletes the archive config for the given data point element
Parameters
dpedata point element
exceptionInfodetails of any errors are returned here
_fwArchive_setOrConfig ( dyn_string  dpes,
bool  startArchiving,
dyn_string  archiveClassDpName,
dyn_int  archiveType,
dyn_int  smoothProcedure,
dyn_float  deadband,
dyn_float  timeInterval,
dyn_string &  exceptionInfo,
bool  checkClass = TRUE,
bool  configureOnly = FALSE 
)
Sets archive config for the given dp elements with the option to start or not start the archiving
Parameters
dpeslist of data point elements
startArchivingtrue in order to start the archive immediately, false in order to ONLY configure it
archiveClassDpNamethe dp name of the archiving class to be used
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
checkClassOptional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks.
configureOnly(optional, default false); if set to true, the archiving will be started/stopped according to the startArchive parameter otherwise only configuration will be changed (e.g. for smoothing); for all DPEs that do not have the archiving configured, the value of startArchive parameter will be taken.
fwArchive_setMultiple ( dyn_string  dpes,
string  archiveClassName,
int  archiveType,
int  smoothProcedure,
float  deadband,
float  timeInterval,
dyn_string &  exceptionInfo,
bool  checkClass = TRUE,
bool  activateArchiving = TRUE 
)
Sets archive config for the given dp elements and start the archiving
Parameters
dpeslist of data point elements
archiveClassNamename of the archive class for the config (not archive class dp name)
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
checkClassOptional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks.
activateArchivingOptional parameter. Default value TRUE. Determines if archiving should be activated.
fwArchive_setMany ( dyn_string &  dpes,
dyn_string &  archiveClassName,
dyn_int &  archiveType,
dyn_int &  smoothProcedure,
dyn_float &  deadband,
dyn_float &  timeInterval,
dyn_string &  exceptionInfo,
bool  checkClass = TRUE,
bool  activateArchiving = TRUE,
bool  configureOnly = false 
)
Sets archive config for the given dp elements and start the archiving
Parameters
dpeslist of data point elements. Passed as reference only for performance reasons. Not modified.
archiveClassNamename of the archive class for the config (not archive class dp name) Passed as reference only for performance reasons. Not modified.
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type) Passed as reference only for performance reasons. Not modified.
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband. Passed as reference only for performance reasons. Not modified.
timeIntervalarchive time interval Passed as reference only for performance reasons. Not modified.
exceptionInfodetails of any errors are returned here
checkClassOptional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks.
activateArchivingOptional parameter. For internal use - to configure but not start archiving, please use fwArchive_configMany. Default value = TRUE, archiving is started immediately. Else if set to FALSE archiving is configured but not started.
configureOnly(optional, default false); if set to true, the archiving will be started/stopped according to the activateArchiving, otherwise only configuration will be changed (e.g. for smoothing); for all DPEs that do not have the archiving configured, the value of activateArchiving parameter will be taken.
fwArchive_set ( string  dpe,
string  archiveClassName,
int  archiveType,
int  smoothProcedure,
float  deadband,
float  timeInterval,
dyn_string &  exceptionInfo,
bool  checkClass = TRUE 
)
Sets archive config for the given dp element and start the archiving
Parameters
dpedata point element
archiveClassNamename of the archive class for the config (not archive class dp name)
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
checkClassOptional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks.
fwArchive_configMultiple ( dyn_string  dpes,
string  archiveClassName,
int  archiveType,
int  smoothProcedure,
float  deadband,
float  timeInterval,
dyn_string &  exceptionInfo,
bool  checkClass = TRUE 
)
Sets archive config for the given dp elements without starting the archiving
Parameters
dpeslist of data point elements
archiveClassNamename of the archive class for the config (not archive class dp name)
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
checkClassOptional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks.
fwArchive_configMany ( dyn_string  dpes,
dyn_string  archiveClassName,
dyn_int  archiveType,
dyn_int  smoothProcedure,
dyn_float  deadband,
dyn_float  timeInterval,
dyn_string &  exceptionInfo,
bool  checkClass = TRUE 
)
Sets archive config for the given dp elements without enabling or disabling the archive
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeslist of data point elements
archiveClassNamename of the archive class for the config (not archive class dp name)
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
checkClassOptional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks.
fwArchive_config ( string  dpe,
string  archiveClassName,
int  archiveType,
int  smoothProcedure,
float  deadband,
float  timeInterval,
dyn_string &  exceptionInfo,
bool  checkClass = TRUE 
)
Sets archive config for the given dp element without starting the archiving
Parameters
dpedata point element
archiveClassNamename of the archive class for the config (not archive class dp name)
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
checkClassOptional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks.
fwArchive_getMany ( dyn_string &  dpes,
dyn_bool &  configExists,
dyn_string &  archiveClass,
dyn_int &  archiveType,
dyn_int &  smoothProcedure,
dyn_float &  deadband,
dyn_float &  timeInterval,
dyn_bool &  isActive,
dyn_string &  exceptionInfo 
)
Returns details of the archive config on the given list of dp elements
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpesthe list of data point elements. Passed as reference only for performance reasons. Not modified.
configExistsTRUE - archive config existing, FALSE - archive config is not existing
archiveClassname of the archive class for the config (not archive class dp name)
archiveTypespecify whether archive smoothing shold be enabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
isActiveTRUE if archiving of this dpe is active, else FALSE
exceptionInfodetails of any errors are returned here
fwArchive_get ( string  dpe,
bool &  configExists,
string &  archiveClass,
int &  archiveType,
int &  smoothProcedure,
float &  deadband,
float &  timeInterval,
bool &  isActive,
dyn_string &  exceptionInfo 
)
Returns details of the archive config on the given dp element
Parameters
dpedata point element
configExistsTRUE - archive config existing, FALSE - archive config is not existing
archiveClassname of the archive class for the config (not archive class dp name)
archiveTypespecifies whether archive smoothing is active (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
isActiveTRUE if archiving of this dpe is active, else FALSE
exceptionInfodetails of any errors are returned here
fwArchive_startMultiple ( dyn_string  dpes,
dyn_string &  exceptionInfo 
)
Starts archiving for the given dp elements
Parameters
dpeslist of data point elements
exceptionInfodetails of any errors are returned here
fwArchive_start ( string  dpe,
dyn_string &  exceptionInfo 
)
Starts archiving for the given dp element
Parameters
dpedata point element
exceptionInfodetails of any errors are returned here
fwArchive_stopMultiple ( dyn_string  dpes,
dyn_string &  exceptionInfo 
)
Stops archiving for the given dp elements
Parameters
dpeslist of data point elements
exceptionInfodetails of any errors are returned here
fwArchive_stop ( string  dpe,
dyn_string &  exceptionInfo 
)
Stops archiving for the given dp element
Parameters
dpedata point element
exceptionInfodetails of any errors are returned here
_fwArchive_set ( string  dpe,
bool  startArchive,
string  archiveClassDpName,
int  archiveType,
int  smoothProcedure,
float  deadband,
float  timeInterval,
dyn_string &  exceptionInfo 
)
Sets archive config for the given dp element

NOTE: This function requires the dp name of the archiving class. It will not perform the search for the dp name from a given archive class name. NOTE: This function does not check that the chosen archive class has enough free space, nor if the class has been deleted

Usage
Internal
Parameters
dpedata point element
startArchivetrue in order to start the archive immediately, false in order to ONLY configure it
archiveClassDpNamethe dp name of the archiving class to be used
archiveTypespecifies whether archive smoothing should be ebabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
_fwArchive_setMany ( dyn_string  dpes,
bool  startArchive,
dyn_string  archiveClassDpName,
dyn_int  archiveType,
dyn_int  smoothProcedure,
dyn_float  deadband,
dyn_float  timeInterval,
dyn_string &  exceptionInfo,
bool  configureOnly = false 
)
Sets archive config for the given dp elements

NOTE: This function requires the dp name of the archiving class. It will not perform the search for the dp name from a given archive class name. NOTE: This function does not check that the chosen archive class has enough free space, nor if the class has been deleted

Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpesdata point elements
startArchivetrue in order to start the archive immediately, false in order to ONLY configure it
archiveClassDpNamethe dp name of the archiving class to be used
archiveTypespecifies whether archive smoothing should be ebabled (using Constants for archive type)
smoothProcedurelist of smoothing procedures; use constants declared in Constants for archive smoothing procedure
deadbandarchive deadband
timeIntervalarchive time interval
exceptionInfodetails of any errors are returned here
configureOnly(optional, default false); if set to true, the archiving will be started/stopped according to the startArchive parameter otherwise only configuration will be changed (e.g. for smoothing); for all DPEs that do not have the archiving configured, the value of startArchive parameter will be taken.
fwArchive_convertClassNameToDpName ( string  archiveClassName,
string &  archiveDpName,
dyn_string &  exceptionInfo,
string  searchSystem = "" 
)
Finds the _ValueArchive DP name corresponding to the given archive class name
Parameters
archiveClassNamename of the archive class
archiveDpNamedp name of the archive class _ValueArchive data point is returned here
exceptionInfodetails of any errors are returned here
searchSystemOPTIONAL PARAMETER - default value is "" (search local system) The system on which to perform the lookup of the archive class name
fwArchive_convertDpNameToClassName ( string  archiveDpName,
string &  archiveClassName,
dyn_string &  exceptionInfo 
)
Finds the archive class name corresponding to the given _ValueArchive DP
Parameters
archiveDpNamedp name of the archive class _ValueArchive data point
archiveClassNamename of the archive class is returned here
exceptionInfodetails of any errors are returned here
fwArchive_checkClass ( string  archiveClassDpName,
dyn_string  dpesToAdd,
dyn_string &  exceptionInfo 
)
Checks the given archive class to ensure the class has not been deleted and has enough free

space to configure a given number of archiving configs

PVSS managers
VISION, CTRL
Parameters
archiveClassDpNamedp name of the archive class _ValueArchive data point to check
dpesToAdda list of data point elements you wish to configure with the given class
exceptionInfodetails of any errors are returned here
fwArchive_getClassState ( string  archiveClassDpName,
int &  archiveState,
string &  archiveStateText,
dyn_string &  exceptionInfo 
)
Gets the state of the given archive class
Parameters
archiveClassDpNamedp name of the archive class _ValueArchive data point to check
archiveStatethe archive state is returned here fwArchive_CLASS_STOPPED = Archive manager not running fwArchive_CLASS_ONLINE = Archive manager running fwArchive_CLASS_SWAPPED_OUT = Archive is currently swapped out fwArchive_CLASS_DELETED = Archive has been deleted
archiveStateTexta text representation of the state is returned here
exceptionInfodetails of any errors are returned here
fwArchive_getClassStatistics ( string  archiveClassDpName,
int &  currentDpes,
int &  dpesAfterFileSwitch,
int &  maximumDpes,
dyn_string &  exceptionInfo,
bool  refreshClass = TRUE 
)
Gets the statistics of the given archive class
Parameters
archiveClassDpNamedp name of the archive class _ValueArchive data point to check
currentDpesthe number of dpes currently in the archive is returned here
dpesAfterFileSwitchthe number of dpes that will be in the archive after a file switch is returned here
maximumDpesthe maximum number of dpes for this class is returned here
exceptionInfodetails of any errors are returned here
refreshClassOptional parameter. Default value TRUE. If TRUE, force class to refresh statistics before getting values (maybe slow) If FALSE, get current values which may be out of date
fwArchive_getClassFreeSpace ( string  archiveClassDpName,
int &  freeSpace,
dyn_string &  exceptionInfo,
bool  refreshClass = TRUE 
)
Gets the amount of additional data point elements that can be added to a given archive class

The value returned is based on the number of dpes in the archive currently, not the number after the next file switch

Parameters
archiveClassDpNamedp name of the archive class _ValueArchive data point to check
freeSpacethe number of dpes that can be added to the archive is returned here
exceptionInfodetails of any errors are returned here
refreshClassOptional parameter. Default value TRUE. If TRUE, force class to refresh statistics before getting values (maybe slow) If FALSE, get current values which may be out of date
fwArchive_checkDpesArchived ( string  archiveClassDpName,
dyn_string  dpesToCheck,
dyn_bool &  areArchived,
dyn_string &  exceptionInfo 
)
This function can be used to check if a given list of dpes are correctly configured to be archived by a given archive manager.

Sometimes, if an archive class is full and more data point elements are added without checking for errors, the additional data points are not added to the archive class (even though the config appears correct) and only a log messages indicates this failure. This function can be used to check that the data point elements are really going to be archived.

Parameters
archiveClassDpNamedp name of the archive class _ValueArchive data point to check
dpesToCheckthe list of dpes that you wish to check are correctly configured for the given archive class
areArchivedlist of booleans relating to dpes in dpesToCheck. TRUE = archived, FALSE = not archived
exceptionInfodetails of any errors are returned here
_fwArchive_flagEndOfRefresh ( string  dpe,
int  value 
)
Work function used to flag the end of a refresh of the archive class statistics
Usage
Internal
Parameters
dpename of the data point element connected to (archiveClassDpName + ".statistics.dpElements:_online.._stime")
valuethe time of the latest update of the datapoint element connected to
fwArchive_convertDpNameToRDBClassName ( string  rdbArchiveGroupDpName,
string &  rdbClassName,
dyn_string &  exceptionInfo 
)
Finds the RDB archive class name corresponding to the given _RDBArchiveGroups DP

The default RDB Archive class is called "RDB-99) EVENT"

Parameters
rdbArchiveGroupDpNamedp name of the RDB archive group _RDBArchiveGroups data point
rdbClassNamename of the archive class is returned here
exceptionInfodetails of any errors are returned here
fwArchive_convertRDBClassNameToDpName ( string  rdbClassName,
string &  rdbArchiveGroupDpName,
dyn_string &  exceptionInfo,
string  searchSystem = "" 
)
Finds the _RDBArchiveGroups DP name corresponding to the given RDB archive class name
Constraints
Only works for RDB archiving classes - not traditional _ValueArchive classes The RDB archive class name must be given as displayed in the PVSS panels - e.g. RDB-XX) GroupName
Parameters
rdbClassNamename of the RDB archive class
rdbArchiveGroupDpNamedp name of the RDB archive group _RDBArchiveGroups data point is returned here
exceptionInfodetails of any errors are returned here
searchSystemOPTIONAL PARAMETER - default value is "" (search local system) The system on which to perform the lookup of the archive class name
fwArchive_getAllValueArchiveClasses ( dyn_string  readFromSystems,
dyn_string &  archiveClasses,
dyn_string &  archiveClassDps,
dyn_string &  exceptionInfo 
)
Finds all the NOT DELETED Value Archive classes and
    returns the class names (for display) and the class dps (for writing to the config)
PVSS managers
VISION, CTRL
Parameters
readFromSystemsThe systems to read from - the list of classes returned is only those classes that are available on every one of the named systems
archiveClassesThe list of archive class names is returned here
archiveClassDpsThe list of _ValueArchive data point names is returned here
exceptionInfoDetails of any errors are returned here
fwArchive_getAllRDBArchiveClasses ( dyn_string  readFromSystems,
dyn_string &  archiveClasses,
dyn_string &  archiveGroupDps,
dyn_string &  exceptionInfo,
bool  includeAlertGroups = FALSE 
)
Finds all the RDB Archiving Group classes and
    returns the class names (for display) and the group dps (for writing to the config)
PVSS managers
VISION, CTRL
Parameters
readFromSystemsThe systems to read from - the list of classes returned is only those classes that are available on every one of the named systems
archiveClassesThe list of RDB archive group names is returned here
archiveGroupDpsThe list of _RDBArchiveGroups data point names is returned here
exceptionInfoDetails of any errors are returned here
includeAlertGroupsOPTIONAL PARAMETER - default value = FALSE If set to FALSE, only EVENT archive groups are returned If set to TRUE, both EVENT and ALERT archive groups are returned

Variable Documentation

const int fwArchive_CLASS_STOPPED = 0
const int fwArchive_CLASS_ONLINE = 1
const int fwArchive_CLASS_SWAPPED_OUT = 2
const int fwArchive_CLASS_DELETED = 3
const string fwArchive_VALARCH_CLASS_DPTYPE = "_ValueArchive"
const string fwArchive_RDB_CLASS_DPTYPE = "_RDBArchiveGroups"
const int fwArchive_MANAGER_NUMBER_OFFSET = 2
bool fwArchive_REFRESH_IN_PROGRESS = FALSE