fwGeneral
8.4.0
|
Functions | |
void | fwColour_connectItemBackColToStatus (string dpe, dyn_string &exceptionInfo) |
void | fwColour_connectShapeBackColToStatus (string dpe, string shapeName, dyn_string &exceptionInfo) |
void | _fwCalculateColourWithAlertCB (mapping userData, string dpe1, string alertColour, string dpe2, bool alarmActive, string dpe3, bool dataInvalid) |
void | _fwCalculateColourWithSummaryAlertCB (mapping userData, string dpe1, string alertColour, string dpe2, bool alarmActive) |
void | _fwCalculateColourWithoutAlertCB (mapping userData, string dpe1, bool dataInvalid) |
void | fwColour_convertStatusToColour (string &elementColour, string alertColour, bool masked, bool invalid, dyn_string &exceptionInfo) |
string | fwColour_getColourForDpe (string dpe) |
This library is used to convert the given states of a device into the colour which represents this state. Funcitons are also available for dpConnecting the colour of graphical elements to a device state.
11/09/14 Lorenzo Masetti - 13 years later... - added possibility to specify shapeName (fwColour_connectShapeBackColToStatus). Implemented with dpConnnectUserData. New function fwColour_getColourForDpe to get the colour without connecting
void fwColour_connectItemBackColToStatus | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
This function controls the background colour of the item from within which the function was called. The colour is controlled by dpConnecting to the invalid bit of the given data point element, and if it exists, the alert active bit and the alert colour are also connected to. When the function is called, and any time when the alert state or invalid state changes, a function is called which evaluates the current state, selects the relevant colour and sets the background colour of the graphical item.
dpe | data point element |
exceptionInfo | details of any exceptions are placed in here. |
void fwColour_connectShapeBackColToStatus | ( | string | dpe, |
string | shapeName, | ||
dyn_string & | exceptionInfo | ||
) |
This function controls the background colour of the specified shape. See fwColour_connectItemBackColToStatus for details
dpe | data point element |
shapeName | name of the shape |
exceptionInfo | details of any exceptions are placed in here. |
void _fwCalculateColourWithAlertCB | ( | mapping | userData, |
string | dpe1, | ||
string | alertColour, | ||
string | dpe2, | ||
bool | alarmActive, | ||
string | dpe3, | ||
bool | dataInvalid | ||
) |
This functions takes the given states of a data point element and calls a function which calcultes the relevant colour. The function then set the background colour of graphical item "this" to that colour.
userData | contains a mapping with the shapeName |
dpe1 | data point element |
alertColour | a string containing the name of the current alert colour |
dpe2 | data point element |
alarmActive | a bit to represent if alert handling is active or not (TRUE = active, FALSE = inactive) |
dpe3 | data point element |
dataInvalid | a bit to represent if data is invalid or not (TRUE = invalid, FALSE = valid) |
void _fwCalculateColourWithSummaryAlertCB | ( | mapping | userData, |
string | dpe1, | ||
string | alertColour, | ||
string | dpe2, | ||
bool | alarmActive | ||
) |
This functions takes the given state of a summary alert and calls a function which calculates the relevant colour. The function then set the background colour of graphical item "this" to that colour.
userData | contains a mapping with the shapeName |
dpe1 | data point element |
alertColour | a string containing the name of the current alert colour |
dpe2 | data point element |
alarmActive | a bit to represent if alert handling is active or not (TRUE = active, FALSE = inactive) |
void _fwCalculateColourWithoutAlertCB | ( | mapping | userData, |
string | dpe1, | ||
bool | dataInvalid | ||
) |
This functions takes the given states of a data point element and calls a function which calcultes the relevant colour. The function then set the background colour of graphical item "this" to that colour.
userData | contains a mapping with the shapeName |
dpe1 | data point element |
dataInvalid | a bit to represent if data is invalid or not (TRUE = invalid, FALSE = valid) |
void fwColour_convertStatusToColour | ( | string & | elementColour, |
string | alertColour, | ||
bool | masked, | ||
bool | invalid, | ||
dyn_string & | exceptionInfo | ||
) |
This functions takes the given states of a data point element and calculates the appropriate colour which summarises its status.
elementColour | the calculated status colour is returned here. |
alertColour | a string containing the name of the current alert colour |
masked | a bit to represent if alert is maksed or not (TRUE = masked, FALSE = unmasked) |
invalid | a bit to represent if data is invalid or not (TRUE = invalid, FALSE = valid) |
exceptionInfo | details of any exceptions are placed in here. |
string fwColour_getColourForDpe | ( | string | dpe | ) |
The function returns the current color to be used to display dpe with the same logic of fwColour_connectShapeBackColToStatus
dpe | data point element |