fwConfigs
8.4.0
|
The library to handle WinCC OA archiving. More...
Functions | |
fwArchive_deleteMultiple (const dyn_string &dpes, dyn_string &exceptionInfo) | |
fwArchive_deleteMany (const dyn_string &dpes, dyn_string &exceptionInfo) | |
fwArchive_delete (string dpe, dyn_string &exceptionInfo) | |
_fwArchive_setOrConfig (const dyn_string &dpes, bool startArchiving, const dyn_string &archiveClassDpName, const dyn_int &archiveType, const dyn_int &smoothProcedure, const dyn_float &deadband, const dyn_float &timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, bool configureOnly=FALSE, int groupNumber=1) | |
fwArchive_setMultiple (const dyn_string &dpes, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, bool activateArchiving=TRUE, int groupNumber=1) | |
fwArchive_setMany (const dyn_string &dpes, const dyn_string &archiveClassName, const dyn_int &archiveType, const dyn_int &smoothProcedure, const dyn_float &deadband, const dyn_float &timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, bool activateArchiving=TRUE, bool configureOnly=false, int groupNumber=1) | |
fwArchive_set (string dpe, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, int groupNumber=1) | |
fwArchive_configMultiple (const dyn_string &dpes, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, int groupNumber=1) | |
fwArchive_configMany (const dyn_string &dpes, const dyn_string &archiveClassName, const dyn_int &archiveType, const dyn_int &smoothProcedure, const dyn_float &deadband, const dyn_float &timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, int groupNumber=1) | |
fwArchive_config (string dpe, string archiveClassName, int archiveType, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool checkClass=TRUE, int groupNumber=1) | |
fwArchive_getMany (const 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, int groupNumber=1) | |
fwArchive_get (string dpe, bool &configExists, string &archiveClass, int &archiveType, int &smoothProcedure, float &deadband, float &timeInterval, bool &isActive, dyn_string &exceptionInfo, int groupNumber=1) | |
fwArchive_startMultiple (const dyn_string &dpes, dyn_string &exceptionInfo) | |
fwArchive_start (string dpe, dyn_string &exceptionInfo) | |
fwArchive_stopMultiple (const 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 (const dyn_string &dpes, bool startArchive, const dyn_string &archiveClassDpName, const dyn_int &archiveType, const dyn_int &smoothProcedure, const dyn_float &deadband, const dyn_float &timeInterval, dyn_string &exceptionInfo, bool configureOnly=false, int groupNumber=1) | |
fwArchive_convertClassNameToDpName (string archiveClassName, string &archiveDpName, dyn_string &exceptionInfo, string searchSystem="") | |
fwArchive_convertDpNameToClassName (string archiveDpName, string &archiveClassName, dyn_string &exceptionInfo) | |
fwArchive_checkClass (string archiveClassDpName, const dyn_string &dpesToAdd, dyn_string &exceptionInfo) | |
fwArchive_getClassState (string archiveClassDpName, int &archiveState, string &archiveStateText, dyn_string &exceptionInfo) | |
fwArchive_getClassStatistics (string archiveClassDpName, int ¤tDpes, 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, const 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 (const dyn_string &readFromSystems, dyn_string &archiveClasses, dyn_string &archiveClassDps, dyn_string &exceptionInfo) | |
fwArchive_getAllRDBArchiveClasses (const dyn_string &readFromSystems, dyn_string &archiveClasses, dyn_string &archiveGroupDps, dyn_string &exceptionInfo, bool includeAlertGroups=FALSE) | |
The library to handle WinCC OA archiving.
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.
The following WinCC OA builtin constants (of type int) are used to specify the type of archiving:
DPATTR_ARCH_PROC_VALARCH:
standard archiving with no smoothing,DPATTR_ARCH_PROC_SIMPLESM:
value dependent + deadband/old-new comparison smoothingThe following WinCC OA builtin constants (of type int) are used in the functions to refer to various smoothing procedures:
DPATTR_VALUE_SMOOTH
: value dependent,DPATTR_VALUE_REL_SMOOTH
: relative value dependent,DPATTR_TIME_SMOOTH
: time dependent,DPATTR_TIME_AND_VALUE_SMOOTH
: value AND time dependent,DPATTR_TIME_AND_VALUE_REL_SMOOTH
: relative value AND time dependent,DPATTR_TIME_OR_VALUE_SMOOTH
: value OR time dependent,DPATTR_TIME_OR_VALUE_REL_SMOOTH
: relative value OR time dependent,DPATTR_COMPARE_OLD_NEW
: old-new comparison,DPATTR_OLD_NEW_AND_TIME_SMOOTH
: old-new comparison AND time,DPATTR_OLD_NEW_OR_TIME_SMOOTH
: old-new comparison OR time fwArchive_deleteMultiple | ( | const dyn_string & | dpes, |
dyn_string & | exceptionInfo | ||
) |
Deletes the archive config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
fwArchive_deleteMany | ( | const dyn_string & | dpes, |
dyn_string & | exceptionInfo | ||
) |
Deletes the archive config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
fwArchive_delete | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
Deletes the archive config for the given data point element
dpe | data point element |
exceptionInfo | details of any errors are returned here |
_fwArchive_setOrConfig | ( | const dyn_string & | dpes, |
bool | startArchiving, | ||
const dyn_string & | archiveClassDpName, | ||
const dyn_int & | archiveType, | ||
const dyn_int & | smoothProcedure, | ||
const dyn_float & | deadband, | ||
const dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | checkClass = TRUE , |
||
bool | configureOnly = FALSE , |
||
int | groupNumber = 1 |
||
) |
Sets archive config for the given dp elements with the option to start or not start the archiving
dpes | list of data point elements |
startArchiving | true in order to start the archive immediately, false in order to ONLY configure it |
archiveClassDpName | the dp name of the archiving class to be used |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
checkClass | Optional 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 | ( | const dyn_string & | dpes, |
string | archiveClassName, | ||
int | archiveType, | ||
int | smoothProcedure, | ||
float | deadband, | ||
float | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | checkClass = TRUE , |
||
bool | activateArchiving = TRUE , |
||
int | groupNumber = 1 |
||
) |
Sets archive config for the given dp elements and start the archiving
dpes | list of data point elements |
archiveClassName | name of the archive class for the config (not archive class dp name) |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
checkClass | Optional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks. |
activateArchiving | Optional parameter. Default value TRUE. Determines if archiving should be activated. |
fwArchive_setMany | ( | const dyn_string & | dpes, |
const dyn_string & | archiveClassName, | ||
const dyn_int & | archiveType, | ||
const dyn_int & | smoothProcedure, | ||
const dyn_float & | deadband, | ||
const dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | checkClass = TRUE , |
||
bool | activateArchiving = TRUE , |
||
bool | configureOnly = false , |
||
int | groupNumber = 1 |
||
) |
Sets archive config for the given dp elements and start the archiving
dpes | list of data point elements. |
archiveClassName | name of the archive class for the config (not archive class dp name) |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband. |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
checkClass | Optional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks. |
activateArchiving | Optional 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 , |
||
int | groupNumber = 1 |
||
) |
Sets archive config for the given dp element and start the archiving
dpe | data point element |
archiveClassName | name of the archive class for the config (not archive class dp name) |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
checkClass | Optional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks. |
fwArchive_configMultiple | ( | const dyn_string & | dpes, |
string | archiveClassName, | ||
int | archiveType, | ||
int | smoothProcedure, | ||
float | deadband, | ||
float | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | checkClass = TRUE , |
||
int | groupNumber = 1 |
||
) |
Sets archive config for the given dp elements without starting the archiving
dpes | list of data point elements |
archiveClassName | name of the archive class for the config (not archive class dp name) |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
checkClass | Optional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks. |
fwArchive_configMany | ( | const dyn_string & | dpes, |
const dyn_string & | archiveClassName, | ||
const dyn_int & | archiveType, | ||
const dyn_int & | smoothProcedure, | ||
const dyn_float & | deadband, | ||
const dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | checkClass = TRUE , |
||
int | groupNumber = 1 |
||
) |
Sets archive config for the given dp elements without enabling or disabling the archive
dpes | list of data point elements |
archiveClassName | name of the archive class for the config (not archive class dp name) |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
checkClass | Optional 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 , |
||
int | groupNumber = 1 |
||
) |
Sets archive config for the given dp element without starting the archiving
dpe | data point element |
archiveClassName | name of the archive class for the config (not archive class dp name) |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
checkClass | Optional parameter. Default value TRUE. If TRUE, check class is not deleted and has enough free space. If FALSE skip checks. |
fwArchive_getMany | ( | const 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, | ||
int | groupNumber = 1 |
||
) |
Returns details of the archive config on the given list of dp elements
dpes | the list of data point elements. |
configExists | TRUE - archive config existing, FALSE - archive config is not existing |
archiveClass | name of the archive class for the config (not archive class dp name) |
archiveType | specify whether archive smoothing shold be enabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
isActive | TRUE if archiving of this dpe is active, else FALSE |
exceptionInfo | details 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, | ||
int | groupNumber = 1 |
||
) |
Returns details of the archive config on the given dp element
dpe | data point element |
configExists | TRUE - archive config existing, FALSE - archive config is not existing |
archiveClass | name of the archive class for the config (not archive class dp name) |
archiveType | specifies whether archive smoothing is active (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
isActive | TRUE if archiving of this dpe is active, else FALSE |
exceptionInfo | details of any errors are returned here |
fwArchive_startMultiple | ( | const dyn_string & | dpes, |
dyn_string & | exceptionInfo | ||
) |
Starts archiving for the given dp elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
fwArchive_start | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
Starts archiving for the given dp element
dpe | data point element |
exceptionInfo | details of any errors are returned here |
fwArchive_stopMultiple | ( | const dyn_string & | dpes, |
dyn_string & | exceptionInfo | ||
) |
Stops archiving for the given dp elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
fwArchive_stop | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
Stops archiving for the given dp element
dpe | data point element |
exceptionInfo | details 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
dpe | data point element |
startArchive | true in order to start the archive immediately, false in order to ONLY configure it |
archiveClassDpName | the dp name of the archiving class to be used |
archiveType | specifies whether archive smoothing should be ebabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details of any errors are returned here |
_fwArchive_setMany | ( | const dyn_string & | dpes, |
bool | startArchive, | ||
const dyn_string & | archiveClassDpName, | ||
const dyn_int & | archiveType, | ||
const dyn_int & | smoothProcedure, | ||
const dyn_float & | deadband, | ||
const dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | configureOnly = false , |
||
int | groupNumber = 1 |
||
) |
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
dpes | data point elements |
startArchive | true in order to start the archive immediately, false in order to ONLY configure it |
archiveClassDpName | the dp name of the archiving class to be used |
archiveType | specifies whether archive smoothing should be ebabled (using Constants for archive type) |
smoothProcedure | list of smoothing procedures; use constants declared in Constants for archive smoothing procedure |
deadband | archive deadband |
timeInterval | archive time interval |
exceptionInfo | details 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
archiveClassName | name of the archive class |
archiveDpName | dp name of the archive class _ValueArchive data point is returned here |
exceptionInfo | details of any errors are returned here |
searchSystem | OPTIONAL 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
archiveDpName | dp name of the archive class _ValueArchive data point |
archiveClassName | name of the archive class is returned here |
exceptionInfo | details of any errors are returned here |
fwArchive_checkClass | ( | string | archiveClassDpName, |
const 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
archiveClassDpName | dp name of the archive class _ValueArchive data point to check |
dpesToAdd | a list of data point elements you wish to configure with the given class |
exceptionInfo | details 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
archiveClassDpName | dp name of the archive class _ValueArchive data point to check |
archiveState | the 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 |
archiveStateText | a text representation of the state is returned here |
exceptionInfo | details 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
archiveClassDpName | dp name of the archive class _ValueArchive data point to check |
currentDpes | the number of dpes currently in the archive is returned here |
dpesAfterFileSwitch | the number of dpes that will be in the archive after a file switch is returned here |
maximumDpes | the maximum number of dpes for this class is returned here |
exceptionInfo | details of any errors are returned here |
refreshClass | Optional 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
archiveClassDpName | dp name of the archive class _ValueArchive data point to check |
freeSpace | the number of dpes that can be added to the archive is returned here |
exceptionInfo | details of any errors are returned here |
refreshClass | Optional 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, |
const 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.
archiveClassDpName | dp name of the archive class _ValueArchive data point to check |
dpesToCheck | the list of dpes that you wish to check are correctly configured for the given archive class |
areArchived | list of booleans relating to dpes in dpesToCheck. TRUE = archived, FALSE = not archived |
exceptionInfo | details 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
dpe | name of the data point element connected to (archiveClassDpName + ".statistics.dpElements:_online.._stime") |
value | the 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"
rdbArchiveGroupDpName | dp name of the RDB archive group _RDBArchiveGroups data point |
rdbClassName | name of the archive class is returned here |
exceptionInfo | details 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
rdbClassName | name of the RDB archive class |
rdbArchiveGroupDpName | dp name of the RDB archive group _RDBArchiveGroups data point is returned here |
exceptionInfo | details of any errors are returned here |
searchSystem | OPTIONAL PARAMETER - default value is "" (search local system) The system on which to perform the lookup of the archive class name |
fwArchive_getAllValueArchiveClasses | ( | const 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)
readFromSystems | The systems to read from - the list of classes returned is only those classes that are available on every one of the named systems |
archiveClasses | The list of archive class names is returned here |
archiveClassDps | The list of _ValueArchive data point names is returned here |
exceptionInfo | Details of any errors are returned here |
fwArchive_getAllRDBArchiveClasses | ( | const 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)
readFromSystems | The systems to read from - the list of classes returned is only those classes that are available on every one of the named systems |
archiveClasses | The list of RDB archive group names is returned here |
archiveGroupDps | The list of _RDBArchiveGroups data point names is returned here |
exceptionInfo | Details of any errors are returned here |
includeAlertGroups | OPTIONAL 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 |