fwDIP  8.4.0
fwDIP.ctl File Reference

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 &currentPublicationInfo, dyn_string &exceptionInfo)
 
 fwDIP_getAllSubscriptions (string configDp, dyn_dyn_string &currentSubscriptionInfo, 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)
 

Detailed Description

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

Creation Date
07/07/2004
Modification History
23/03/2005 - Milosz Hulboj - addition of prototype for browsing DIP hierarchy
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Author
Oliver Holme (IT-CO)

Function Documentation

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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
iteminput, the name of the DIP item
dpesinput, the list of dpes that combine to form the DIP item
tagsinput, the tag names for the data coming from the dpes listed
updateRateinput, the required value for the buffer time - zero means data is sent on any change of any dpe
configDpinput, the name of the DIP configDp to which to save the configuration
exceptionInfooutput, details of any exceptions are returned here
overwriteOptional 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
iteminput, the name of the DIP item
dpeinput, the dpe that contains the data for the item
updateRateinput, the required value for the buffer time - zero means data is sent on any change of any dpe
configDpinput, the name of the DIP configDp to which to save the configuration
exceptionInfooutput, details of any exceptions are returned here
overwriteOptional 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
publicationNameinput, the name of the DIP item that currently published and you want to remove
exceptionInfooutput, 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
configDpinput, the name of the DIP configDp to work on
exceptionInfooutput, details of any exceptions are returned here
Reviewed:
2018-06-21 FalsePositive
fwDIP_subscribePrimitive ( string  item,
string  dpe,
string  configDp,
dyn_string &  exceptionInfo,
bool  overwrite = FALSE 
)
Function to subscribe a dpe to a primitive DIP publication
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
iteminput, the name of the DIP item to subscribe to
dpeinput, the dpe that the received data will be written to
configDpinput, the name of the DIP configDp to which to save the configuration
exceptionInfooutput, details of any exceptions are returned here
overwriteOptional 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
iteminput, the name of the DIP item to subscribe to
dpesinput, the list of dpes that the received data will be written to
tagsinput, 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)
configDpinput, the name of the DIP configDp to which to save the configuration
exceptionInfooutput, details of any exceptions are returned here
overwriteOptional 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpesinput, the list of dpes that the subscribed data will be written to
configDpinput, the name of the DIP configDp to which to save the configuration
itemsinput, a list of the DIP items that each dpe will be subscribed to
tagsinput, 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 ""
exceptionInfooutput, details of any exceptions are returned here
overwriteOptional 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeinput, the dpe that the subscribed data will be written to
configDpinput, the name of the DIP configDp to which to save the configuration
iteminput, the DIP item that the dpe will be subscribed to
taginput, the tag to read from the DIP item if the item is a primitive publication then the value of tag should be ""
exceptionInfooutput, details of any exceptions are returned here
overwriteOptional 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpesinput, the dpes for which any DIP subscription should be deleted.
exceptionInfooutput, 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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpesinput, the dpes for which any DIP subscription should be deleted.
exceptionInfooutput, 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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeinput, the dpe for which any DIP subscription should be deleted.
exceptionInfooutput, 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
configDpinput, the name of the DIP configDp to work on
exceptionInfooutput, details of any exceptions are returned here
Reviewed:
2018-06-21 FalsePositive
fwDIP_getDpeSubscription ( string  dpe,
bool &  isConfigured,
string &  configDp,
string &  address,
dyn_string &  exceptionInfo 
)
Get the current subscription info for a dpe
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeinput, the dpe for which the DIP subscription should be read
isConfiguredoutput, TRUE is dpe is subscribed to DIP data, else FALSE
configDpoutput, the DIP config dp that contains the details of the subscription
addressoutput, the address string in the form dipItem + fwDIP_SEPERATOR + dipTag
exceptionInfooutput, 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
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dipIteminput, the DIP item to look for and get its current configuration details
isConfiguredoutput, TRUE if the DIP item is published, FALSE if no configuration exists
dpesoutput, the list of dpes which are used as the data source for the DIP publication
tagsoutput, the list of tags, corresponding to each dpe, that forms the structure of the DIP publication
updateRateoutput, the current setting of the buffer time
configDpoutput, the DIP config dp which contains the configuration data for the item
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
iteminput, the DIP item to look for
isConfiguredoutput, TRUE if the DIP item is published, FALSE if no configuration exists
configDpoutput, the DIP config dp which contains the configuration data for the item
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpesinput, the list of dpes to look for
isConfiguredoutput, a list of BOOLs, TRUE if the dpe is subscribed to DIP data, else FALSE
configDpsoutput, the list of DIP config dps which contain the configuration data for the dpes
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpeinput, the dpe to look for
isConfiguredoutput, TRUE if the dpe is subscribed to DIP data, else FALSE
configDpoutput, the DIP config dp which contains the configuration data for the dpe
exceptionInfooutput, 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

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
configDpinput, the DIP config dp to read from
currentPublicationInfooutput, the DIP publication configuration stored within the data point (use fwDIP_OBJECT_... constants to read data out of here)
exceptionInfooutput, 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

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
configDpinput, the DIP config dp to read from
currentSubscriptionInfooutput, the DIP subscription configuration stored within the data point (use fwDIP_OBJECT_... constants to read data out of here)
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
addressinput, the full address string (in the format dipItem + fwDIP_SEPERATOR + dipTag)
itemoutput, the name of the DIP item
tagoutput, the name of the DIP tag
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
addressesinput, list of full address strings (in the format dipItem + fwDIP_SEPERATOR + dipTag)
itemsoutput, list of names of the DIP items
tagsoutput, list of names of the DIP tags
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
publicationNameinput, the name of the DIP publication item
dpesinput, the list of dpes that will act as the source data for the publication
tagNamesinput, the list of tag names within the DIP item, corresponding to each of the dpes
updateRateinput, the buffer time for the DIP publication
configEntryoutput, the required configDP entry is returned here
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
configEntryinput, the configDP entry is given here
publicationNameoutput, the name of the DIP publication item
dpesoutput, the list of dpes that is the source data for the publication
tagNamesoutput, the list of tag names within the DIP item, corresponding to each of the dpes
updateRateoutput, the buffer time of the DIP publication
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpeinput, the dpe to read from
addressoutput, the contents of the _reference attribute is returned here
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpeinput, the dpe to read from
addressinput, the required contents of the _reference attribute
exceptionInfooutput, details of any exceptions are returned here
Reviewed:
2018-06-25 API even though not used, kept for symmetry of the API with _fwDIP_getAddressConfig
_fwDIP_getManyAddressConfig ( dyn_string  dpes,
dyn_string &  addresses,
dyn_string &  exceptionInfo 
)
Read address config _reference attribute for a list of dpes
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpesinput, the list of dpes to read from
addressesinput, the list of the contents of the _reference attributes is returned here
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpesinput, the dpe to read from
addressesinput, the list of the required contents of the _reference attributes
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
newEntriesinput, the new entries to go in the config dp
entriesToDeleteinput, any entries to be deleted from the config dp
configDpeinput, the DIP config dp to act on
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
configDpinput, the DIP config dp to read from
configListoutput, the contents of the config DP is returned here as a simple list
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
configDpinput, the DIP config dp to write to
configListinput, the contents of the config DP is passed here as a simple list
exceptionInfooutput, 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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
isRunningoutput, TRUE is the necessary SIM manager is running, else FALSE
exceptionInfooutput, 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.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
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
fieldNamelist of publication fields in a given node
fieldTypedata type of a publication field
exceptionInfooutput, details of any exceptions are returned here
timeoutnumber of seconds to wait for the result
Returns
status type of the queried node
_fwDIP_lockBrowserDpe ( string  DipDP,
string  referenceName = "" 
)

This function locks the dpe through which requests for querying the API manager are issued.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
DipDPDP 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.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
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

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpedpe to check
exceptionInfooutput, 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

Parameters
posposition of the node in the TreeView
referenceNameThe 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

Parameters
configDpDIP Config datapoint
exceptionInfoexception 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

Parameters
configDpDIP Config datapoint
exceptionInfoexception handling
Reviewed:
2018-06-21 FalsePositive
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

Parameters
configDpDIP Config datapoint
exceptionInfoexception handling
Returns
- whether the manager is working
Reviewed:
2018-06-21 FalsePositive
_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

Parameters
configDpDIP Config datapoint
itemNamewill contain the generated name
exceptionInfoexception 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

Parameters
configDpDIP Config datapoint
exceptionInfoexception handling
Returns
- whether the setup is correct
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

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
configDpinput, the name of the configuration to search
searchStringsinput, the list of strings to search for in the configuration. The function searches for rows in the configuration that contain ALL of the searchStrings.
exceptionInfooutput, details of any exceptions are returned here
Returns
0 - if no configuration entries contained all the searchStrings, 1 - if at least one configuration entry contained all the searchStrings.
_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
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
configDpinput, the name of the configuration to search
searchStringinput, the string to be replaced.
replacementStringinput, the new string to replace the old one
exceptionInfooutput, 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.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
sourceConfiginput, the name of the source DIP configuration DP element
targetConfiginput, the name of the target DIP configuration DP element
exceptionInfooutput, 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)
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
configDpinput, the name of the configuration to check
exceptionInfooutput, details of any exceptions are returned here
Returns
0 - if server configuration is active, 1 - if server configuration has been disabled
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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
configDpinput, the name of the configuration to check
exceptionInfooutput, details of any exceptions are returned here
withDebugOutputOPTIONAL PARAMETER - default value FALSE If FALSE, no debug messages are shown in the log, if TRUE, debug output is printed to the log
Returns
0 - if configuration is up-to-date 1 - if configuration was migrated successfully -1 - if the configuration can not be migrated automatically (both old and new seperators found in an entry)
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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
exceptionInfooutput, details of any exceptions are returned here
withDebugOutputOPTIONAL PARAMETER - default value FALSE If FALSE, no debug messages are shown in the log, if TRUE, debug output is printed to the log