fwConfigs  8.4.0
fwFormat.ctl File Reference

Functions

 fwFormat_set (string dpe, string sFormat, dyn_string &exceptionInfo)
 
 fwFormat_setMultiple (dyn_string dsDpe, string sFormat, dyn_string &exceptionInfo)
 
 fwFormat_setMany (dyn_string &dsDpe, dyn_string &dsFormat, dyn_string &exceptionInfo)
 
 fwFormat_get (string dpe, bool &bFormatExists, string &sFormat, dyn_string &exceptionInfo)
 
 fwFormat_getMany (dyn_string &dsDpe, dyn_bool &dbFormatExists, dyn_string &dsFormat, dyn_string &exceptionInfo)
 
 fwFormat_delete (string dpe, dyn_string &exceptionInfo)
 
 fwFormat_deleteMultiple (dyn_string dsDpe, dyn_string &exceptionInfo)
 
 fwFormat_deleteMany (dyn_string dsDpe, dyn_string &exceptionInfo)
 

Detailed Description

This library contains function associated with the Format part of the common config. Functions allows to set, get and delete the Format of a dpe or multiple dpes

Creation Date
29/01/2004
Modification History

12/08/11 Marco Boccioli

  • {85462}: Functions *_setMany and *_getMany with parameters as reference.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Author
Geraldine Thomas, Oliver Holme (IT-CO)

Function Documentation

fwFormat_set ( string  dpe,
string  sFormat,
dyn_string &  exceptionInfo 
)
set the Format of a single data point element
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeinput, data point element to configure
sFormatinput, string Format to set
exceptionInfooutput, details of any exceptions are returned here
fwFormat_setMultiple ( dyn_string  dsDpe,
string  sFormat,
dyn_string &  exceptionInfo 
)
Set the same Format for several dpes
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsDpeinput, data point elements to configure
sFormatinput, string Format to set
exceptionInfooutput, details of any exceptions are returned here
fwFormat_setMany ( dyn_string &  dsDpe,
dyn_string &  dsFormat,
dyn_string &  exceptionInfo 
)
Set differing Formats for several dpes
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsDpeinput, data point elements to configure. Passed as reference only for performance reasons. Not modified.
dsFormatinput, list of Formats to set to dpes. Passed as reference only for performance reasons. Not modified.
exceptionInfooutput, details of any exceptions are returned here
fwFormat_get ( string  dpe,
bool &  bFormatExists,
string &  sFormat,
dyn_string &  exceptionInfo 
)
Get the Format of the dpe
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpedata point element to configure
bFormatExistsTRUE if format is set, FALSE if no format is set
sFormatoutput, return the Format of the dpe
exceptionInfooutput, details of any exceptions are returned here
fwFormat_getMany ( dyn_string &  dsDpe,
dyn_bool &  dbFormatExists,
dyn_string &  dsFormat,
dyn_string &  exceptionInfo 
)
Get the Format of several dpes
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsDpeinput, data point elements to configure. Passed as reference only for performance reasons. Not modified.
dbFormatExistsLists of bools indicating if format is set - TRUE if format is set, FALSE if no format is set
dsFormatoutput, return the current Format of the dpes
exceptionInfooutput, details of any exceptions are returned here
fwFormat_delete ( string  dpe,
dyn_string &  exceptionInfo 
)
Delete the Format of the dpe.  The format string is reset to ""
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpedata point element to configure
exceptionInfooutput, details of any exceptions are returned here
fwFormat_deleteMultiple ( dyn_string  dsDpe,
dyn_string &  exceptionInfo 
)
Delete the Format of several dpes.  The format strings are reset to ""
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsDpeinput, data point elements to configure
exceptionInfooutput, details of any exceptions are returned here
fwFormat_deleteMany ( dyn_string  dsDpe,
dyn_string &  exceptionInfo 
)
Delete the Format of several dpes.  The format strings are reset to ""
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsDpeinput, data point elements to configure
exceptionInfooutput, details of any exceptions are returned here