unRcpFunctions_gui.ctl File Reference

Functions

void unRecipeFunctions_getSelectedRecipeDp (string &sSelected, dyn_string &exceptionInfo)
void unRecipeFunctions_animateSelectionProgressBar (string sDpName)
public bool unRecipeFunctions_selectItemInComboBox (string sShape, string sSelect, int indexOtherwise=1)
public bool _unRecipeFunctions_showValuesOutOfRange (dyn_int diErrorLines)
public void _unRecipeFunctions_setTableColumnBGColor (string tableName, string columnName, string color)
public void _unRecipeFunctions_setTableRowBGColor (string tableName, int rowIndex, string color)
public void _unRecipeFunctions_setTableCellBGColor (string tableName, int rowIndex, string columnName, string color)
public void _unRecipeFunctions_resetRecipeElementsBgColor ()
public void _unRecipeFunctions_setInvalidRows (dyn_string rows, string sTableName="RecipeElements")
public string _unRecipeFunctions_adjustStringToSize (shape hiddenShape, string aString, int width)
public void _unRecipeFunctions_setRecipeInstancePanelComponentsEnabled (bool value)
public void _unRecipeFunctions_enableRecipeInstanceWarning (bool bEnable, string sMessage="")
public void unRecipeFunctions_registerSelectButtonCB (string sDp, bool bSystemConnected)
public void unRecipeFunctions_animateSelectButtonCB (string sDp1, bool bLocked, string sDp2, string sSelectedManager)
public void unRecipeFunctions_disconnectSelectButton ()

Detailed Description

UNICOS Copyright (C) CERN 2017 All rights reserved

unRcpFunctions_gui.ctl This file contains functions related to the graphical user interface.

Creation Date
15/03/2017
Modification History
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Author:
Ivan Prieto Barreiro (BE-ICS)

Function Documentation

void unRecipeFunctions_getSelectedRecipeDp ( string &  sSelected,
dyn_string &  exceptionInfo 
)

Get the data point name of the recipe instance selected in the panel.

Parameters:
sSelected - [OUT] DP name of the recipe instance selected in the panel.
exceptionInfo - [OUT] Standard exception handling variable.

Referenced by _unRecipeFunctions_loadHistoryTableInfo(), _unRecipeFunctions_loadPropertiesTableInfo(), unRecipeFunctions_animateSelectionProgressBar(), unRecipeFunctions_editRecipeInstance(), and unRecipeFunctions_loadRecipeInstanceData().

void unRecipeFunctions_animateSelectionProgressBar ( string  sDpName  ) 

Method used to animate the selection progress bar in the recipe instance panel.

Parameters:
sDpName - [IN] Data point name of the selected recipe instance.
Reviewed:
2018-09-12 Thread

Selection Progress Bar animation

References unRecipeFunctions_getSelectedRecipeDp().

public bool unRecipeFunctions_selectItemInComboBox ( string  sShape,
string  sSelect,
int  indexOtherwise = 1 
)

Selects an item in a combo box.

Parameters:
sShape - [IN] Combo box name.
sSelect - [IN] Item to select.
indexOtherwise - [IN] Index to select in case the selected item does not exist.
Returns:
TRUE if the item to select exists in the combobox, otherwise false.

Referenced by unRecipeFunctions_selectPcoRecipes().

public void _unRecipeFunctions_setTableColumnBGColor ( string  tableName,
string  columnName,
string  color 
)

Set the background color of a column in a table.

Parameters:
tableName - [IN] The name of the table.
columnName - [IN] The name of the column.
color - [IN] The new color for the column.

Referenced by unRecipeFunctions_editRecipeInstance(), and unRecipeFunctions_editRecipeValuesAndShowDifferences().

public void _unRecipeFunctions_setTableRowBGColor ( string  tableName,
int  rowIndex,
string  color 
)

Set the background color of a row in a table.

Parameters:
tableName - [IN] The name of the table.
rowIndex - [IN] The row index.
color - [IN] The new color for the row.

Referenced by _unRecipeFunctions_resetRecipeElementsBgColor(), and _unRecipeFunctions_setInvalidRows().

public void _unRecipeFunctions_setTableCellBGColor ( string  tableName,
int  rowIndex,
string  columnName,
string  color 
)

Set the background color of a cell in a table.

Parameters:
tableName - [IN] The name of the table.
rowIndex - [IN] The row index.
columnName - [IN] The name of the column.
color - [IN] The new color for the row.

Referenced by unRecipeFunctions_activateRecipes(), unRecipeFunctions_adoptOnlineValues(), unRecipeFunctions_checkRecipeStatus(), and unRecipeFunctions_compareOnlineValues().

public void _unRecipeFunctions_resetRecipeElementsBgColor (  ) 

Restore the original colors in the recipe elements table (recipe instance panel).

References _unRecipeFunctions_setTableRowBGColor().

Referenced by unRecipeFunctions_cancelEditRecipeInstance(), unRecipeFunctions_loadRecipeInstanceData(), and unRecipeFunctions_saveRecipeInstance().

public void _unRecipeFunctions_setInvalidRows ( dyn_string  rows,
string  sTableName = "RecipeElements" 
)

Set the background color of the rows in the RecipeElements table that contains invalid values.

Parameters:
rows - [IN] Indices of the invalid rows.
sTableName - [IN] Name of the table where the invalid rows must be set.

References _unRecipeFunctions_setTableRowBGColor().

Referenced by unRecipeFunctions_loadRecipeClassData(), and unRecipeFunctions_loadRecipeInstanceData().

public string _unRecipeFunctions_adjustStringToSize ( shape  hiddenShape,
string  aString,
int  width 
)

Method used to trim a label to the appropriate size.

Parameters:
hiddenShape - [IN] Hidden shape (label) to calculate the width of the string.
aString - [IN] String to be trimmed if its width is bigger than the size specified.
width - [IN] Width of the shape where the label will be placed.
Returns:
A new string that fits in the specified width.

Referenced by unUnRcpClass_WidgetCB(), and unUnRcpInstance_WidgetCB().

public void _unRecipeFunctions_setRecipeInstancePanelComponentsEnabled ( bool  value  ) 

Enable/disable some graphical components of the recipe instance panel (required for the recipe activation).

Parameters:
value - [IN] The value for the enabled property of the graphical components.

Referenced by _unRecipeFunctions_resetRecipeActivation(), and unRecipeFunctions_activateRecipe().

public void _unRecipeFunctions_enableRecipeInstanceWarning ( bool  bEnable,
string  sMessage = "" 
)

Function to show/hide the recipe instance warning message.

Parameters:
bEnable - [IN] Flag to specify the visibility of the warning message.
sMessage - [IN] Message to display in the WarningText label.

Referenced by _unRecipeFunctions_dpConnectRcpClassElementsCB(), _unRecipeFunctions_dpConnectRcpValuesCB(), unRecipeFunctions_loadRecipeInstanceData(), and unRecipeFunctions_saveRecipeInstance().

public void unRecipeFunctions_registerSelectButtonCB ( string  sDp,
bool  bSystemConnected 
)

Registers the callback to the select button

Parameters:
sDp - [IN]
bSystemConnected - [IN]
Reviewed:
2018-08-06 Callback

References unRecipeFunctions_disconnectSelectButton().

public void unRecipeFunctions_animateSelectButtonCB ( string  sDp1,
bool  bLocked,
string  sDp2,
string  sSelectedManager 
)

Animates the select button

Parameters:
sDp1 
bLocked 
sDp2 
sSelectedManager 
Reviewed:
2018-08-06 Callback
public void unRecipeFunctions_disconnectSelectButton (  ) 

Disconnection of the select button

Referenced by unRecipeFunctions_registerSelectButtonCB().


Generated on 11 Mar 2019 for unCPC6 by  doxygen 1.6.1