fwDIP  8.5.1
fwDIPExport.ctl File Reference

Functions

string fwDIPExport_makeLogFileName ()
 
 fwDIPExport_saveDIPConfigInFile (string sDIPConfig, string sFile, bool bUseAlias, dyn_string &exceptionInfo, string sLogFile)
 
 fwDIPExport_saveInXML (file fFile, string sXMLFile, mapping mDIPConfig, mapping mDIPPublication, mapping mDIPSubscription, dyn_string &exceptionInfo)
 
string _fwDIPExport_convertType (int iDPEType)
 
 _fwDIPExport_getManagerDNSParameters (int iManagerType, string sManager, int iManagerNumber, string &sDns, string &sParameters)
 

Detailed Description

This library contains utility functions for the export of fwDIP config.

Creation Date
19/12/2002
Modification History
09/04/2015: Herve ENS-11382: DIP Import blocks HMI

27/08/2013: Herve Milcent DIP-120 - DIP and fwDipImport, accept "single" keyword in the import file and use "single" in the export instead of "simple"

27/08/2013: Herve Milcent ENS-8248

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Author
Herve Milcent

Function Documentation

string fwDIPExport_makeLogFileName ( )
returns the file name to be use for log file
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Returns
the file name is returned
fwDIPExport_saveDIPConfigInFile ( string  sDIPConfig,
string  sFile,
bool  bUseAlias,
dyn_string &  exceptionInfo,
string  sLogFile 
)
Save the DIP config in a file
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
sDIPConfiginput, the DIP config DP name
sFileinput, the file to dump the DIP config into
bUseAliasinput, true=use the alias/false=use DP name
exceptionInfodetails of any exceptions are returned here
sLogFileinput, the log file name

the publication are kept in a mapping variable:

  • key = DIP publication name
  • value = list of DPE and its parameter associated to the DIP publication name

One can have more than one DPE per publication.

the subscription are kept in a mapping variable:

  • key = DIP subscription name
  • value = list of DPE and its parameter associated to the DIP subscription name

One can have more than one DPE per subscription, however in the current implementation, one has only one DPE per subscription, because the complex subscription are not supported (ENS-8248).

fwDIPExport_saveInXML ( file  fFile,
string  sXMLFile,
mapping  mDIPConfig,
mapping  mDIPPublication,
mapping  mDIPSubscription,
dyn_string &  exceptionInfo 
)
Save the DIP config in a XML file
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
fFileinput, the log file name id
sXMLFileinput, the file to dump the DIP config into
mDIPConfiginput, the DIPConfig data
mDIPPublicationinput, the list of publication
mDIPSubscriptioninput, the list of subscription
exceptionInfodetails of any exceptions are returned here
string _fwDIPExport_convertType ( int  iDPEType)
Convert the DPE type to xml DIP type
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
iDPETypeinput, the type of DPE
Returns
the converted type
_fwDIPExport_getManagerDNSParameters ( int  iManagerType,
string  sManager,
int  iManagerNumber,
string &  sDns,
string &  sParameters 
)
Get the manager DNS and parameters
Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
iManagerTypeinput, the type of manager: DRIVER_MAN, API_MAN
sManagerinput, the manager name
iManagerNumberinput, the manager number
sDnsoutput, the dns used
sParametersoutput, the extra parameters