Functions | |
public void | unRecipeFunctions_getRangeElementFromPVSSDPE (string sDpName, string &sElement, dyn_string &exceptionInfo) |
public 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) |
public string | unRecipeFunctions_getDpeValueString (dyn_string dsRcpDpes, dyn_string dsRcpValues) |
public void | unRecipeFunctions_createNewRecipeDp (string sDeviceType, string sFrontEndName, string sAppName, string &sDpName, int &iDeviceNumber) |
public bool | unRecipeFunctions_dpMultiSet (dyn_string dsDpNames, string sAppendStr, anytype value, dyn_string &exceptionInfo) |
public void | unRecipeFunctions_getOnlineValueDpes (dyn_string dsDpNames, dyn_string &outputDpes, dyn_string &exceptionInfo) |
public void | unRecipeFunctions_getDefaultValueDpes (dyn_string dsDpNames, dyn_string &outputDpes, dyn_string &exceptionInfo) |
public string | unRecipeFunctions_getDpeUnit (string sDpName, dyn_string &exceptionInfo) |
Variables | |
global mapping | unRecipe_rangeElements |
UNICOS Copyright (C) CERN 2017 All rights reserved
unRcpFunctions_dpe.ctl This file contains functions related to datapoints.
public void unRecipeFunctions_getRangeElementFromPVSSDPE | ( | string | sDpName, | |
string & | sElement, | |||
dyn_string & | exceptionInfo | |||
) |
Get the element where the range is defined for a PVSS DPE
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. |
Referenced by unRecipeFunctions_formatValues(), unRecipeFunctions_getDeviceRange(), and unRecipeFunctions_getDpeUnit().
public 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.
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. |
Referenced by unRecipeFunctions_formatValues(), and unRecipeFunctions_getDeviceRange().
string unRecipeFunctions_getDeviceRange | ( | string | sDpName, | |
dyn_string & | exceptionInfo | |||
) |
Get the range of the specified DP.
sDpName | - [IN] The DP which range is required. | |
exceptionInfo | - [OUT] Standard exception handling variable. |
References unRecipeFunctions_getInstanceRange(), and unRecipeFunctions_getRangeElementFromPVSSDPE().
Referenced by _unRecipeFunctions_saveRecipeElementsToFile(), unRecipeFunctions_checkRecipeValue(), and unRecipeFunctions_loadRecipeInstanceData().
void _unRecipeFunctions_getDpeAddress | ( | string | dpe, | |
string | deviceType, | |||
string & | address, | |||
dyn_string & | exceptionInfo | |||
) |
Get the PLC address of a DPE.
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. |
References unRecipeFunctions_writeInRecipeLog().
Referenced by _unRecipeFunctions_addDigitalParameterToBuffers(), _unRecipeFunctions_addMultiDpeDeviceToBuffers(), and _unRecipeFunctions_addXParameterToBuffers().
public 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]*
dsRcpDpes | - [IN] List of recipe elements (e.g. Device1.ProcessOutput.ManReg01); | |
dsRcpValues | - [IN] List of recipe values for the dsRecipeDpes. |
References unRecipeFunctions_getOnlineValueDpes().
Referenced by _unRecipeFunctions_createRecipeInstance(), and unRecipeFunctions_duplicateRecipeInstance().
public void unRecipeFunctions_createNewRecipeDp | ( | string | sDeviceType, | |
string | sFrontEndName, | |||
string | sAppName, | |||
string & | sDpName, | |||
int & | iDeviceNumber | |||
) |
Creates a dp name that is not existing already
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. |
Referenced by _unRecipeFunctions_createPredefinedRecipeInstance(), _unRecipeFunctions_createRecipeClass(), and _unRecipeFunctions_createRecipeInstance().
public bool unRecipeFunctions_dpMultiSet | ( | dyn_string | dsDpNames, | |
string | sAppendStr, | |||
anytype | value, | |||
dyn_string & | exceptionInfo | |||
) |
Function used to set a value in a list of DPEs.
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. |
References unRecipeFunctions_handleDpGetSetError().
Referenced by unRecipeFunctions_unlockDevicesLockedBySaveToDb().
public 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)
dsDpNames | - [IN] List of DPEs which online value DPEs are required. | |
outputDpes | - [OUT] List of online value DPEs. | |
exceptionInfo | - [OUT] Standard exception handling variable. |
Referenced by _unRecipeFunctions_checkRecipeOnlineValues(), unRecipeFunctions_formatValues(), unRecipeFunctions_getDpeValueString(), and unRecipeFunctions_getOnlineValues().
public void unRecipeFunctions_getDefaultValueDpes | ( | dyn_string | dsDpNames, | |
dyn_string & | outputDpes, | |||
dyn_string & | exceptionInfo | |||
) |
Get the DPEs that contains the default values for the specified DPEs
dsDpNames | - [IN] List of DPEs which online value DPEs are required. | |
outputDpes | - [OUT] List of online value DPEs. | |
exceptionInfo | - [OUT] Standard exception handling variable. |
Referenced by unRecipeFunctions_saveAsDeviceDefaultValues().
public string unRecipeFunctions_getDpeUnit | ( | string | sDpName, | |
dyn_string & | exceptionInfo | |||
) |
Get the measurement unit of a DP.
sDpName | - [IN] The datapoint name. | |
exceptionInfo | - [OUT] Standard exception handling variable. |
References unRecipeFunctions_getRangeElementFromPVSSDPE().
Referenced by _unRecipeFunctions_saveRecipeElementsToFile(), and unRecipeFunctions_loadRecipeInstanceData().