fwDIP
8.4.0
|
Functions | |
fwDIP_publishStructure (string item, dyn_string dpes, dyn_string tags, int updateRate, string configDp, dyn_string &exceptionInfo, bool overwrite=FALSE) | |
fwDIP_publishPrimitive (string item, string dpe, int updateRate, string configDp, dyn_string &exceptionInfo, bool overwrite=FALSE) | |
fwDIP_unpublish (string publicationName, dyn_string &exceptionInfo) | |
fwDIP_unpublishAll (string configDp, dyn_string &exceptionInfo) | |
fwDIP_subscribePrimitive (string item, string dpe, string configDp, dyn_string &exceptionInfo, bool overwrite=FALSE) | |
fwDIP_subscribeStructure (string item, dyn_string dpes, dyn_string tags, string configDp, dyn_string &exceptionInfo, bool overwrite=FALSE) | |
fwDIP_subscribeMany (dyn_string dpes, string configDp, dyn_string items, dyn_string tags, dyn_string &exceptionInfo, bool overwrite=FALSE) | |
fwDIP_subscribe (string dpe, string configDp, string item, string tag, dyn_string &exceptionInfo, bool overwrite=FALSE) | |
_fwDIP_removeSubscription (dyn_string dpes, dyn_string &exceptionInfo) | |
fwDIP_unsubscribeMany (dyn_string dpes, dyn_string &exceptionInfo) | |
fwDIP_unsubscribe (string dpe, dyn_string &exceptionInfo) | |
fwDIP_unsubscribeAll (string configDp, dyn_string &exceptionInfo) | |
fwDIP_getDpeSubscription (string dpe, bool &isConfigured, string &configDp, string &address, dyn_string &exceptionInfo) | |
fwDIP_getItemPublication (string dipItem, bool &isConfigured, dyn_string &dpes, dyn_string &tags, int &updateRate, string &configDp, dyn_string &exceptionInfo) | |
_fwDIP_checkIsItemPublished (string item, bool &isConfigured, string &configDp, dyn_string &exceptionInfo) | |
_fwDIP_checkIsDpeListSubscribed (dyn_string dpes, dyn_bool &isConfigured, dyn_string &configDps, dyn_string &exceptionInfo) | |
_fwDIP_checkIsDpeSubscribed (string dpe, bool &isConfigured, string &configDp, dyn_string &exceptionInfo) | |
fwDIP_getAllPublications (string configDp, dyn_dyn_string ¤tPublicationInfo, dyn_string &exceptionInfo) | |
fwDIP_getAllSubscriptions (string configDp, dyn_dyn_string ¤tSubscriptionInfo, dyn_string &exceptionInfo) | |
_fwDIP_splitAddress (string address, string &item, string &tag, dyn_string &exceptionInfo) | |
_fwDIP_splitAddresses (dyn_string addresses, dyn_string &items, dyn_string &tags, dyn_string &exceptionInfo) | |
_fwDIP_constructPublishConfigEntry (string publicationName, dyn_string dpes, dyn_string tagNames, int updateRate, string &configEntry, dyn_string &exceptionInfo) | |
_fwDIP_deconstructPublishConfigEntry (string configEntry, string &publicationName, dyn_string &dpes, dyn_string &tagNames, int &updateRate, dyn_string &exceptionInfo) | |
_fwDIP_getAddressConfig (string dpe, string &address, dyn_string &exceptionInfo) | |
_fwDIP_setAddressConfig (string dpe, string address, dyn_string &exceptionInfo) | |
_fwDIP_getManyAddressConfig (dyn_string dpes, dyn_string &addresses, dyn_string &exceptionInfo) | |
_fwDIP_setManyAddressConfig (dyn_string dpes, dyn_string addresses, dyn_string &exceptionInfo) | |
_fwDIP_modifyConfigList (dyn_string newEntries, dyn_string entriesToDelete, string configDpe, dyn_string &exceptionInfo) | |
_fwDIP_getConfigList (string configDp, dyn_string &configList, dyn_string &exceptionInfo) | |
_fwDIP_setConfigList (string configDp, dyn_string configList, dyn_string &exceptionInfo) | |
_fwDIP_checkIsSimRunning (bool &isRunning, dyn_string &exceptionInfo) | |
int | fwDIP_DipQuery (string DipDP, string address, dyn_string &childName, dyn_int &childType, dyn_string &fieldName, dyn_int &fieldType, dyn_string &exceptionInfo, int timeout=fwDIPBrowser_TIMEOUT) |
_fwDIP_lockBrowserDpe (string DipDP, string referenceName="") | |
_fwDIP_unlockBrowserDpe (string DipDP, string referenceName="") | |
bool | _fwDIP_checkDpeForPublication (string dpe, dyn_string &exceptionInfo) |
fwDIPBrowser_rightClick (unsigned pos, string referenceName="") | |
fwDIPBrowser_refreshCache (string configDp, dyn_string &exceptionInfo) | |
fwDIP_setupSelfTest (string configDp, dyn_string &exceptionInfo) | |
bool | fwDIP_SelfTest (string configDp, dyn_string &exceptionInfo) |
_fwDIP_generateSelfTestName (string configDp, string &itemName, dyn_string &exceptionInfo) | |
bool | _fwDIP_testSelfTestSetup (string configDp, dyn_string &exceptionInfo) |
bool | _fwDIP_findInConfig (string configDp, dyn_string searchStrings, dyn_string &exceptionInfo) |
_fwDIP_replaceInConfig (string configDp, string searchString, string replacementString, dyn_string &exceptionInfo) | |
_fwDIP_moveConfig (string sourceConfig, string targetConfig, dyn_string &exceptionInfo) | |
bool | fwDIP_isServerConfigDisabled (string configDp, dyn_string &exceptionInfo) |
int | fwDIP_migrateConfigToNewDelimeter (string configDp, dyn_string &exceptionInfo, bool withDebugOutput=FALSE) |
fwDIP_migrateAllToNewDelimeter (dyn_string &exceptionInfo, bool withDebugOutput=FALSE) | |
This library contains function associated with the Unit part of the common config. Functions allows to set, get and delete the unit of a dpe or multiple dpes
fwDIP_publishStructure | ( | string | item, |
dyn_string | dpes, | ||
dyn_string | tags, | ||
int | updateRate, | ||
string | configDp, | ||
dyn_string & | exceptionInfo, | ||
bool | overwrite = FALSE |
||
) |
Function to publish a structured DIP publication
item | input, the name of the DIP item |
dpes | input, the list of dpes that combine to form the DIP item |
tags | input, the tag names for the data coming from the dpes listed |
updateRate | input, the required value for the buffer time - zero means data is sent on any change of any dpe |
configDp | input, the name of the DIP configDp to which to save the configuration |
exceptionInfo | output, details of any exceptions are returned here |
overwrite | Optional parameters, default value FALSE. If TRUE, any previous configuration for the item is overwritten. |
fwDIP_publishPrimitive | ( | string | item, |
string | dpe, | ||
int | updateRate, | ||
string | configDp, | ||
dyn_string & | exceptionInfo, | ||
bool | overwrite = FALSE |
||
) |
Function to publish a primitive DIP publication
item | input, the name of the DIP item |
dpe | input, the dpe that contains the data for the item |
updateRate | input, the required value for the buffer time - zero means data is sent on any change of any dpe |
configDp | input, the name of the DIP configDp to which to save the configuration |
exceptionInfo | output, details of any exceptions are returned here |
overwrite | Optional parameters, default value FALSE. If TRUE, any previous configuration for the item is overwritten. |
fwDIP_unpublish | ( | string | publicationName, |
dyn_string & | exceptionInfo | ||
) |
Function to delete the configuration of a DIP publication
publicationName | input, the name of the DIP item that currently published and you want to remove |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_unpublishAll | ( | string | configDp, |
dyn_string & | exceptionInfo | ||
) |
Unpublish all publications currently configured in the specific DIP configuration DP
configDp | input, the name of the DIP configDp to work on |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_subscribePrimitive | ( | string | item, |
string | dpe, | ||
string | configDp, | ||
dyn_string & | exceptionInfo, | ||
bool | overwrite = FALSE |
||
) |
Function to subscribe a dpe to a primitive DIP publication
item | input, the name of the DIP item to subscribe to |
dpe | input, the dpe that the received data will be written to |
configDp | input, the name of the DIP configDp to which to save the configuration |
exceptionInfo | output, details of any exceptions are returned here |
overwrite | Optional parameters, default value FALSE. If TRUE, any previous configuration for the item is overwritten. |
fwDIP_subscribeStructure | ( | string | item, |
dyn_string | dpes, | ||
dyn_string | tags, | ||
string | configDp, | ||
dyn_string & | exceptionInfo, | ||
bool | overwrite = FALSE |
||
) |
Function to subscribe several dpes to a structured DIP publication
item | input, the name of the DIP item to subscribe to |
dpes | input, the list of dpes that the received data will be written to |
tags | input, a list of the tags to read from the DIP item, corresponding to the list of dpes (i.e. the data of which tag goes to which dpe) |
configDp | input, the name of the DIP configDp to which to save the configuration |
exceptionInfo | output, details of any exceptions are returned here |
overwrite | Optional parameters, default value FALSE. If TRUE, any previous configuration for the item is overwritten. |
fwDIP_subscribeMany | ( | dyn_string | dpes, |
string | configDp, | ||
dyn_string | items, | ||
dyn_string | tags, | ||
dyn_string & | exceptionInfo, | ||
bool | overwrite = FALSE |
||
) |
Subscribe many dpes to the given DIP publications and tags
dpes | input, the list of dpes that the subscribed data will be written to |
configDp | input, the name of the DIP configDp to which to save the configuration |
items | input, a list of the DIP items that each dpe will be subscribed to |
tags | input, a list of the tags to read from the DIP item, corresponding to the list of dpes (i.e. the data of which tag goes to which dpe) if an entry in items is a primitive publication then the corresponding value in tags should be "" |
exceptionInfo | output, details of any exceptions are returned here |
overwrite | Optional parameters, default value FALSE. If TRUE, any previous configuration for the item is overwritten. |
fwDIP_subscribe | ( | string | dpe, |
string | configDp, | ||
string | item, | ||
string | tag, | ||
dyn_string & | exceptionInfo, | ||
bool | overwrite = FALSE |
||
) |
Subscribe a single dpe to a DIP publication and tag
dpe | input, the dpe that the subscribed data will be written to |
configDp | input, the name of the DIP configDp to which to save the configuration |
item | input, the DIP item that the dpe will be subscribed to |
tag | input, the tag to read from the DIP item if the item is a primitive publication then the value of tag should be "" |
exceptionInfo | output, details of any exceptions are returned here |
overwrite | Optional parameters, default value FALSE. If TRUE, any previous configuration for the item is overwritten. |
_fwDIP_removeSubscription | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo | ||
) |
Remove DIP subscription info from config dp
dpes | input, the dpes for which any DIP subscription should be deleted. |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_unsubscribeMany | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo | ||
) |
Unsubscribe many dpes from DIP publications
This function deletes information from the DIP config dp and also clears the address config. You should not unsubscribe many items while the DIP manager is running - doing so may produce a lot of errors in the log. If you need to unsubscribe without stopping the DIP manager it is recommended to use fwDIP_unsubscribe() with a delay between each call.
dpes | input, the dpes for which any DIP subscription should be deleted. |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_unsubscribe | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
Unsubscribe a single dpe from a DIP publication
This function deletes information from the DIP config dp and also clears the address config.
dpe | input, the dpe for which any DIP subscription should be deleted. |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_unsubscribeAll | ( | string | configDp, |
dyn_string & | exceptionInfo | ||
) |
Unsubscribe all subscriptions currently configured in the specific DIP configuration DP
configDp | input, the name of the DIP configDp to work on |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_getDpeSubscription | ( | string | dpe, |
bool & | isConfigured, | ||
string & | configDp, | ||
string & | address, | ||
dyn_string & | exceptionInfo | ||
) |
Get the current subscription info for a dpe
dpe | input, the dpe for which the DIP subscription should be read |
isConfigured | output, TRUE is dpe is subscribed to DIP data, else FALSE |
configDp | output, the DIP config dp that contains the details of the subscription |
address | output, the address string in the form dipItem + fwDIP_SEPERATOR + dipTag |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_getItemPublication | ( | string | dipItem, |
bool & | isConfigured, | ||
dyn_string & | dpes, | ||
dyn_string & | tags, | ||
int & | updateRate, | ||
string & | configDp, | ||
dyn_string & | exceptionInfo | ||
) |
Get the current publication info for a given DIP publication
dipItem | input, the DIP item to look for and get its current configuration details |
isConfigured | output, TRUE if the DIP item is published, FALSE if no configuration exists |
dpes | output, the list of dpes which are used as the data source for the DIP publication |
tags | output, the list of tags, corresponding to each dpe, that forms the structure of the DIP publication |
updateRate | output, the current setting of the buffer time |
configDp | output, the DIP config dp which contains the configuration data for the item |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_checkIsItemPublished | ( | string | item, |
bool & | isConfigured, | ||
string & | configDp, | ||
dyn_string & | exceptionInfo | ||
) |
Check to see if a DIP item is already published
item | input, the DIP item to look for |
isConfigured | output, TRUE if the DIP item is published, FALSE if no configuration exists |
configDp | output, the DIP config dp which contains the configuration data for the item |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_checkIsDpeListSubscribed | ( | dyn_string | dpes, |
dyn_bool & | isConfigured, | ||
dyn_string & | configDps, | ||
dyn_string & | exceptionInfo | ||
) |
Check to see if the dpes in a list are already subscribed
dpes | input, the list of dpes to look for |
isConfigured | output, a list of BOOLs, TRUE if the dpe is subscribed to DIP data, else FALSE |
configDps | output, the list of DIP config dps which contain the configuration data for the dpes |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_checkIsDpeSubscribed | ( | string | dpe, |
bool & | isConfigured, | ||
string & | configDp, | ||
dyn_string & | exceptionInfo | ||
) |
Check to see if a dpe is already subscribed
dpe | input, the dpe to look for |
isConfigured | output, TRUE if the dpe is subscribed to DIP data, else FALSE |
configDp | output, the DIP config dp which contains the configuration data for the dpe |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_getAllPublications | ( | string | configDp, |
dyn_dyn_string & | currentPublicationInfo, | ||
dyn_string & | exceptionInfo | ||
) |
Get all current DIP publications for a specific config DP (API manager)
This returns the data in a organised dyn_dyn_string - use fwDIP_OBJECT_... constants to read data out
configDp | input, the DIP config dp to read from |
currentPublicationInfo | output, the DIP publication configuration stored within the data point (use fwDIP_OBJECT_... constants to read data out of here) |
exceptionInfo | output, details of any exceptions are returned here |
fwDIP_getAllSubscriptions | ( | string | configDp, |
dyn_dyn_string & | currentSubscriptionInfo, | ||
dyn_string & | exceptionInfo | ||
) |
Get all current DIP subscriptions for a specific config DP (API manager)
This returns the data in a organised dyn_dyn_string - use fwDIP_OBJECT_... constants to read data out
configDp | input, the DIP config dp to read from |
currentSubscriptionInfo | output, the DIP subscription configuration stored within the data point (use fwDIP_OBJECT_... constants to read data out of here) |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_splitAddress | ( | string | address, |
string & | item, | ||
string & | tag, | ||
dyn_string & | exceptionInfo | ||
) |
Split address into item name and tag
address | input, the full address string (in the format dipItem + fwDIP_SEPERATOR + dipTag) |
item | output, the name of the DIP item |
tag | output, the name of the DIP tag |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_splitAddresses | ( | dyn_string | addresses, |
dyn_string & | items, | ||
dyn_string & | tags, | ||
dyn_string & | exceptionInfo | ||
) |
Split many addresses into item names and tags
addresses | input, list of full address strings (in the format dipItem + fwDIP_SEPERATOR + dipTag) |
items | output, list of names of the DIP items |
tags | output, list of names of the DIP tags |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_constructPublishConfigEntry | ( | string | publicationName, |
dyn_string | dpes, | ||
dyn_string | tagNames, | ||
int | updateRate, | ||
string & | configEntry, | ||
dyn_string & | exceptionInfo | ||
) |
Construct entry for publisher config dp
publicationName | input, the name of the DIP publication item |
dpes | input, the list of dpes that will act as the source data for the publication |
tagNames | input, the list of tag names within the DIP item, corresponding to each of the dpes |
updateRate | input, the buffer time for the DIP publication |
configEntry | output, the required configDP entry is returned here |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_deconstructPublishConfigEntry | ( | string | configEntry, |
string & | publicationName, | ||
dyn_string & | dpes, | ||
dyn_string & | tagNames, | ||
int & | updateRate, | ||
dyn_string & | exceptionInfo | ||
) |
Deconstruct entry for publisher config dp
configEntry | input, the configDP entry is given here |
publicationName | output, the name of the DIP publication item |
dpes | output, the list of dpes that is the source data for the publication |
tagNames | output, the list of tag names within the DIP item, corresponding to each of the dpes |
updateRate | output, the buffer time of the DIP publication |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_getAddressConfig | ( | string | dpe, |
string & | address, | ||
dyn_string & | exceptionInfo | ||
) |
Read address config _reference attribute for a given dpe
dpe | input, the dpe to read from |
address | output, the contents of the _reference attribute is returned here |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_setAddressConfig | ( | string | dpe, |
string | address, | ||
dyn_string & | exceptionInfo | ||
) |
Write address config _reference attribute for a given dpe
dpe | input, the dpe to read from |
address | input, the required contents of the _reference attribute |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_getManyAddressConfig | ( | dyn_string | dpes, |
dyn_string & | addresses, | ||
dyn_string & | exceptionInfo | ||
) |
Read address config _reference attribute for a list of dpes
dpes | input, the list of dpes to read from |
addresses | input, the list of the contents of the _reference attributes is returned here |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_setManyAddressConfig | ( | dyn_string | dpes, |
dyn_string | addresses, | ||
dyn_string & | exceptionInfo | ||
) |
Write many address config _reference attributes for a given list of dpes
dpes | input, the dpe to read from |
addresses | input, the list of the required contents of the _reference attributes |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_modifyConfigList | ( | dyn_string | newEntries, |
dyn_string | entriesToDelete, | ||
string | configDpe, | ||
dyn_string & | exceptionInfo | ||
) |
Add and remove entries in a config list in one go to remove the need for multiple dpSets
newEntries | input, the new entries to go in the config dp |
entriesToDelete | input, any entries to be deleted from the config dp |
configDpe | input, the DIP config dp to act on |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_getConfigList | ( | string | configDp, |
dyn_string & | configList, | ||
dyn_string & | exceptionInfo | ||
) |
Read config info for a given config dp
configDp | input, the DIP config dp to read from |
configList | output, the contents of the config DP is returned here as a simple list |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_setConfigList | ( | string | configDp, |
dyn_string | configList, | ||
dyn_string & | exceptionInfo | ||
) |
Write config info for a given config dp
configDp | input, the DIP config dp to write to |
configList | input, the contents of the config DP is passed here as a simple list |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_checkIsSimRunning | ( | bool & | isRunning, |
dyn_string & | exceptionInfo | ||
) |
Checks if necessary SIM driver is running to access the DIP address configs
isRunning | output, TRUE is the necessary SIM manager is running, else FALSE |
exceptionInfo | output, details of any exceptions are returned here |
int fwDIP_DipQuery | ( | string | DipDP, |
string | address, | ||
dyn_string & | childName, | ||
dyn_int & | childType, | ||
dyn_string & | fieldName, | ||
dyn_int & | fieldType, | ||
dyn_string & | exceptionInfo, | ||
int | timeout = fwDIPBrowser_TIMEOUT |
||
) |
This function issues the query to the relevant API manager via specified DP It writes the starting address for the API manager and then waits until the results are provided by the API manager or the timeout occurs.
DipDP,: | DP for communication with API manager |
address,: | starting address - for the querying the DIP hierarchy |
childName,: | list of children of the given node |
childType,: | specifies the type of a given child node: 1 - leaf 2 - branch 3 - both |
fieldName | list of publication fields in a given node |
fieldType | data type of a publication field |
exceptionInfo | output, details of any exceptions are returned here |
timeout | number of seconds to wait for the result |
_fwDIP_lockBrowserDpe | ( | string | DipDP, |
string | referenceName = "" |
||
) |
This function locks the dpe through which requests for querying the API manager are issued.
DipDP | DP for communication with API manager |
referenceName | - NOT USED, default value = "" |
_fwDIP_unlockBrowserDpe | ( | string | DipDP, |
string | referenceName = "" |
||
) |
This function unlocks the dpe through which requests for querying the API manager are issued.
DipDP,: | DP for communication with API manager |
referenceName | - NOT USED, default value = "" |
bool _fwDIP_checkDpeForPublication | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
This function checks if given dpe exists, and then if it exists, it checks whether it has the original value. It is suggested to check dpes this way before publishing
dpe | dpe to check |
exceptionInfo | output, details of any exceptions are returned here |
fwDIPBrowser_rightClick | ( | unsigned | pos, |
string | referenceName = "" |
||
) |
This function expands the right-click menu. Right now - no menu Modification History: Constraints: Usage: JCOP Framework internal PVSS manager usage: VISION
pos | position of the node in the TreeView |
referenceName | The reference name of the TreeView, default value "" (this) |
fwDIPBrowser_refreshCache | ( | string | configDp, |
dyn_string & | exceptionInfo | ||
) |
This function orders the API manager to refresh the browser cache. Modification History: Constraints: Usage: JCOP Framework PVSS manager usage: VISION,CTRL
configDp | DIP Config datapoint |
exceptionInfo | exception handling |
fwDIP_setupSelfTest | ( | string | configDp, |
dyn_string & | exceptionInfo | ||
) |
This function setups the closed self-test mechanism. It creates a dummy publication and subscribes an internal dpe to it. It allows to determine whether the API manager is working
Modification History: Constraints: Usage: JCOP Framework PVSS manager usage: VISION,CTRL
configDp | DIP Config datapoint |
exceptionInfo | exception handling |
bool fwDIP_SelfTest | ( | string | configDp, |
dyn_string & | exceptionInfo | ||
) |
This function checks whether the DIP API manager is running correctly. That is the local publication-subscription mechanism with a dummy publication is working.
Modification History: Constraints: WARNING: crash of API manager is not instantly visible. It might take few seconds before the function will return valid information in case of crash. Usage: JCOP Framework PVSS manager usage: VISION,CTRL
configDp | DIP Config datapoint |
exceptionInfo | exception handling |
_fwDIP_generateSelfTestName | ( | string | configDp, |
string & | itemName, | ||
dyn_string & | exceptionInfo | ||
) |
This function generates the dummy self-test publication name for the given API manager
Modification History: Constraints: Usage: internal PVSS manager usage: VISION,CTRL
configDp | DIP Config datapoint |
itemName | will contain the generated name |
exceptionInfo | exception handling |
bool _fwDIP_testSelfTestSetup | ( | string | configDp, |
dyn_string & | exceptionInfo | ||
) |
This function checks if the dummy self-test setup had been configured
Modification History: Constraints: Usage internal PVSS manager usage: VISION,CTRL
configDp | DIP Config datapoint |
exceptionInfo | exception handling |
bool _fwDIP_findInConfig | ( | string | configDp, |
dyn_string | searchStrings, | ||
dyn_string & | exceptionInfo | ||
) |
Search for a given set of strings in the DIP configuration.
The function will search for configuration entries that contain ALL the searchStrings (AND operation). Entries that only contain some of the searchStrings will not match the search
configDp | input, the name of the configuration to search |
searchStrings | input, the list of strings to search for in the configuration. The function searches for rows in the configuration that contain ALL of the searchStrings. |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_replaceInConfig | ( | string | configDp, |
string | searchString, | ||
string | replacementString, | ||
dyn_string & | exceptionInfo | ||
) |
Replaces all occurances of a given string in the DIP configuration with another replacement string
configDp | input, the name of the configuration to search |
searchString | input, the string to be replaced. |
replacementString | input, the new string to replace the old one |
exceptionInfo | output, details of any exceptions are returned here |
_fwDIP_moveConfig | ( | string | sourceConfig, |
string | targetConfig, | ||
dyn_string & | exceptionInfo | ||
) |
Moves the DIP configuration from one DP element to another
The source is emptied after the configuration has been copied to the target.
sourceConfig | input, the name of the source DIP configuration DP element |
targetConfig | input, the name of the target DIP configuration DP element |
exceptionInfo | output, details of any exceptions are returned here |
bool fwDIP_isServerConfigDisabled | ( | string | configDp, |
dyn_string & | exceptionInfo | ||
) |
Checks if the DIP server configuration is active or disabled (copied to the disabled configuration DPE)
configDp | input, the name of the configuration to check |
exceptionInfo | output, details of any exceptions are returned here |
int fwDIP_migrateConfigToNewDelimeter | ( | string | configDp, |
dyn_string & | exceptionInfo, | ||
bool | withDebugOutput = FALSE |
||
) |
Migrates a given DIP configuration from the old delimeter (0x1a) to the new one (!)
If entries in the configuration are found to contain both the old and new delimeter the server configuration is disabled and the user must resolve this issue with the fwDIP panel. There is optional debug output in the log, which is used when called from the postInstall script.
configDp | input, the name of the configuration to check |
exceptionInfo | output, details of any exceptions are returned here |
withDebugOutput | OPTIONAL PARAMETER - default value FALSE If FALSE, no debug messages are shown in the log, if TRUE, debug output is printed to the log |
fwDIP_migrateAllToNewDelimeter | ( | dyn_string & | exceptionInfo, |
bool | withDebugOutput = FALSE |
||
) |
Migrates all DIP configurations in the current system from the old delimeter (0x1a) to the new one (!)
If entries in the configuration are found to contain both the old and new delimeter the server configuration is disabled and the user must resolve this issue with the fwDIP panel. There is optional debug output in the log, which is used when called from the postInstall script.
exceptionInfo | output, details of any exceptions are returned here |
withDebugOutput | OPTIONAL PARAMETER - default value FALSE If FALSE, no debug messages are shown in the log, if TRUE, debug output is printed to the log |