cpcGenericDpFunctions.ctl File Reference

Generic functions to interact with WinCC-OA DB. More...

Functions

void cpcGenericDpFunctions_setDeviceProperty (string sDeviceDpName, string propertyName, string propertyValue, dyn_string &exceptionInfo)
string cpcGenericDpFunctions_getDeviceProperty (string sDeviceDpName, string propertyName, dyn_string &exceptionInfo, string defaultValue="")
bool cpcGenericDpFunctions_doesDevicePropertyExist (string sDeviceDpName, string propertyName, dyn_string &exceptionInfo)
dyn_string cpcConfigGenericFunctions_getAssociatedDevices (string deviceDpName)
string cpcGenericDpFunctions_getMapping (string deviceDpName, string dpeName)

Variables

const string UN_CPC_DEVICE_PROPERTY_PREFIX = "PROP_"

Detailed Description

Generic functions to interact with WinCC-OA DB.

Author:
Alexey Merezhin (EN-ICE-SIC)

©Copyright CERN 2013 - all rights reserved

Creation Date
20/06/2011
Constraints
None
Usage
Public
PVSS managers
UI, CTRL

Function Documentation

void cpcGenericDpFunctions_setDeviceProperty ( string  sDeviceDpName,
string  propertyName,
string  propertyValue,
dyn_string &  exceptionInfo 
)

Save the device property for a given property name

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
sDeviceDpName device name DP name
propertyName property name
propertyValue property value
exceptionInfo error returned here

References UN_CPC_DEVICE_PROPERTY_PREFIX.

Referenced by CPC_ProcessControlObject_setName(), cpcConfigGenericFunctions_setParameters(), and cpcExportGenericFunctions_updateConversionParameters().

string cpcGenericDpFunctions_getDeviceProperty ( string  sDeviceDpName,
string  propertyName,
dyn_string &  exceptionInfo,
string  defaultValue = "" 
)
bool cpcGenericDpFunctions_doesDevicePropertyExist ( string  sDeviceDpName,
string  propertyName,
dyn_string &  exceptionInfo 
)

Check if device property for a given key exist

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
sDeviceDpName device name DP name
propertyName property name
exceptionInfo error returned here
Returns:
property existence

References UN_CPC_DEVICE_PROPERTY_PREFIX.

dyn_string cpcConfigGenericFunctions_getAssociatedDevices ( string  deviceDpName  ) 

Return the list of associate devices (dp names), formed from MASTER/PARENT/CHILDREN hierarchy's properties

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
deviceDpName device name DP name
Returns:
dp names of hierarchically linked devices

References CPC_CONFIG_CHILDREN_KEY, CPC_CONFIG_MASTER_NAME_KEY, and CPC_CONFIG_PARENTS_KEY.

string cpcGenericDpFunctions_getMapping ( string  deviceDpName,
string  dpeName 
)

Return device's key-value mapping for a dpe. Also see cpcConfigGenericFunctions_setMapping.

Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Parameters:
deviceDpName device name DP name
dpeName name of dpe
Returns:
comma-separated string of dpe's key=value mapping

References CPC_CONFIG_MAPPING.

Referenced by CPC_MassFlowController_FaceplateInitStatics(), CPC_MassFlowControllerConfig_ExportConfig(), CPC_WordParameter_FaceplateInitStatics(), CPC_WordParameter_WidgetInitStatics(), CPC_WordParameterConfig_ExportConfig(), CPC_WordStatus_FaceplateInitStatics(), CPC_WordStatus_WidgetInitStatics(), CPC_WordStatusConfig_ExportConfig(), and CPC_WordStatusConfig_setCustomConfig().


Variable Documentation

const string UN_CPC_DEVICE_PROPERTY_PREFIX = "PROP_"

Prefix for property fields.

Device may contain special field called PARAMETERS, having a set of key-value. In WinCC-OA those params will be saved with this prefix (UN_CPC_DEVICE_PROPERTY_PREFIX+key -> value) in the device configuration (available by 'Device configuration' right-click menu's item).

See also:
cpcConfigGenericFunctions_checkParameters, cpcConfigGenericFunctions_setParameters

Referenced by CPC_ControllerConfig_setCustomConfig(), cpcExportGenericFunctions_getParameters(), cpcGenericDpFunctions_doesDevicePropertyExist(), cpcGenericDpFunctions_getDeviceProperty(), and cpcGenericDpFunctions_setDeviceProperty().


Generated on 18 Jun 2018 for unCPC6 by  doxygen 1.6.1