Private Functions

Private Functions in general module



void _fwConfigurationDB_getPropertiesAndDPEs (string dptName, dyn_string &properties, dyn_string &dpes, string &devTypeName, dyn_string &exceptionInfo, string deviceModel="")
dyn_string _fwConfigurationDB_getDPTElements (string dptName, dyn_string &exceptionInfo, bool all=FALSE)
void _fwConfigurationDB_getDPTElements2 (string dptName, dyn_string &elementNames, dyn_int &elementTypes, dyn_string &exceptionInfo, bool all=FALSE)
int _fwConfigurationDB_typeIdToDpeTypeId (int varType)
void _fwConfigurationDB_dataToString (anytype data, int dataType, string listSeparator, string &encodedData, dyn_string &exceptionInfo)
void _fwConfigurationDB_stringToData (string encodedData, int dataType, string listSeparator, anytype &data, dyn_string &exceptionInfo)
void fwConfigurationDB_deviceTypesToDpTypes (dyn_string devTypes, dyn_string &dpTypes, dyn_string &exceptionInfo, bool errorOnNonExistingType=true)
string _fwConfigurationDB_getFwDeviceName (string dptName, dyn_string &exceptionInfo)

Function Documentation

void _fwConfigurationDB_getPropertiesAndDPEs ( string  dptName,
dyn_string &  properties,
dyn_string &  dpes,
string &  devTypeName,
dyn_string &  exceptionInfo,
string  deviceModel = "" 
)

Retrieves dp elements for a dp type

This function retrieves the list of data point elements for a given data poin type. If the dpt is a framework data point type, the appropriate device definition is queried to determine the names related to data point elements.

On return, for the Framework Device data point types, the first list (properties variable) will contain the list of property names present in the device definition. The second list (dpes variable) will contain the data point element names associated with the property names from the first list, plus all the data point elements that have no device definition. This way, the function may be used to get the list of all dpes (the second list), the list of dpes from the device definitions (take only the first N items from the second list, where N is the number of elements of the first list), etc. The function will also return the device name from the device definition (in the devName argument).

For non-Frame Device data point types, the first list will always be empty, and the second list will contain the list of all dpes.

Note, that this function will work even if there is no instance of a device type available yet! (In such a case, extracting all data point element could have been done simply by a combination of dpNames() and dpSubStr() for an arbitrary, existing data point...

See also _fwConfigurationDB_getDPTElements .

Parameters:
dptName the name of data point type
properties on return will contain the list of property names
dpes on return will contain the list of all data point elements
devTypeName on return will contain the device type name from the device definition, or dptName
exceptionInfo standard exception handling variable
deviceModel (optional) device model
dyn_string _fwConfigurationDB_getDPTElements ( string  dptName,
dyn_string &  exceptionInfo,
bool  all = FALSE 
)

Retrieves the names of DP elements for given data point type

This function retrieves all data point elements for specified data point type. resolving (recursively) all references to other data points and structures.

Parameters:
dptName the name of the data point type
exceptionInfo standard exception handling variable
all (optional) if TRUE, all properties, including the "." entries of structures will be resolved; If FALSE, only the leaves of the structures will be returned
Returns:
the list of all data point elements for dptName
See also:
_fwConfigurationDB_getDPTElements2
void _fwConfigurationDB_getDPTElements2 ( string  dptName,
dyn_string &  elementNames,
dyn_int &  elementTypes,
dyn_string &  exceptionInfo,
bool  all = FALSE 
)

Retrieves the names and types of DP elements for given data point type

This function retrieves all data point elements for specified data point type. resolving (recursively) all references to other data points and structures.

Parameters:
dptName the name of the data point type
elementNames on return will contain the names of dp elements
elementTypes on return will contain the types of dp elements
exceptionInfo standard exception handling variable
all (optional) if TRUE, all properties, including the "." entries of structures will be resolved; If FALSE, only the leaves of the structures will be returned
See also:
fwConfigurationDB_getDPTElements
int _fwConfigurationDB_typeIdToDpeTypeId ( int  varType  ) 
void _fwConfigurationDB_dataToString ( anytype  data,
int  dataType,
string  listSeparator,
string &  encodedData,
dyn_string &  exceptionInfo 
)
void _fwConfigurationDB_stringToData ( string  encodedData,
int  dataType,
string  listSeparator,
anytype &  data,
dyn_string &  exceptionInfo 
)
void fwConfigurationDB_deviceTypesToDpTypes ( dyn_string  devTypes,
dyn_string &  dpTypes,
dyn_string &  exceptionInfo,
bool  errorOnNonExistingType = true 
)
string _fwConfigurationDB_getFwDeviceName ( string  dptName,
dyn_string &  exceptionInfo 
)

Generated on 4 Oct 2012 for Configuration Database component by  doxygen 1.6.1