|
void | unRecipeFunctions_getRangeElementFromPVSSDPE (string sDpName, string &sElement, dyn_string &exceptionInfo) |
|
void | unRecipeFunctions_getInstanceRange (string sDpe, string sRangeElement, string &sRangeMin, string &sRangeMax, dyn_string &exceptionInfo) |
|
string | unRecipeFunctions_getDeviceRange (string sDpName, dyn_string &exceptionInfo) |
|
void | _unRecipeFunctions_getDpeAddress (string dpe, string deviceType, string &address, dyn_string &exceptionInfo) |
|
string | unRecipeFunctions_getDpeValueString (dyn_string dsRcpDpes, dyn_string dsRcpValues) |
|
void | unRecipeFunctions_createNewRecipeDp (string sDeviceType, string sFrontEndName, string sAppName, string &sDpName, int &iDeviceNumber) |
|
bool | unRecipeFunctions_dpMultiSet (dyn_string dsDpNames, string sAppendStr, anytype value, dyn_string &exceptionInfo) |
|
void | unRecipeFunctions_getOnlineValueDpes (dyn_string dsDpNames, dyn_string &outputDpes, dyn_string &exceptionInfo) |
|
void | unRecipeFunctions_getDefaultValueDpes (dyn_string dsDpNames, dyn_string &outputDpes, dyn_string &exceptionInfo) |
|
string | unRecipeFunctions_getDpeUnit (string sDpName, dyn_string &exceptionInfo) |
|
(c) Copyright CERN 2005. All rights not expressly granted are reserved. iceco.nosp@m.ntro.nosp@m.ls.su.nosp@m.ppor.nosp@m.t@cer.nosp@m.n.ch
SPDX-License-Identifier: LGPL-3.0-only
unRcpFunctions_dpe.ctl This file contains functions related to datapoints.
- Creation Date
- 15/03/2017
- Modification History
- Constraints
- None
- Usage
- Public
- PVSS managers
- Ui, CTRL
- Author
- Ivan Prieto Barreiro (BE-ICS)
◆ unRecipeFunctions_getRangeElementFromPVSSDPE()
void unRecipeFunctions_getRangeElementFromPVSSDPE |
( |
string |
sDpName, |
|
|
string & |
sElement, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the element where the range is defined for a PVSS DPE
- Parameters
-
sDpName | - DPE name in the PVSS format (e.g. dist_1:gcs-CFP_STP_CVSF18-SF18-CPC_AnalogParameter-00001.ProcessOutput.ValRq) |
sElement | - Variable to store the element name that contains the range (e.g. .ProcessInput.CurValSt) |
exceptionInfo | - Standard exception handling variable. |
◆ unRecipeFunctions_getInstanceRange()
void unRecipeFunctions_getInstanceRange |
( |
string |
sDpe, |
|
|
string |
sRangeElement, |
|
|
string & |
sRangeMin, |
|
|
string & |
sRangeMax, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the min. and max. values defined in a range for a DPE.
- Parameters
-
sDpe | - [IN] Data point element for whom the range values are required. |
sRangeElement | - [IN] DPE where the range is defined for the 'sDpe' parameter (e.g.: ".ProcessInput.CurValSt") |
sRangeMin | - [OUT] Minimum value of the range definition. |
sRangeMax | - [OUT] Maximum value of the range definition. |
exceptionInfo | - [OUT] Standard exception handling variable. |
◆ unRecipeFunctions_getDeviceRange()
string unRecipeFunctions_getDeviceRange |
( |
string |
sDpName, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the range of the specified DP.
- Parameters
-
sDpName | - [IN] The DP which range is required. |
exceptionInfo | - [OUT] Standard exception handling variable. |
- Returns
- String containing the valid range for the specified DP (format: [min, max]).
◆ _unRecipeFunctions_getDpeAddress()
void _unRecipeFunctions_getDpeAddress |
( |
string |
dpe, |
|
|
string |
deviceType, |
|
|
string & |
address, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the PLC address of a DPE.
- Parameters
-
dpe | - [IN] The Datapoint element which address will be calculated. |
deviceType | - [IN] The device type name. |
address | - [OUT] The PLC address. |
exceptionInfo | - [OUT] Standard exception handling variable. |
◆ unRecipeFunctions_getDpeValueString()
string unRecipeFunctions_getDpeValueString |
( |
dyn_string |
dsRcpDpes, |
|
|
dyn_string |
dsRcpValues |
|
) |
| |
Get a string containing the list of DPEs and values with the format DPName|Value[,DPName|Value]*
- Parameters
-
dsRcpDpes | - [IN] List of recipe elements (e.g. Device1.ProcessOutput.ManReg01); |
dsRcpValues | - [IN] List of recipe values for the dsRecipeDpes. |
- Returns
- String containing the list of DPEs and values with the format DPName|Value[,DPName|Value]*
◆ unRecipeFunctions_createNewRecipeDp()
void unRecipeFunctions_createNewRecipeDp |
( |
string |
sDeviceType, |
|
|
string |
sFrontEndName, |
|
|
string |
sAppName, |
|
|
string & |
sDpName, |
|
|
int & |
iDeviceNumber |
|
) |
| |
Creates a dp name that is not existing already
- Parameters
-
sDeviceType | - [IN] Recipe device type name. |
sFrontEndName | - [IN] Front end name where the recipe will be linked. |
sAppName | - [IN] Application name. |
sDpName | - [OUT] Data point name for the recipe instance. |
iDeviceNumber | - [OUT] Device number for the recipe. |
◆ unRecipeFunctions_dpMultiSet()
bool unRecipeFunctions_dpMultiSet |
( |
dyn_string |
dsDpNames, |
|
|
string |
sAppendStr, |
|
|
anytype |
value, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Function used to set a value in a list of DPEs.
- Parameters
-
dsDpNames | - [IN] List of DP names where to set the values. |
sAppendStr | - [IN] String to append to the DP names. |
value | - [IN] Value to set the the DPEs. |
exceptionInfo | - [OUT] Standard exception handling variable. |
- Returns
- TRUE if the values were set successfully, otherwise FALSE.
◆ unRecipeFunctions_getOnlineValueDpes()
void unRecipeFunctions_getOnlineValueDpes |
( |
dyn_string |
dsDpNames, |
|
|
dyn_string & |
outputDpes, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the DPEs that contains the online values (ProcessInput) for the specified DPEs (ProcessOutput)
- Parameters
-
dsDpNames | - [IN] List of DPEs which online value DPEs are required. |
outputDpes | - [OUT] List of online value DPEs. |
exceptionInfo | - [OUT] Standard exception handling variable. |
◆ unRecipeFunctions_getDefaultValueDpes()
void unRecipeFunctions_getDefaultValueDpes |
( |
dyn_string |
dsDpNames, |
|
|
dyn_string & |
outputDpes, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the DPEs that contains the default values for the specified DPEs
- Parameters
-
dsDpNames | - [IN] List of DPEs which online value DPEs are required. |
outputDpes | - [OUT] List of online value DPEs. |
exceptionInfo | - [OUT] Standard exception handling variable. |
◆ unRecipeFunctions_getDpeUnit()
string unRecipeFunctions_getDpeUnit |
( |
string |
sDpName, |
|
|
dyn_string & |
exceptionInfo |
|
) |
| |
Get the measurement unit of a DP.
- Parameters
-
sDpName | - [IN] The datapoint name. |
exceptionInfo | - [OUT] Standard exception handling variable. |
- Returns
- String containing the measurement unit of the specified DP.