fwTrending
8.4.1
|
Functions | |
fwTrending_getAllPlots (dyn_string &plotDpNames, dyn_string &exceptionInfo) | |
fwTrending_getPlotDpNames (dyn_string &plotDpNames, dyn_string &exceptionInfo, string pattern="*:*") | |
fwTrending_getAllPages (dyn_string &pageDpNames, dyn_string &exceptionInfo) | |
fwTrending_getPageDpNames (dyn_string &pageDpNames, dyn_string &exceptionInfo, string pattern="*:*") | |
fwTrending_deletePlot (string sPlotName, dyn_string &exceptionInfo) | |
fwTrending_deletePage (string sPageName, dyn_string &exceptionInfo) | |
fwTrending_createPlot (string sPlotName, dyn_string &exInfo, string model=fwTrending_YT_PLOT_MODEL) | |
fwTrending_createPage (string sPageName, dyn_string &exInfo, string model=fwTrending_YT_PAGE_MODEL) | |
void | fwTrending_newPage (string _pageName, string model=fwTrending_YT_PAGE_MODEL) |
void | fwTrending_newPlot (string sPlotName, string sModel=fwTrending_YT_PLOT_MODEL) |
void | fwTrending_copyPlotData (string _from, string _to) |
void | fwTrending_copyPage (string _from, string _to) |
fwTrending_initControlTrendButtons (int currentTimeRange, string sRef, string sDpName, string sTrendLog, bool bCallBack=true) | |
fwTrending_getDaysHoursMinutesFromTimeRange (int timeRange, int &days, int &hours, int &minutes, dyn_string &exceptionInfo) | |
fwTrending_getTimeRangeFromDaysHoursMinutes (int &timeRange, int days, int hours, int minutes, dyn_string &exceptionInfo) | |
fwTrending_initControlHistogramButtons (string ref, string sDpName, dyn_string plotData, bool trendRunning, dyn_string exceptionInfo, bool bCallBack=true) | |
_fwTrending_initGenericTrendControls (string ref, string sDpName, string showGrid, string showLegend, dyn_string &exceptionInfo, bool bCallBack=true) | |
fwTrending_initControlTrendXYButtons (int currentTimeRange, string sRef, string sDpName, string sTrendLog) | |
_fwTrending_initTimeRange (int currentTimeRange, string ref, dyn_string &exceptionInfo) | |
_fwTrending_initTrendCaption (int curveNumber, dyn_string dsDpe, dyn_dyn_string ddsCurveParams, dyn_string legendObj, dyn_string valueObj, string visibilityObj, dyn_string dsUnit, dyn_string unitObj, bool visibility, dyn_string curveTimeObj, bool bEnabledVisibility) | |
_fwTrending_initCurve (string curveName, int curveNumber, string ref, dyn_string dsLegendObj, dyn_string dsValueObj, dyn_string dsCurveDPE, dyn_string dsCurveLegend, dyn_string dsCurveToolTip, string curveColor, dyn_bool dbScaleVisibility, dyn_bool dbIsLogTrend, string curveVisibilityObj, dyn_string dsUnit, dyn_string dsUnitObj, bool curveVisibility, string trendShapeName, int curvesType, dyn_string dsCurveTimeObj, bool bInitCaption, dyn_string &exceptionInfo, int markerType=0, dyn_int diCurveScalePos=0, int iCurveLink=0, string sCurveStyle=fwTrending_DEFAULT_CURVE_STYLE, string sLegendValFormat=fwTrending_DEFAULT_LEGEND_VALUE_FORMAT, string sAxiiYFormat=fwTrending_DEFAULT_AXII_Y_FORMAT) | |
fwTrending_trendUpdateAlarmLimits (string ref, dyn_dyn_anytype value) | |
fwTrending_trendUpdateScales (string sRef, dyn_dyn_string ddsPlotData, string sTrendName, dyn_string exceptionInfo) | |
fwTrending_clearAlarmLimits (shape trendShape, string curveName, dyn_string exceptionInfo) | |
fwTrending_toggleAlarmLimits (string curveName, string curveDpeName, bool curveLimitsVisible, shape trendShape, dyn_string exceptionInfo, string sCurveStyle=fwTrending_DEFAULT_CURVE_STYLE, bool clearLimits=FALSE) | |
fwTrending_initTrendWithObject (string sRef, string trendName, dyn_string trendShapeStr, dyn_dyn_string plotExtendedObject, bool runTrend, bool bInitCaption, dyn_string &exceptionInfo, bool passingCurveVisible=FALSE) | |
fwTrending_initHistogramWithObject (string sRef, string trendName, dyn_dyn_string plotExtendedObject, bool runTrend, dyn_string &exceptionInfo) | |
fwTrending_controlBarOnOff (string ref, int visible) | |
fwTrending_toggleControlBar (string ref) | |
_fwTrending_connectToAlarmHandling (string ref, dyn_dyn_string plotData) | |
fwTrending_showStandardTrend (bool visibility, string standardStr, string logStr, dyn_dyn_string plotData="") | |
fwTrending_ShowCurve (string ref, string trendName, int curveNumber, bool visibility) | |
fwTrending_getPage (string pageDp, dyn_dyn_string &pageData, dyn_string &exceptionInfo) | |
fwTrending_setPage (string pageDp, dyn_dyn_string pageData, dyn_string &exceptionInfo) | |
fwTrending_getPlot (string sPlotDp, dyn_dyn_string &ddsPlotData, dyn_string &exceptionInfo) | |
fwTrending_setPlot (string sPlotDp, dyn_dyn_string ddsPlotData, dyn_string &exceptionInfo) | |
fwTrending_getPlotExtended (string plotDp, string refName, dyn_dyn_string &plotExtendedData, dyn_string &exceptionInfo, bool returnCurveVisible=FALSE) | |
fwTrending_getPlotData (string ref, string sDpName, dyn_string &returnValue) | |
fwTrending_getPlotDataDpeData (string sPlotDpe, string &sDpe, string &sUnit, string &sDescription) | |
fwTrending_getTitle (string sDpName, string &sTitle, dyn_string &exceptionInfo) | |
fwTrending_getPlotTitle (string sDpPlotName, string &sPlotTitle) | |
fwTrending_getPageTitle (string sDpPageName, string &sPageTitle) | |
fwTrending_getPlotIsTemplate (string sDpPlotName, string &bIsTemplate) | |
fwTrending_setPlotIsTemplate (string sDpPlotName, string bIsTemplate) | |
fwTrending_showPlot (int iNumberOfPlots, dyn_string dsPlotName, dyn_string &dsReference, dyn_string templateParameters) | |
fwTrending_simplifyPagePlotList (dyn_string dsRawPlotList, int rows, int columns, dyn_string &dsSimplePlotList, dyn_string &exceptionInfo) | |
_fwTrending_openProgressBar (string sHeader, string sIcon, string text1, string text2, string text3, int iSliderType) | |
dyn_string | _fwTrending_cleanPlotObjectDPES (dyn_string plotObjectDPE) |
dyn_string | _fwTrending_preparePlotObjectDPES (dyn_string plotObjectDPE) |
string | fwTrending_createAliasRepresentation (string sDp) |
string | fwTrending_cleanAliasRepresentation (string sDp) |
_fwTrending_closeProgressBar () | |
void | fwTrending_changeTrendTimeRange (string ref, int range, string refControl, string localTimeRangeObjValue, int itemPos, string itemText) |
_fwTrending_gotoNow (shape trendName, int range) | |
fwTrending_trendZoomX (string ref, bool bZoomIn) | |
fwTrending_trendZoomY (string ref, bool bZoomIn) | |
fwTrending_trendRun (string ref, bool bRunTrend, string refControl) | |
fwTrending_gridOnOff (string ref, bool bShowGrid, string refControl, dyn_string &exceptionInfo) | |
fwTrending_markersOnOff (string ref, int markerType, string refControl, dyn_string &exceptionInfo) | |
fwTrending_legendOnOff (string ref, bool bShowLegend, string refControl, dyn_string &exceptionInfo) | |
fwTrending_trendUnzoom (string ref) | |
fwTrending_trendZoomToAlarmLimits (string sReference) | |
fwTrending_trendRefresh (string ref) | |
fwTrending_trendTimeBack (string ref, bool bTimeBack) | |
fwTrending_pageSavePlotSettings (string ref) | |
fwTrending_saveCurrentSettings (string ref, string sDpName, string sDpType, bool createNewDpIfRequired, bool overwriteExisting, dyn_string &exceptionInfo, bool useDpNameForTitle=FALSE) | |
fwTrending_pageExportTrend (dyn_string dsRef, string templateParameters, string sSave="FALSE") | |
fwTrending_exportTrend (string sFileName, dyn_string dsCurveDPE, dyn_string dsLegendCurve, dyn_time dtStart, dyn_time dtEnd, string sTemplateParameters, dyn_string &exceptionInfo, bool bFillEmptyCells=FALSE) | |
string | fwTrending_modify_CSV_characters (string sTextInput) |
fwTrending_eventsSort (dyn_dyn_time ddt, dyn_dyn_bool &events, dyn_time ×) | |
fwTrending_convertStringToDyn (string valueString, dyn_anytype &valueList, dyn_string &exceptionInfo) | |
fwTrending_convertDynToString (dyn_anytype valueList, string &valueString, dyn_string &exceptionInfo) | |
fwTrending_getAllTemplateParametersForConfiguration (dyn_dyn_string configurationData, string configurationType, dyn_string &templateParameters, dyn_string &exceptionInfo) | |
_fwTrending_evaluateTemplate (string givenParametersString, dyn_string &expressionList, dyn_string &exceptionInfo) | |
fwTrending_rebuildDpeUNICOS (dyn_string dpes, dyn_string &fileDpe) | |
fwTrending_convertUnicosDpeStringToPvssDpeString (string unicosDpes, string &pvssDpes, dyn_string &exceptionInfo) | |
fwTrending_convertPvssDpeListToUnicosDpeList (dyn_string pvssDpes, dyn_string &unicosDpes, dyn_string &exceptionInfo) | |
fwTrending_convertUnicosDpeListToPvssDpeList (dyn_string unicosDpes, dyn_string &pvssDpes, dyn_string &exceptionInfo) | |
fwTrending_checkCurveName (string dpe, bool &tempBool, dyn_string &exceptionInfo) | |
_fwTrending_splitParameters (string parameters, dyn_dyn_string &dsParameters) | |
fwTrending_checkAndGetAllTemplateParameters (string uniqueIdentifier, dyn_dyn_string configurationData, string configurationType, string ¤tParameters, dyn_string &exceptionInfo, bool relativePosition=FALSE, bool returnDefaultIfCancel=FALSE) | |
fwTrending_modifyAllTemplateParameters (string uniqueIdentifier, dyn_dyn_string configurationData, string configurationType, string ¤tParameters, dyn_string &exceptionInfo, bool relativePosition=FALSE) | |
fwTrending_checkAllTemplateParameters (dyn_string &requiredParameters, string givenParameterString, bool &gotValuesForAll, dyn_string &exceptionInfo) | |
fwTrending_mergeParameterLists (string firstList, string secondList, string &returnedList, dyn_string &exceptionInfo) | |
_fwTrending_findTemplateParameters (dyn_dyn_string data, dyn_string ¶metersFound, dyn_string &exceptionInfo) | |
fwTrending_setRuntimePlotDataWithExtendedObject (string refName, string isRunning, dyn_dyn_string plotExtendedObject, dyn_string &exceptionInfo, bool runningInsideTrend=TRUE) | |
fwTrending_setRuntimePlotDataWithStrings (string refName, string isRunning, dyn_string plotData, dyn_string &exceptionInfo, bool runningInsideTrend=TRUE) | |
fwTrending_setRuntimePageDataWithObject (dyn_dyn_string pageObject, dyn_string &exceptionInfo) | |
fwTrending_getRuntimePageDataWithObject (dyn_dyn_string &pageObject, dyn_string &exceptionInfo) | |
fwTrending_setRuntimePageDataWithStrings (dyn_string pageData, dyn_string &exceptionInfo) | |
fwTrending_getRuntimePageDataWithStrings (dyn_string &pageData, dyn_string &exceptionInfo) | |
fwTrending_getRuntimePlotDataWithStrings (string refName, string &isRunning, dyn_string &plotShapes, dyn_string &plotData, dyn_string &exceptionInfo, bool runningInsideTrend=TRUE) | |
fwTrending_getRuntimePlotDataWithExtendedObject (string refName, string &isRunning, dyn_string &plotShapes, dyn_dyn_string &plotExtendedObject, dyn_string &exceptionInfo, bool runningInsideTrend=TRUE) | |
_fwTrending_syncDifferentRangeFormats (string &minRange, string &maxRange, string &combinedRange, dyn_string &exceptionInfo) | |
_fwTrending_switchCurvesHiddenVisible (dyn_string ¤tCurveStatus, dyn_string &exceptionInfo) | |
fwTrending_getNumberOfCurves (string plotDp, int &numberOfCurves, dyn_string &exceptionInfo) | |
fwTrending_getFirstFreeCurve (string plotDp, int &position, dyn_string &exceptionInfo) | |
fwTrending_getFreeCurves (string plotDp, dyn_int &positions, dyn_string &exceptionInfo) | |
fwTrending_setCurve (string plotDp, dyn_string curveData, int curveToSet, dyn_string &exceptionInfo) | |
fwTrending_setManyCurves (string plotDp, dyn_dyn_string curvesData, dyn_int curvesToSet, dyn_string &exceptionInfo) | |
fwTrending_getCurve (string plotDp, bool &isCurveDefined, dyn_string &curveData, int curveToGet, dyn_string &exceptionInfo) | |
fwTrending_appendCurve (string plotDp, dyn_string curveData, dyn_string &exceptionInfo) | |
fwTrending_appendManyCurves (string plotDp, dyn_dyn_string curvesData, dyn_string &exceptionInfo) | |
fwTrending_deleteManyCurves (string plotDp, dyn_int curvesToDelete, dyn_string &exceptionInfo) | |
fwTrending_removeCurve (string plotDp, int curveToRemove, dyn_string &exceptionInfo) | |
_fwTrending_checkCurveData (dyn_string &curveData, int position, dyn_string &exceptionInfo) | |
int | _fwTrending_getCurveObjectIndexes (dyn_int &curveObjectIndexes, dyn_int &plotObjectIndexes, dyn_string &exceptionInfo) |
fwTrending_openPlotDisplay (string sPlotDpName, string sPanelFileName, bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, unsigned x=0, unsigned y=0, string sResizeMode="") | |
_fwTrending_isSystemForDpeConnected (string curveDpe, bool &isConnected, dyn_string &exceptionInfo) | |
_fwTrending_isSystemConnected (string systemName, bool &isConnected, dyn_string &exceptionInfo) | |
_fwTrending_getConnectedSystemIds (dyn_int &systemIds, dyn_string &exceptionInfo) | |
_fwTrending_updateHistogram (string dpa, dyn_float value) | |
_fwTrending_convertPlotDataToDollars (dyn_dyn_string plotData, dyn_string &dollarParameters, dyn_string &exceptionInfo) | |
_fwTrending_preparePlotObjectForDisplay (dyn_dyn_string &plotData, string parameterString, dyn_string &exceptionInfo) | |
fwTrending_addQuickFaceplate (string moduleName, string panelName, string refName, dyn_string dpesToPlot, int x, int y, dyn_string &exceptionInfo, string plotDpName="_FwTrendingQuickPlotDefaults", float xScale=1.0, float yScale=1.0) | |
fwTrending_addFaceplate (string moduleName, string panelName, string refName, string plotDpName, dyn_string templateParameterNames, dyn_string templateParameterValues, int x, int y, dyn_string &exceptionInfo, float xScale=1.0, float yScale=1.0) | |
fwTrending_removeFaceplate (string moduleName, string panelName, string refName, dyn_string &exceptionInfo) | |
bool | _fwTrending_isUnicosEnvironment (dyn_string &exceptionInfo) |
dyn_string | fwTrending_getPlotTreeTagNames () |
dyn_string | fwTrending_getPageTreeTagNames () |
bool | fwTrending_isPlotTreeTagExportable (int iTagIndex) |
bool | fwTrending_isDpName (string sDp) |
bool | fwTrending_isAlias (string sDp) |
bool | fwTrending_isPageTreeTagExportable (int iTagIndex) |
string | _fwTrending_appendDotTo (string ref) |
string | _fwTrending_adjustRefName (string ref) |
dyn_string | fwTrending_getCurrentScaleMinMaxRanges (string sReferenceName) |
Get the min and max values of all y-scales in the currently visible trend. More... | |
dyn_string | fwTrending_getCurrentScaleMinMaxRangesX (string sReferenceName) |
Get the min and max values of the x-scale in the currently visible value over value trend. More... | |
dyn_string | fwTrending_getCurrentScaleVisibilities (string sReferenceName) |
Get scale visibility all y-scales in the currently visible trend. More... | |
bool | fwTrending_valuesAreValid (dyn_string dsDpes) |
Check if passed DPEs have no invalid values. More... | |
fwTrending_getAndSaveFromTrendWidget () | |
get the currently displayed settings and saves them More... | |
fwTrending_saveSnapshot () | |
makes snapshot of the plot and saves it into a file (selected by user) More... | |
fwTrending_openZoomedWindow (string ref, dyn_string dsPlotData) | |
opens the zoomed trending window More... | |
void | fwTrending_openConfiguration (string sRef, dyn_string dsPlotData) |
opens the trending configuration window More... | |
fwTrending_save (string ref) | |
opens the trending "Save As" dialog window More... | |
fwTrending_saveAs (string ref, dyn_string dsPlotData, bool bCanUserEditPlot=true) | |
opens the trending "Save As" dialog window More... | |
fwTrending_toggleLog (bool state) | |
enable disable logarithmic scale More... | |
fwTrendingControl_autoScalePushed (bool state) | |
event callback for enable disable auto scale More... | |
fwTrendingTrendControl_setAutoscale (string trendName, bool state, dyn_string dsCurveRange, float minForLog, float maxPercentageForLog, string sIsLog) | |
enable disable auto scale More... | |
fwTrending_setCurveScaleVisibility (string ref, dyn_bool axii, int curveNumber, dyn_string dsDpe, dyn_string dsLegend) | |
enable disable Y scale for a selected curve More... | |
fwTrending_encodeTime (int &t, int d, int h, int m) | |
encode time as seconds More... | |
fwTrending_decodeTime (int t, int &d, int &h, int &m) | |
decode time from seconds to d,h,m More... | |
bool | _fwTrending_isAutoLimits (string sMinMaxRange, bool &bIsAuto) |
Check if Auto scale is selected. More... | |
void | fwTrending_copyPlot (string _from, string _to) |
fwTrending_setTimeScaleFormat (string trendName, dyn_string &exceptionInfo) | |
string | fwTrending_getColRow (dyn_string plotsList, int column, int row) |
This library contains utility functions for the Trending Tool.
07/08/2014: Marco Boccioli Fix for FWTREND-934
03/07/2014: Marco Boccioli Fix for FWTREND-924
03/07/2014: Marco Boccioli Fix for FWTREND-922
16/06/2014: Marco Boccioli Fix for FWTREND-916,FWTREND-925 -Merge ATLAS specific customizations -Duplicate the commands contained in of the Control bar Menu to the right-click menu -Added all menu entries to the right-click menu. -All captions backgrounds are now inheriting background from trending area.
03/06/2014: Marco Boccioli Fix for FWTREND-917
29/05/2014: Marco Boccioli Fix for FWTREND-915
28/08/2012: Marco Boccioli Fix for FWTREND-912
28/08/2012: Marco Boccioli Fix for FWTREND-883
28/08/2012: Johannes Lang Fix for FWTREND-872
13/04/2012: Johannes Lang Fix for FWTREND-865 and FWTREND-864
23/03/2012: Johannes Lang Fix for FWTREND-866:
16/06/2011: Marco Boccioli
29/01/2011: Marco Boccioli
02/12/2010: Marco Boccioli
12/11/2010: Marco Boccioli
11/11/2010: Marco Boccioli
27/10/2010: Marco Boccioli
27/10/2010: Marco Boccioli
05/10/2010: Marco Boccioli
20/08/2010: Marco Boccioli
20/08/2010: Marco Boccioli
04/08/2010: Marco Boccioli
30/07/2010: Marco Boccioli
30/06/2010: Marco Boccioli
26/05/2010: Marco Boccioli
29/04/2010: Marco Boccioli
06/04/2010: Marco Boccioli
25/03/2010: Marco Boccioli
02/07/2008: Herve (ref. in the code start/end 02/07/2008: Herve)
20/05/2008: Herve (ref. in the code start/end 20/05/2008: Herve)
10/06/2003: Herve added several functions 12/06/2003: Herve in the fwTrending_getPlotData function . add a check of dynlen(dsAxii) >= i before adding dsAxii[i]+";" othervise add to returnValue[12] to "FALSE;" because the axii may be empty if the axii visibility was never modified. . add a check of dynlen(dsLeg) >= i before adding dsLeg[i]+";" othervise add to returnValue[5] to ";" because the legend may be empty if the it was never modified. If the legend is empty the set it to dpe. in the function fwTrending_getPlotTitle . if the title is "", set t=it to sPlotName add the function fwTrending_showPlot: to show one or many plots and also the constant for plots position 17/06/2003: Herve added several functions modify the signature of fwTrending_showPlot: add dsReference as output param. 10/07/2003: Sascha - new functions and some modifications to some 14/07/2003: Sascha - some more modifications 17/07/2003: Sascha modify the functions fwTrending_getAllPlots and fwTrending_getAllPages to work in a distributed environment 10/09/2003: Herve add two internal function _fwTrending_openProgressBar and _fwTrending_closeProgressBar add in fwTrending_exportTrend the _fwTrending_openProgressBar and _fwTrending_closeProgressBar function call 20/01/2004: Sascha some modifications and deleted two functions deleted the function fwTrending_savePlotTitle: save the title of a plot deleted the function fwTrending_savePageTitle: save the title of a page
fwTrending_getAllPlots | ( | dyn_string & | plotDpNames, |
dyn_string & | exceptionInfo | ||
) |
Get all the plot DP names on all systems
plotDpNames | the list of plot dp names is returned here |
exceptionInfo | details of any exceptions are returned here |
fwTrending_getPlotDpNames | ( | dyn_string & | plotDpNames, |
dyn_string & | exceptionInfo, | ||
string | pattern = "*:*" |
||
) |
Get all the plot DP names that match the given pattern
plotDpNames | output, the list of plot dp names is returned here |
exceptionInfo | output, details of any exceptions are returned here |
pattern | inpupt, Optional parameter, default value "*:*" (all plots on all systems). Specify a filter to search for plots. |
fwTrending_getAllPages | ( | dyn_string & | pageDpNames, |
dyn_string & | exceptionInfo | ||
) |
Get all the page DP names on all systems
pageDpNames | the list of page dp names is returned here |
exceptionInfo | details of any exceptions are returned here |
fwTrending_getPageDpNames | ( | dyn_string & | pageDpNames, |
dyn_string & | exceptionInfo, | ||
string | pattern = "*:*" |
||
) |
Get all the page DP names that match the given pattern
pageDpNames | the list of page dp names is returned here |
exceptionInfo | details of any exceptions are returned here |
pattern | Optional parameter, default value "*:*" (all page on all systems). Specify a filter to search for page. |
fwTrending_deletePlot | ( | string | sPlotName, |
dyn_string & | exceptionInfo | ||
) |
Deletes a given plot data point
sPlotName | the data point name of the plot to delete |
exceptionInfo | details of any exceptions are returned here |
fwTrending_deletePage | ( | string | sPageName, |
dyn_string & | exceptionInfo | ||
) |
Deletes a given plot data point
sPageName | the data point name of the plot to delete |
exceptionInfo | details of any exceptions are returned here |
fwTrending_createPlot | ( | string | sPlotName, |
dyn_string & | exInfo, | ||
string | model = fwTrending_YT_PLOT_MODEL |
||
) |
Creates a plot data point. Checks are carried out if the name is valid or if it already exists.
sPlotName | the data point name of the plot to create |
exInfo | details of any exceptions are returned here |
model | OPTIONAL PARAMETER - default value fwTrending_YT_PLOT_MODEL (value over time plot) Defines the type of plot to be created, e.g. fwTrending_YT_PLOT_MODEL fwTrending_XY_PLOT_MODEL fwTrending_HISTOGRAM_PLOT_MODEL |
fwTrending_createPage | ( | string | sPageName, |
dyn_string & | exInfo, | ||
string | model = fwTrending_YT_PAGE_MODEL |
||
) |
Creates a page data point. The page configuration is initialised to default values.
Checks are carried out if the name is valid or if it already exists.
sPageName | the data point name of the page to create |
exInfo | details of any exceptions are returned here |
model | OPTIONAL PARAMETER - default value fwTrending_YT_PAGE_MODEL (value over time plot) Defines the type of plot to be created, e.g. fwTrending_YT_PAGE_MODEL fwTrending_XY_PAGE_MODEL |
void fwTrending_newPage | ( | string | _pageName, |
string | model = fwTrending_YT_PAGE_MODEL |
||
) |
Creates a page data point. The page configuration is initialised to default values.
THIS IS AN INTERNAL FUNCTION - If you want to create a page use fwTrending_createPage
_pageName | the data point name of the page to create |
model | OPTIONAL PARAMETER - default value fwTrending_YT_PAGE_MODEL (value over time plot) Defines the type of plot to be created, e.g. fwTrending_YT_PAGE_MODEL fwTrending_XY_PAGE_MODEL |
void fwTrending_newPlot | ( | string | sPlotName, |
string | sModel = fwTrending_YT_PLOT_MODEL |
||
) |
Creates a plot data point. The plot configuration is initialised to default values.
THIS IS AN INTERNAL FUNCTION - If you want to create a plot use fwTrending_createPlot
sPlotName | Input, string, the data point name of the plot to create |
sModel | Input, string OPTIONAL PARAMETER - default value fwTrending_YT_PLOT_MODEL (value over time plot) Defines the type of plot to be created, e.g. fwTrending_YT_PLOT_MODEL fwTrending_XY_PLOT_MODEL fwTrending_HISTOGRAM_PLOT_MODEL |
void fwTrending_copyPlotData | ( | string | _from, |
string | _to | ||
) |
Copies all the configuration data from a source plot to a target plot that already exists.
_from | the data point name of the source plot |
_to | the data point name of the target plot |
void fwTrending_copyPage | ( | string | _from, |
string | _to | ||
) |
Creates a new page and copies all the configuration data from a source page to the new page.
_from | the data point name of the source page |
_to | the data point name of the page to create |
fwTrending_initControlTrendButtons | ( | int | currentTimeRange, |
string | sRef, | ||
string | sDpName, | ||
string | sTrendLog, | ||
bool | bCallBack = true |
||
) |
Purpose: set the button state and value of the fwTrending/fwTrendingTrendControl.pnl.
This function is called by the initScript of the fwTrending/fwTrendingTrend.pnl. The sRef is mandatory in case of multiple plot sRef must be the reference given in the addSymbol function. The fwTrending/fwTrendingTrend.pnl reference must be sRef+"trend". If the sDpName is "" or not of type FwTrendingPlot, the option other->Plot configuration and Save settings is disabled If the access control is not used or not defined the option other->Plot configuration and Save settings is enabled as described above. If the access control is used and defined the option other->Plot configuration and Save settings is enabled as described above if the user loged in has the second level of priviledge of the first domain.
currentTimeRange | input, the time range at startup |
sRef | input, the reference given to with the addSymbol ("" if used directly as a plot or the symbol name in a page) |
sDpName | input, the plot DP or "" if using the $params to pass configure the plot |
sTrendLog | input, TRUE if this is a log trend. |
fwTrending_getDaysHoursMinutesFromTimeRange | ( | int | timeRange, |
int & | days, | ||
int & | hours, | ||
int & | minutes, | ||
dyn_string & | exceptionInfo | ||
) |
Purpose: get the amount of days, hours minutes from a specified time range (in s) to be shown on the trend.
timeRange | input, the time range (in seconds) to be converted. |
days | output, the amount of days in the time range |
hours | output, the amount of hours in the time range |
minutes | output, the amount of minutes in the time range |
exceptionInfo | output, any exceptions are returned here |
fwTrending_getTimeRangeFromDaysHoursMinutes | ( | int & | timeRange, |
int | days, | ||
int | hours, | ||
int | minutes, | ||
dyn_string & | exceptionInfo | ||
) |
Purpose: get the time range (in s) to be shown on the trend from a specified amount of days, hours minutes.
timeRange | output, the time range in seconds. |
days | input, the amount of days in the time range |
hours | input, the amount of hours in the time range |
minutes | input, the amount of minutes in the time range |
exceptionInfo | output, any exceptions are returned here |
fwTrending_initControlHistogramButtons | ( | string | ref, |
string | sDpName, | ||
dyn_string | plotData, | ||
bool | trendRunning, | ||
dyn_string | exceptionInfo, | ||
bool | bCallBack = true |
||
) |
Purpose: set the button state and value of the fwTrending/fwTrendingHistogramControl.pnl. This function is called by the initScript of the fwTrending/fwTrendingHistogram.pnl. The sRef is mandatory in case of multiple plot sRef must be the reference given in the addSymbol function. The fwTrending/fwTrendingHistogram.pnl reference must be sRef+"trend". If the sDpName is "" or not of type _FwTrendingPlot, the option other->Plot configuration and Save settings is disabled If the access control is not used or not defined the option other->Plot configuration and Save settings is enabled as described above. If the access control is used and defined the option other->Plot configuration and Save settings is enabled as described above if the user loged in has the second level of priviledge of the first domain.
ref | input, the reference given to with the addSymbol ("" if used directly as a plot or the symbol name in a page) |
sDpName | input, the plot DP or "" if using the $params to pass configure the plot |
plotData | input, the plot object that is being displayed in the display (contents of trendInfo object). |
trendRunning | input, TRUE if the trend is running, else FALSE. |
exceptionInfo | output, any exceptions are returned here |
_fwTrending_initGenericTrendControls | ( | string | ref, |
string | sDpName, | ||
string | showGrid, | ||
string | showLegend, | ||
dyn_string & | exceptionInfo, | ||
bool | bCallBack = true |
||
) |
Purpose: Do some setup of the trend display. This function works for both Value over time and Value over value plots.
ref | input, the reference given to with the addSymbol ("" if used directly as a plot or the symbol name in a page) |
sDpName | input, the plot DP or "" if using the $params to pass configure the plot |
showGrid | input, TRUE if grid is visible, else FALSE. |
showLegend | input, TRUE if legend is visible, else FALSE. |
exceptionInfo | output, any exceptions are returned here |
fwTrending_initControlTrendXYButtons | ( | int | currentTimeRange, |
string | sRef, | ||
string | sDpName, | ||
string | sTrendLog | ||
) |
Purpose: set the button state and value of the fwTrending/fwTrendingTrendXYControl.pnl.
This function is called by the initScript of the fwTrending/fwTrendingTrendXY.pnl. The sRef is mandatory in case of multiple plot sRef must be the reference given in the addSymbol function. The fwTrending/fwTrendingTrendXY.pnl reference must be sRef+"trend". If the sDpName is "" or not of type FwTrendingPlot, the option other->Plot configuration and Save settings is disabled If the access control is not used or not defined the option other->Plot configuration and Save settings is enabled as described above. If the access control is used and defined the option other->Plot configuration and Save settings is enabled as described above if the user loged in has the second level of priviledge of the first domain.
currentTimeRange | input, the time range at startup |
sRef | input, the reference given to with the addSymbol ("" if used directly as a plot or the symbol name in a page) |
sDpName | input, the plot DP or "" if using the $params to pass configure the plot |
sTrendLog | input, TRUE if this is a log trend. |
_fwTrending_initTimeRange | ( | int | currentTimeRange, |
string | ref, | ||
dyn_string & | exceptionInfo | ||
) |
This functions sets the time range cascade button, the time range element (to the right of the trend controls)
as well a hidden value text field. This function takes the given currentTimeRange in seconds and sets the graphical items in the display accordingly.
currentTimeRange | input, the time range at startup |
ref | input, the reference given to with the addSymbol ("" if used directly as a plot or the symbol name in a page) |
exceptionInfo | output, any exceptions are returned here |
_fwTrending_initTrendCaption | ( | int | curveNumber, |
dyn_string | dsDpe, | ||
dyn_dyn_string | ddsCurveParams, | ||
dyn_string | legendObj, | ||
dyn_string | valueObj, | ||
string | visibilityObj, | ||
dyn_string | dsUnit, | ||
dyn_string | unitObj, | ||
bool | visibility, | ||
dyn_string | curveTimeObj, | ||
bool | bEnabledVisibility | ||
) |
Purpose: set all the data of the trend caption, the caption contains 8 times: one per curvex (x from 1 to 8) . curveTimex . Textx: legend of the curve DPE . valueCurvex: value of the DPE . unitx: unit of the DPE . visibilityx: check box, visibility state of the curve
The trend caption must have the name trendCaption. curveTimex and valueCurvex are set by the trend
curveNumber | input, curve number |
dsDpe | input, DPE connected to the curve |
ddsCurveParams | input, curve parameters: [1]: legend of the DPE [2]: tool tip text of the DPE [3]: color of the curve |
legendObj | input, name of the legend graphical object |
valueObj | input, name of the valueCurve graphical object |
visibilityObj | input, name of the visibility check box graphical object |
dsUnit | input, unit of the DPE |
unitObj | input, name of the unit graphical object |
visibility | input, visibility state of curve |
curveTimeObj | input, name of the curveTime graphical object |
bEnabledVisibility | input, enable/disable the visibility check box |
_fwTrending_initCurve | ( | string | curveName, |
int | curveNumber, | ||
string | ref, | ||
dyn_string | dsLegendObj, | ||
dyn_string | dsValueObj, | ||
dyn_string | dsCurveDPE, | ||
dyn_string | dsCurveLegend, | ||
dyn_string | dsCurveToolTip, | ||
string | curveColor, | ||
dyn_bool | dbScaleVisibility, | ||
dyn_bool | dbIsLogTrend, | ||
string | curveVisibilityObj, | ||
dyn_string | dsUnit, | ||
dyn_string | dsUnitObj, | ||
bool | curveVisibility, | ||
string | trendShapeName, | ||
int | curvesType, | ||
dyn_string | dsCurveTimeObj, | ||
bool | bInitCaption, | ||
dyn_string & | exceptionInfo, | ||
int | markerType = 0 , |
||
dyn_int | diCurveScalePos = 0 , |
||
int | iCurveLink = 0 , |
||
string | sCurveStyle = fwTrending_DEFAULT_CURVE_STYLE , |
||
string | sLegendValFormat = fwTrending_DEFAULT_LEGEND_VALUE_FORMAT , |
||
string | sAxiiYFormat = fwTrending_DEFAULT_AXII_Y_FORMAT |
||
) |
Purpose: initialize the curve of the active trend, the other trend will have no data.
curveName | input, name of the curve |
curveNumber | input, curve number |
ref | input, reference of the trend |
dsLegendObj | input names of legend graphical objects |
dsValueObj | input, names of the valueCurve graphical objects |
dsCurveDPE | input, DPEs connected to the curves |
dsCurveLegend | input, legend of the DPEs |
dsCurveToolTip | input, tool tip text of the DPEs |
curveColor | input, color of the curve |
dbScaleVisibility | input, visibility state of the scale of the curves |
dbIsLogTrend | input, true if log trends |
curveVisibilityObj | input, name of the visibility check box graphical object |
dsUnit | input, units of the DPEs |
dsUnitObj | input, names of the unit graphical objects |
curveVisibility | input, visibility state of the scale of the curve |
trendShapeName | input, name of the active trend graphical object |
curvesType | input, type of the curve |
dsCurveTimeObj | input, names of the curveTime graphical objects |
bInitCaption | input, true to initialize the caption |
exceptionInfo | output, the exception is returned here |
markerType | input, optional, type of marker (default value = 7 - filled circle); |
diCurveScalePos | input, optional, SCALE_LEFT if the scale must be on the left, SCALE_RIGHT if must be on the right |
iCurveLink | input, optional, index of the curve, the current curve is supposed to be linked to; derives from a list of indices following this scheme: if curve 1 must be linked to curve 4, and curve 3 to 4, then it should be 4,0,4,0,0,0,0,0 |
sCurveStyle | input, optional, line style for the curves (default value = fwTrending_DEFAULT_CURVE_STYLE). |
sLegendValFormat | input, optional, numeric format of the value shown on the legend. Updated only after value changed. |
sAxiiYFormat | input, optional, numeric format of the scale o the Y axis. |
fwTrending_trendUpdateAlarmLimits | ( | string | ref, |
dyn_dyn_anytype | value | ||
) |
Updates the alarm limits by calling the fwTrending_toggleAlarmLimits() function. Serves as an artificial layer between initialization of the plot and alarm toggeling in order to realize a dpQueryConnectSingle() listening to any changes related the the _alert_hdl config.
ref | input, MANDATORY reference of the trend (any unique identifier possible) |
value | input, MANDATORY array with information from the SELECT statement of the dpQueryConnectSingle() |
fwTrending_trendUpdateScales | ( | string | sRef, |
dyn_dyn_string | ddsPlotData, | ||
string | sTrendName, | ||
dyn_string | exceptionInfo | ||
) |
Sets the minimum and maximum for the visible y-scales depending on the preferences set by the user
sRef | input, reference of the trend |
ddsPlotData | input, detailed information of the plot |
sTrendName | input, name of the trend for which to get the shape |
exceptionInfo | output, the exception is returned here |
fwTrending_clearAlarmLimits | ( | shape | trendShape, |
string | curveName, | ||
dyn_string | exceptionInfo | ||
) |
Remove all the alarm limits from the trending area.
trendShape | input, name of the active trend graphical object |
curveName | input, name of the curve for which to clear the alarms |
exceptionInfo | output, the exception is returned here |
fwTrending_toggleAlarmLimits | ( | string | curveName, |
string | curveDpeName, | ||
bool | curveLimitsVisible, | ||
shape | trendShape, | ||
dyn_string | exceptionInfo, | ||
string | sCurveStyle = fwTrending_DEFAULT_CURVE_STYLE , |
||
bool | clearLimits = FALSE |
||
) |
Show/hide the alarm limits related to a plotted dpe.
curveName | input, name of the curve |
curveDpeName | input, DPE connected to the curve |
curveLimitsVisible | input, visibility state of the limits of the curve |
trendShape | input, name of the active trend graphical object |
exceptionInfo | output, the exception is returned here |
sCurveStyle | input, optional, style of the curve. For an example of style, look at fwTrending_DEFAULT_CURVE_STYLE |
clearLimits | input, optional, if TRUE, then all the limits on the plot area are erased before showing/hiding them |
fwTrending_initTrendWithObject | ( | string | sRef, |
string | trendName, | ||
dyn_string | trendShapeStr, | ||
dyn_dyn_string | plotExtendedObject, | ||
bool | runTrend, | ||
bool | bInitCaption, | ||
dyn_string & | exceptionInfo, | ||
bool | passingCurveVisible = FALSE |
||
) |
Purpose: initialize the trends. This function is called from the initScript of the fwTrending/fwTrendingTrend.pnl and
the log check box of fwTrending/fwTrendingTrendControl.pnl. It stops the standard and log trend, sets the time range of both trends, initializes all the curves of the active trend and starts if necessary the active trend.
sRef | input, reference given when adding the corresponding panel, the panel containing the fwTrending/fwTrendingTrend.pnl and a caption or fwTrending/fwTrendingTrend.pnl must have the reference name of sRef+"trend" |
trendName | input, active trend name |
trendShapeStr | input, name of the trend graphical objects, [1]: standard trend [2]: log trend [3]: active trend |
plotExtendedObject | input, details of the plot are returned here (see fwTrending_PLOT_OBJECT.... constants for info on what needs to be passed as well as fwTrending_PLOT_OBJECT_EXT.... constants) |
runTrend | input, "TRUE" if the trend must be in running mode |
bInitCaption | input, "TRUE" if the trend caption should be initialised |
exceptionInfo | output, the exception is returned here |
passingCurveVisible | input {OPTIONAL - default = FALSE}, TRUE if passing curve visible state FALSE if passing curve hidden state |
fwTrending_initHistogramWithObject | ( | string | sRef, |
string | trendName, | ||
dyn_dyn_string | plotExtendedObject, | ||
bool | runTrend, | ||
dyn_string & | exceptionInfo | ||
) |
Purpose: initialize the histogram. This function is called from the initScript of the fwTrending/fwTrendingHistogram.pnl.
It configure the trend with the configuration passed in plotExtendedObject.
sRef | input, reference given when adding the corresponding panel, the panel containing the fwTrending/fwTrendingHistogram.pnl and a caption or fwTrending/fwTrendingHistogram.pnl must have the reference name of sRef+"trend" |
trendName | input, active trend name |
plotExtendedObject | input, details of the plot are returned here (see fwTrending_PLOT_OBJECT.... constants for info on what needs to be passed as well as fwTrending_PLOT_OBJECT_EXT.... constants) |
runTrend | input, "TRUE" if the trend must be in running mode, else FALSE |
exceptionInfo | output, the exception is returned here |
fwTrending_controlBarOnOff | ( | string | ref, |
int | visible | ||
) |
Show / hide the control menu bar and the bottom caption bar
ref | input, reference of the trend |
visible | input, visibility state of the control bar. It is used as a bit mask (bit 0 = control bar, bit 1 = caption bar). 0=visible, 1=hidden. int values: 0: control bar and caption bar visible (default) 1: control bar hidden, caption bar visible 2: control bar visible, caption bar hidden 3: control bar hidden, caption bar hidden |
fwTrending_toggleControlBar | ( | string | ref | ) |
Show / hide the control menu bar and the bottom caption bar depending on last status
ref | input, reference of the trend |
_fwTrending_connectToAlarmHandling | ( | string | ref, |
dyn_dyn_string | plotData | ||
) |
Sets the text box txtCurvesDpes with the list of dpes which are plotted together with alarms
This is used to change online the value of the plotted limits in case the alarm handling setting is changed by the user.
ref | input, reference of the trend |
plotData | input, details of the plot (see fwTrending_PLOT_OBJECT.... constants for info on what needs to be passed as well as fwTrending_PLOT_OBJECT_EXT.... constants) |
fwTrending_showStandardTrend | ( | bool | visibility, |
string | standardStr, | ||
string | logStr, | ||
dyn_dyn_string | plotData = "" |
||
) |
Show the standard or log trend
visibility | input, visibility state of the standard trend (TRUE to show standard trend, FALSE to show log trend) |
standardStr | input, name of the standard trend graphical element (with any reference name included e.g. ref.logTrend) |
logStr | input, name of the log trend graphical element (with any reference name included e.g. ref.standardTrend) |
plotData | optional input, plot data |
fwTrending_ShowCurve | ( | string | ref, |
string | trendName, | ||
int | curveNumber, | ||
bool | visibility | ||
) |
Purpose: show/hide a curve, this fucntion is called from the caption.
ref | input, the name of reference within which the trend objects are being displayed |
trendName | input, name of the graphical element containing the name of the active trend (usually "trend.activeTrendText") |
curveNumber | input, curve number to act on (from 1 to 8) |
visibility | input, visibility state of the curve |
fwTrending_getPage | ( | string | pageDp, |
dyn_dyn_string & | pageData, | ||
dyn_string & | exceptionInfo | ||
) |
Reads all the page configuration from a page datapoint.
pageDp | input, the page data point to read |
pageData | output, details of the page are returned here (see fwTrending_PAGE_OBJECT.... constants for info on what is returned) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_setPage | ( | string | pageDp, |
dyn_dyn_string | pageData, | ||
dyn_string & | exceptionInfo | ||
) |
Writes all the page configuration data to a page datapoint.
pageDp | input, the page data point to write to |
pageData | input, details of the page are passed here (see fwTrending_PAGE_OBJECT.... constants for info on what is returned) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getPlot | ( | string | sPlotDp, |
dyn_dyn_string & | ddsPlotData, | ||
dyn_string & | exceptionInfo | ||
) |
Reads all the plot configuration from a plot datapoint.
sPlotDp | Input, string, the plot data point to read |
ddsPlotData | Output, dyn_dyn_string, details of the plot are returned here (see fwTrending_PLOT_OBJECT.... constants for info on what is returned) |
exceptionInfo | Output, dyn_string, details of any exceptions are returned here |
fwTrending_setPlot | ( | string | sPlotDp, |
dyn_dyn_string | ddsPlotData, | ||
dyn_string & | exceptionInfo | ||
) |
Writes all the plot configuration data to a plot datapoint.
sPlotDp | Input, string, the plot data point to write to |
ddsPlotData | Input, dyn_dyn_string, details of the plot are passed here (see fwTrending_PLOT_OBJECT.... constants for info on what is returned) |
exceptionInfo | Output, dyn_string, details of any exceptions are returned here |
fwTrending_getPlotExtended | ( | string | plotDp, |
string | refName, | ||
dyn_dyn_string & | plotExtendedData, | ||
dyn_string & | exceptionInfo, | ||
bool | returnCurveVisible = FALSE |
||
) |
Reads all the plot configuration from a plot datapoint and does some additional processing to get all the data required to draw a plot.
plotDp | input, the plot data point to read |
refName | input, reference used in the addSymbol function, this is considered when getting the legend. |
plotExtendedData | output, details of the plot are returned here (see fwTrending_PLOT_OBJECT.... constants for info on what is returned as well as fwTrending_PLOT_OBJECT_EXT.... constants) |
exceptionInfo | output, details of any exceptions are returned here |
returnCurveVisible | input {OPTIONAL - default = FALSE}, TRUE to return curve visible state FALSE to return curve hidden state |
fwTrending_getPlotData | ( | string | ref, |
string | sDpName, | ||
dyn_string & | returnValue | ||
) |
Get the data from the DP of type FwTrendingPlot and return it in the format for the fwTrending/fwTrendingTrend.pnl
If ref is "" then the legend is taken but if it is not then we assume that this is a multiple plot panel and therefore the legend is set to the leaf DPE if any.
Please do not call this function directly. Instead, please use fwTrending_getPlot or fwTrending_getPlotExtended
ref | input, reference used in the addSymbol function, this is considered when getting the legend. |
sDpName | input, the plot data point to read |
returnValue | output, details of the plot are returned here |
fwTrending_getPlotDataDpeData | ( | string | sPlotDpe, |
string & | sDpe, | ||
string & | sUnit, | ||
string & | sDescription | ||
) |
Get the data related to a specific dpe to be plotted (real DPE, description and unit).
This function is able to deal with DPE or UNICOS format DPE: systemName:AliasName.DPELeaf
sPlotDpe | input, dpe of the FwTrendingPlot DP, real DP or UNICOS format DPE: systemName:AliasName.DPELeaf |
sDpe | output, real DPE |
sUnit | output, unit of the DPE |
sDescription | output, description of the DPE DPE |
fwTrending_getTitle | ( | string | sDpName, |
string & | sTitle, | ||
dyn_string & | exceptionInfo | ||
) |
Get the title of the given plot or page data point
sDpName | input, the data point name of the plot or page to read the title from |
sTitle | output, the title is returned here |
exceptionInfo | details of any exceptions are returned here |
fwTrending_getPlotTitle | ( | string | sDpPlotName, |
string & | sPlotTitle | ||
) |
Get the title of the given plot data point
sDpPlotName | input, the data point name of the plot to read the title from |
sPlotTitle | output, the title is returned here |
fwTrending_getPageTitle | ( | string | sDpPageName, |
string & | sPageTitle | ||
) |
Get the title of the given page data point
sDpPageName | input, the data point name of the page to read the title from |
sPageTitle | output, the title is returned here |
fwTrending_getPlotIsTemplate | ( | string | sDpPlotName, |
string & | bIsTemplate | ||
) |
Get the template status of the given plot data point
sDpPlotName | input, the data point name of the plot to check if template |
bIsTemplate | output, returns if the plot is flagged as template. TRUE = is template |
fwTrending_setPlotIsTemplate | ( | string | sDpPlotName, |
string | bIsTemplate | ||
) |
Set the template status of the given plot data point
sDpPlotName | input, the data point name of the plot to check if template |
bIsTemplate | input, if the plot is flagged as template. TRUE = is template |
fwTrending_showPlot | ( | int | iNumberOfPlots, |
dyn_string | dsPlotName, | ||
dyn_string & | dsReference, | ||
dyn_string | templateParameters | ||
) |
Show the plots at the necessary size and position on a page
iNumberOfPlots | input, the number of plots which are to be shown on the current page |
dsPlotName | input, the list of plot DP Names for this page |
dsReference | output, list of references of the plot symbols which were added |
templateParameters | input, contains any template parameter substitutions to be passed to the plots |
fwTrending_simplifyPagePlotList | ( | dyn_string | dsRawPlotList, |
int | rows, | ||
int | columns, | ||
dyn_string & | dsSimplePlotList, | ||
dyn_string & | exceptionInfo | ||
) |
Simplify the list of plots that comes from the page configuration dp
dsRawPlotList | input, the raw plot list from the page configuration dp |
rows | input, the number of rows on the page |
columns | input, the number of columns on the page |
dsSimplePlotList | output, the simplfied list of plots on the page |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_openProgressBar | ( | string | sHeader, |
string | sIcon, | ||
string | text1, | ||
string | text2, | ||
string | text3, | ||
int | iSliderType | ||
) |
Opens a progressBar as a childPanel. This function is the same as the openProgressBar from std.ctl but it opens the progress
bar as a childPanel. The difference between this function and the openProgressBar function is the dpSet of "_VarTrendOpen.PanelName:_original.._value" where "ProgressBar" is replaced byt myModuleName() and the ModuleOnWithPanel replaced with ChildPanelOnCentral().
sHeader | input, the hearder of the progress bar |
sIcon | input, the icon to show in the progress bar |
text1 | input, text to show in the progress bar |
text2 | input, text to show in the progress bar |
text3 | input, text to show in the progress bar |
iSliderType | input, the slider type, 0.. no slider, 1.. permanent slider, 2..normal slider |
dyn_string _fwTrending_cleanPlotObjectDPES | ( | dyn_string | plotObjectDPE | ) |
Prepare the elements of the plot object dpe (X and Y) arrays for external representation
plotObjectDPE | input, array of DPEs |
dyn_string _fwTrending_preparePlotObjectDPES | ( | dyn_string | plotObjectDPE | ) |
Prepare the elements of the plot object dpe (X and Y) arrays for internal alias representation
plotObjectDPE | input, array of DPEs |
string fwTrending_createAliasRepresentation | ( | string | sDp | ) |
Add the "@" to the provided string so WinCC can process an alias
sDp | input, datapoint string |
string fwTrending_cleanAliasRepresentation | ( | string | sDp | ) |
Remove the "@" from the provided string to hide the alias prefix from the UI
sDp | input, datapoint string |
_fwTrending_closeProgressBar | ( | ) |
Close the progress bar opend as a child panel. This function is the same as the closeProgressBar from std.ctl.
The difference between this function and the closeProgressBar function is the dpSet of "_VarTrendOpen.PanelName:_original.._value" where "ProgressBar" is replaced byt myModuleName()
void fwTrending_changeTrendTimeRange | ( | string | ref, |
int | range, | ||
string | refControl, | ||
string | localTimeRangeObjValue, | ||
int | itemPos, | ||
string | itemText | ||
) |
Change the time range of the trend which is currently being displayed.
The time range of the inactive trend is also updated.
ref | input, reference of the trend |
range | input, the time range in seconds |
refControl | input, reference of the trendControl |
localTimeRangeObjValue | input, the value in string format of the current time |
itemPos | input, position of the text in the cascade button that has to be modified |
itemText | input, the text to set for the entry in the cascade button |
_fwTrending_gotoNow | ( | shape | trendName, |
int | range | ||
) |
go to the current value of the trend.
Use different functions depending on the PVSS version.
trendName | input, reference of the trend |
range | input, the time range in seconds |
fwTrending_trendZoomX | ( | string | ref, |
bool | bZoomIn | ||
) |
Zoom in or out on the X axis of the trend.
ref | input, reference of the trend |
bZoomIn | input, TRUE to zoom in, FALSE to zoom out |
fwTrending_trendZoomY | ( | string | ref, |
bool | bZoomIn | ||
) |
Zoom in or out on the Y axis of the trend.
ref | input, reference of the trend |
bZoomIn | input, TRUE to zoom in, FALSE to zoom out |
fwTrending_trendRun | ( | string | ref, |
bool | bRunTrend, | ||
string | refControl | ||
) |
Run or Freeze the trend. The options in the trend controls are enabled/disable as appropriate
ref | input, reference of the trend |
bRunTrend | input, TRUE to run, FALSE to freeze |
refControl | input, reference of the trendControl |
fwTrending_gridOnOff | ( | string | ref, |
bool | bShowGrid, | ||
string | refControl, | ||
dyn_string & | exceptionInfo | ||
) |
Show or hide the grid of the trend
ref | input, reference of the trend |
bShowGrid | input, TRUE to show grid, FALSE to hide grid |
refControl | input, reference of the trendControl |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_markersOnOff | ( | string | ref, |
int | markerType, | ||
string | refControl, | ||
dyn_string & | exceptionInfo | ||
) |
Show or hide the markers of all the curves in the trend
ref | input, reference of the trend |
markerType | input, type of markers: fwTrending_MARKER_TYPE_FILLED_CIRCLE fwTrending_MARKER_TYPE_UNFILLED_CIRCLE fwTrending_MARKER_TYPE_NONE |
refControl | input, reference of the trendControl |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_legendOnOff | ( | string | ref, |
bool | bShowLegend, | ||
string | refControl, | ||
dyn_string & | exceptionInfo | ||
) |
Show or hide the legend of the trend
ref | input, reference of the trend |
bShowLegend | input, TRUE to show legend, FALSE to hide legend |
refControl | input, reference of the trendControl |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_trendUnzoom | ( | string | ref | ) |
Reset the zoom of the trend (1:1)
ref | input, reference of the trend |
fwTrending_trendZoomToAlarmLimits | ( | string | sReference | ) |
Zoom the trend area to the highest and lowest alarm limits by retaining a certain area visible above
and below these limits for a better overview.
sReference | input, reference of the trend shape |
fwTrending_trendRefresh | ( | string | ref | ) |
Refreshes the data displayed by the trend
ref | input, reference of the trend |
fwTrending_trendTimeBack | ( | string | ref, |
bool | bTimeBack | ||
) |
Set the time begin of a trend back or forward from the current time begin
ref | input, reference of the trend |
bTimeBack | input, true go back in time, false go forward in time back in time: newTimeBegin=currentTimeBegin-(period(currentTimeEnd)-period(currentTimeBegin))/fwTrending_TIME_BACK_RESOLUTION forward in time: newTimeBegin=currentTimeBegin+(period(currentTimeEnd)-period(currentTimeBegin))/fwTrending_TIME_FORWARD_RESOLUTION if newTYimeBegin > current time, no newTimeBegin is set. |
fwTrending_pageSavePlotSettings | ( | string | ref | ) |
Take the sDpName of the plot configuration and save the plot settings of a plot
ref | input, reference of the trend |
fwTrending_saveCurrentSettings | ( | string | ref, |
string | sDpName, | ||
string | sDpType, | ||
bool | createNewDpIfRequired, | ||
bool | overwriteExisting, | ||
dyn_string & | exceptionInfo, | ||
bool | useDpNameForTitle = FALSE |
||
) |
Save the current runtime plot configuration to a plot data point
ref | input, reference of the trend |
sDpName | input, the data point name to save the plot configuration to |
sDpType | input, the dp type of the data point to save the plot configuration to |
createNewDpIfRequired | input, TRUE to create new dp if sDpName does not exist, else FALSE |
overwriteExisting | input, TRUE to overwrite any existing contents of sDpName, else FALSE |
exceptionInfo | output, details of any exceptions are returned here |
useDpNameForTitle | input, Optional parameter - default FALSE FALSE - use plot title from currently displayed instance TRUE - change plot title of new plot to the same as sDpName |
fwTrending_pageExportTrend | ( | dyn_string | dsRef, |
string | templateParameters, | ||
string | sSave = "FALSE" |
||
) |
Export the data displayed in all the plots of a page to a CSV file
dsRef | input, list of reference of the trends |
templateParameters | input, any template parameter substitutions |
fwTrending_exportTrend | ( | string | sFileName, |
dyn_string | dsCurveDPE, | ||
dyn_string | dsLegendCurve, | ||
dyn_time | dtStart, | ||
dyn_time | dtEnd, | ||
string | sTemplateParameters, | ||
dyn_string & | exceptionInfo, | ||
bool | bFillEmptyCells = FALSE |
||
) |
Export the history of the given dpes, between the given times to a CSV file
sFileName | input, file name to export the data to |
dsCurveDPE | input, list of DPEs to export the data from |
dsLegendCurve | input, list of associated legends to use a headers in the file |
dtStart | input, start time for the query of the DPEs (one time per dpe) |
dtEnd | input, end time for the query of the DPEs (one time per dpe) |
sTemplateParameters | input, any template parameter substitutions |
exceptionInfo | output, details of any exceptions are returned here |
bFillEmptyCells | input, Optional parameter - default FALSE: FALSE - just put data from history into file TRUE - apply 0th order interpolation to fill all cells in file (easier for automatic analysis) |
string fwTrending_modify_CSV_characters | ( | string | sTextInput | ) |
Transform special characters to be compatible with CSV file format standard.
Special characters are:
sTextInput | input, string to check and if any special character appears transform it. |
fwTrending_eventsSort | ( | dyn_dyn_time | ddt, |
dyn_dyn_bool & | events, | ||
dyn_time & | times | ||
) |
Sort the data of multiple dpGetPeriod calls. Data is reorganised into order of time stamp.
ddt | input, list of the time stamps from each dpGetPeriod call |
events | output, a 2-dimensional giving a dyn_bool for each timestamp in 'times'. Each dyn_bool contains a list of bools, one for each dpGetPeriod to say if the dpGetPeriod returned data for that given timestamp and hence which dpe had a value at that timestamp. |
times | output, a sorted list of the timestamps in ddt |
fwTrending_convertStringToDyn | ( | string | valueString, |
dyn_anytype & | valueList, | ||
dyn_string & | exceptionInfo | ||
) |
Convert a string which is seperated by the fwTrending_CONTENT_DIVIDER into a dyn_string.
The resulting dyn_string will always have at least fwTrending_TRENDING_MAX_CURVE entries.
valueString | input, string to be split |
valueList | output, the dyn_string containing the parts of the original string |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_convertDynToString | ( | dyn_anytype | valueList, |
string & | valueString, | ||
dyn_string & | exceptionInfo | ||
) |
Convert a dyn_string to a string which is seperated by the fwTrending_CONTENT_DIVIDER.
The resulting string will always have at least fwTrending_TRENDING_MAX_CURVE dividers.
valueList | input, the dyn_string to be put into the string |
valueString | output, the fwTrending_CONTENT_DIVIDER seperated string |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getAllTemplateParametersForConfiguration | ( | dyn_dyn_string | configurationData, |
string | configurationType, | ||
dyn_string & | templateParameters, | ||
dyn_string & | exceptionInfo | ||
) |
Find all the template parameters required to display a given plot or page.
configurationData | input, the configuration data for the plot or page |
configurationType | input, the type of configuration, either fwTrending_PLOT or fwTrending_PAGE |
templateParameters | output, the list of required template parameters is returned here |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_evaluateTemplate | ( | string | givenParametersString, |
dyn_string & | expressionList, | ||
dyn_string & | exceptionInfo | ||
) |
Substitute the values of template parameters into a given list of string.
givenParametersString | input, the string which contains the definitions of the template parameters |
expressionList | input/output, the list of values that might need substitutions is passed and the version with the necessary substitutions is returned. |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_rebuildDpeUNICOS | ( | dyn_string | dpes, |
dyn_string & | fileDpe | ||
) |
Convert a list of PVSS style dpes to UNICOS style dpes
dpes | input, list of PVSS dpes |
fileDpe | output, list of UNICOS format dpes |
fwTrending_convertUnicosDpeStringToPvssDpeString | ( | string | unicosDpes, |
string & | pvssDpes, | ||
dyn_string & | exceptionInfo | ||
) |
Convert a fwTrending_CONTENT_DIVIDER seperated string of UNICOS style dpes
to a fwTrending_CONTENT_DIVIDER seperated string of PVSS style dpes
unicosDpes | input, the fwTrending_CONTENT_DIVIDER seperated string of UNICOS dpes |
pvssDpes | output, a fwTrending_CONTENT_DIVIDER seperated string of PVSS style dpes is returned here |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_convertPvssDpeListToUnicosDpeList | ( | dyn_string | pvssDpes, |
dyn_string & | unicosDpes, | ||
dyn_string & | exceptionInfo | ||
) |
Convert a list of PVSS style dpes to a list of UNICOS style dpes
pvssDpes | input, a list of PVSS style dpes |
unicosDpes | output, a list of UNICOS dpes is returned here |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_convertUnicosDpeListToPvssDpeList | ( | dyn_string | unicosDpes, |
dyn_string & | pvssDpes, | ||
dyn_string & | exceptionInfo | ||
) |
Convert a list of UNICOS style dpes to a list of PVSS style dpes
unicosDpes | input, a list of UNICOS dpes |
pvssDpes | output, a list of PVSS style dpes is returned here |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_checkCurveName | ( | string | dpe, |
bool & | tempBool, | ||
dyn_string & | exceptionInfo | ||
) |
Check a given curve name is a legal data point name. Template parameter markers are allowed.
dpe | input, the dpe name to check |
tempBool | output, TRUE if valid, else FALSE |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_splitParameters | ( | string | parameters, |
dyn_dyn_string & | dsParameters | ||
) |
Split the template parameter definition string into a list of template parameter names and values
parameters | input, the list which contains the definitions of the template parameters |
dsParameters | output, dsParameters[1] = list of names of parameters dsParameters[2] = list of values of parameters |
fwTrending_checkAndGetAllTemplateParameters | ( | string | uniqueIdentifier, |
dyn_dyn_string | configurationData, | ||
string | configurationType, | ||
string & | currentParameters, | ||
dyn_string & | exceptionInfo, | ||
bool | relativePosition = FALSE , |
||
bool | returnDefaultIfCancel = FALSE |
||
) |
Compare the template parameters required by the given configuration with the current defined template parameters
uniqueIdentifier | input, a unique identifier for this plot on the panel. e.g. the reference name |
configurationData | input, the configuration data for the plot or page |
configurationType | input, the type of configuration, either fwTrending_PLOT or fwTrending_PAGE |
currentParameters | input/output, the currently defined template parameters is passed here in string format the updated list is returned here when the function is finished |
exceptionInfo | output, details of any exceptions are returned here |
relativePosition | input, Optional parameter - default value = FALSE FALSE - show the dialog in the centre TRUE - show the dialog relative to the calling object |
returnDefaultIfCancel | input, Optional parameter - default value = FALSE FALSE - if the user presses cancel, leave currentParameters as it was passed TRUE - if the user presses cancel, set each parameter to its default value (i.e. the name of the parameter) |
fwTrending_modifyAllTemplateParameters | ( | string | uniqueIdentifier, |
dyn_dyn_string | configurationData, | ||
string | configurationType, | ||
string & | currentParameters, | ||
dyn_string & | exceptionInfo, | ||
bool | relativePosition = FALSE |
||
) |
Allows for modification of the values of the template parameters.
uniqueIdentifier | input, a unique identifier for this plot on the panel. e.g. the reference name |
configurationData | input, the configuration data for the plot or page |
configurationType | input, the type of configuration, either fwTrending_PLOT or fwTrending_PAGE |
currentParameters | input/output, the currently defined template parameters is passed here in string format the updated list is returned here when the function is finished |
exceptionInfo | output, details of any exceptions are returned here |
relativePosition | input, Optional parameter - default value = FALSE FALSE - show the dialog in the centre TRUE - show the dialog relative to the calling object |
fwTrending_checkAllTemplateParameters | ( | dyn_string & | requiredParameters, |
string | givenParameterString, | ||
bool & | gotValuesForAll, | ||
dyn_string & | exceptionInfo | ||
) |
Compare the list of the required template parameters with the contents of the $templateParameters
requiredParameters | input/output, the list of required template parameters |
givenParameterString | input, the contents of $templateParameter in the standard string format |
gotValuesForAll | output, the configuration data to find the parameters in |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_mergeParameterLists | ( | string | firstList, |
string | secondList, | ||
string & | returnedList, | ||
dyn_string & | exceptionInfo | ||
) |
Merge two lists of template parameters into a single string.
If a value is specified in both lists, the value from the first list has precedence, unless the value in the first list starts with { and ends with } (i.e. is an undefined template parameter)
firstList | input, one list of template parameters in string format |
secondList | input, another list of template parameters in string format |
returnedList | output, the merged list is returned here is string format |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_findTemplateParameters | ( | dyn_dyn_string | data, |
dyn_string & | parametersFound, | ||
dyn_string & | exceptionInfo | ||
) |
Find the template parameters required for a given plot or page configuration.
data | input, the configuration data to find the parameters in |
parametersFound | output, a list of all the template parameters which were found |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_setRuntimePlotDataWithExtendedObject | ( | string | refName, |
string | isRunning, | ||
dyn_dyn_string | plotExtendedObject, | ||
dyn_string & | exceptionInfo, | ||
bool | runningInsideTrend = TRUE |
||
) |
Set the runtime plot data with the given extended plot configuration.
refName | input, the reference name of the trend |
isRunning | input, "TRUE" if the plot should be running, else "FALSE" |
plotExtendedObject | input, the extended plot object to set as the runtime data (as defined by fwTrending_PLOT_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
runningInsideTrend | input, Optional parameter - default TRUE TRUE if call is from within the same referecne as the trend, else FALSE |
fwTrending_setRuntimePlotDataWithStrings | ( | string | refName, |
string | isRunning, | ||
dyn_string | plotData, | ||
dyn_string & | exceptionInfo, | ||
bool | runningInsideTrend = TRUE |
||
) |
Set the runtime plot data with the given plot configuration (in dyn_string format)
refName | input, the reference name of the trend |
isRunning | input, "TRUE" if the plot should be running, else "FALSE" |
plotData | input, the plot data to set as the runtime data (as defined by fwTrending_PLOT_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
runningInsideTrend | input, Optional parameter - default TRUE TRUE if call is from within the same referecne as the trend, else FALSE |
fwTrending_setRuntimePageDataWithObject | ( | dyn_dyn_string | pageObject, |
dyn_string & | exceptionInfo | ||
) |
Set the runtime page data with the given page configuration
pageObject | input, the page object to set as the runtime data (as defined by fwTrending_PAGE_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getRuntimePageDataWithObject | ( | dyn_dyn_string & | pageObject, |
dyn_string & | exceptionInfo | ||
) |
Get the runtime page data
pageObject | output, the runtime data is returned in this page object (as defined by fwTrending_PAGE_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_setRuntimePageDataWithStrings | ( | dyn_string | pageData, |
dyn_string & | exceptionInfo | ||
) |
Set the runtime page data with the given page configuration (in dyn_string format)
pageData | input, the page data to set as the runtime data (as defined by fwTrending_PAGE_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getRuntimePageDataWithStrings | ( | dyn_string & | pageData, |
dyn_string & | exceptionInfo | ||
) |
Get the runtime page data
pageData | output, the runtime data is returned here in dyn_string format (as defined by fwTrending_PAGE_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getRuntimePlotDataWithStrings | ( | string | refName, |
string & | isRunning, | ||
dyn_string & | plotShapes, | ||
dyn_string & | plotData, | ||
dyn_string & | exceptionInfo, | ||
bool | runningInsideTrend = TRUE |
||
) |
Get the runtime plot data
refName | input, the reference name of the trend |
isRunning | output, "TRUE" if the plot is be running, else "FALSE" |
plotShapes | output, the list of plot shapes is returned here - standard, log and active |
plotData | output, the plot data is returned here (in dyn_string format) (as defined by fwTrending_PLOT_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
runningInsideTrend | input, Optional parameter - default TRUE TRUE if call is from within the same referecne as the trend, else FALSE |
fwTrending_getRuntimePlotDataWithExtendedObject | ( | string | refName, |
string & | isRunning, | ||
dyn_string & | plotShapes, | ||
dyn_dyn_string & | plotExtendedObject, | ||
dyn_string & | exceptionInfo, | ||
bool | runningInsideTrend = TRUE |
||
) |
Get the runtime plot data
refName | input, the reference name of the trend |
isRunning | output, "TRUE" if the plot is be running, else "FALSE" |
plotShapes | output, the list of plot shapes is returned here - standard, log and active |
plotExtendedObject | output, the plot object is returned here (as defined by fwTrending_PLOT_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
runningInsideTrend | input, Optional parameter - default TRUE TRUE if call is from within the same referecne as the trend, else FALSE |
_fwTrending_syncDifferentRangeFormats | ( | string & | minRange, |
string & | maxRange, | ||
string & | combinedRange, | ||
dyn_string & | exceptionInfo | ||
) |
The min max range is stored in two ways in the plot object for legacy reasons.
One way is with the min and max ranges stored in two different places, the second is with both min and max ranges combined together. This function ensures that the data is consistent between the two places. By passing fwTrending_CONTENT_DIVIDER seperated lists of the minranges, maxranges and combined min:maxranges the function makes them consistent.
minRange | input, fwTrending_CONTENT_DIVIDER seperated list of min ranges |
maxRange | input, fwTrending_CONTENT_DIVIDER seperated list of max ranges |
combinedRange | input, fwTrending_CONTENT_DIVIDER seperated list of combined min/max ranges |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_switchCurvesHiddenVisible | ( | dyn_string & | currentCurveStatus, |
dyn_string & | exceptionInfo | ||
) |
In some situations, curve visibility is used and in some curve hidden state is given. These are logical opposites.
This function swtiches between the two by inverting all the entries in the given list.
currentCurveStatus | input/output, the list of values is passed here and is returned inverted |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getNumberOfCurves | ( | string | plotDp, |
int & | numberOfCurves, | ||
dyn_string & | exceptionInfo | ||
) |
Gets the number of curves that are defined in a plot configuration data point
plotDp | input, the name of the plot configuration data point |
numberOfCurves | output, the number of defined curves in the configuration is returned here |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getFirstFreeCurve | ( | string | plotDp, |
int & | position, | ||
dyn_string & | exceptionInfo | ||
) |
Gets the position of the first undefined curve in a plot configuration data point.
If there are no free curves, the position -1 is returned.
plotDp | input, the name of the plot configuration data point |
position | output, the position of first undefined curve in the configuration is returned here |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getFreeCurves | ( | string | plotDp, |
dyn_int & | positions, | ||
dyn_string & | exceptionInfo | ||
) |
Gets a list of the positions of undefined curves in a plot configuration data point
plotDp | input, the name of the plot configuration data point |
positions | output, a list of the positions of undefined curve in the configuration is returned here |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_setCurve | ( | string | plotDp, |
dyn_string | curveData, | ||
int | curveToSet, | ||
dyn_string & | exceptionInfo | ||
) |
Sets a given curve configuration to a certain curve position of a plot configuration data point
plotDp | input, the name of the plot configuration data point |
curveData | input, a curve data object (as defined by fwTrending_CURVE_OBJECT_... constants) |
curveToSet | input, the position in which to set this curve |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_setManyCurves | ( | string | plotDp, |
dyn_dyn_string | curvesData, | ||
dyn_int | curvesToSet, | ||
dyn_string & | exceptionInfo | ||
) |
Sets many curve configurations to certain curve positions of a plot configuration data point
plotDp | input, the name of the plot configuration data point |
curvesData | input, a list of curve data objects (as defined by fwTrending_CURVE_OBJECT_... constants) |
curvesToSet | input, the positions in which to set these curves |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_getCurve | ( | string | plotDp, |
bool & | isCurveDefined, | ||
dyn_string & | curveData, | ||
int | curveToGet, | ||
dyn_string & | exceptionInfo | ||
) |
Get the curve configuration from a specified curve position of a plot configuration data point
plotDp | input, the name of the plot configuration data point |
isCurveDefined | output, TRUE is curve is defined, else FALSE |
curveData | output, the curve data configuration object is returned here (as defined by fwTrending_CURVE_OBJECT_... constants) |
curveToGet | input, the position of the curve to get |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_appendCurve | ( | string | plotDp, |
dyn_string | curveData, | ||
dyn_string & | exceptionInfo | ||
) |
Appends a curve configuration to the first undefined curve position of a plot configuration data point
plotDp | input, the name of the plot configuration data point |
curveData | input, a curve data object (as defined by fwTrending_CURVE_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_appendManyCurves | ( | string | plotDp, |
dyn_dyn_string | curvesData, | ||
dyn_string & | exceptionInfo | ||
) |
Appneds many curve configurations to the first undefined curve positions of a plot configuration data point
plotDp | input, the name of the plot configuration data point |
curvesData | input, a list of curve data objects (as defined by fwTrending_CURVE_OBJECT_... constants) |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_deleteManyCurves | ( | string | plotDp, |
dyn_int | curvesToDelete, | ||
dyn_string & | exceptionInfo | ||
) |
Delete many curve configurations from the specified curve positions of a plot configuration data point.
plotDp | input, the name of the plot configuration data point |
curvesToDelete | input, the positions of the curves to delete |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_removeCurve | ( | string | plotDp, |
int | curveToRemove, | ||
dyn_string & | exceptionInfo | ||
) |
Remove a curve configuration from the specified curve position of a plot configuration data point.
The curves from later positions are moved one position back to remove the space left by the removal of the curve. Similar in concept to dynRemove().
plotDp | input, the name of the plot configuration data point |
curveToRemove | input, the position of the curve to remove |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_checkCurveData | ( | dyn_string & | curveData, |
int | position, | ||
dyn_string & | exceptionInfo | ||
) |
Checks curve object and fills in any missing values with default data.
curveData | input/output, the curve object to check |
position | input, the intended position of the curve (used for making default data e.g. curve colour) |
exceptionInfo | output, details of any exceptions are returned here |
int _fwTrending_getCurveObjectIndexes | ( | dyn_int & | curveObjectIndexes, |
dyn_int & | plotObjectIndexes, | ||
dyn_string & | exceptionInfo | ||
) |
This function returns two lists of integers representing certain indexes of the curveData object and the plotData object.
All the curveData object indexes are returned, and the corresponding indexes of the plotData object where the curveData should be stored are also returned.
curveObjectIndexes | output, The indexes of the curveData object are returned here |
plotObjectIndexes | output, The corresponding indexes of the plotData object are returned here |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_openPlotDisplay | ( | string | sPlotDpName, |
string | sPanelFileName, | ||
bool | bAsNewModule, | ||
bool | bStayOnTopOrModal, | ||
string | sModuleName, | ||
string | sPanelName, | ||
unsigned | x = 0 , |
||
unsigned | y = 0 , |
||
string | sResizeMode = "" |
||
) |
Opens a plot display with various options as to how it is opened.
sPlotDpName | input, the plot data point name to show |
sPanelFileName | input, the file name of the panel to use (use constants such as fwTrending_PANEL_PLOT_STANDARD) |
bAsNewModule | input, should the display be opened in a new module, TRUE = new module, FALSE = child panel |
bStayOnTopOrModal | input, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour |
sModuleName | input, the name of the new module (if required) |
sPanelName | input, the name of the new panel |
x | input, Optional parameter - default value 0. X position of the new display |
y | input, Optional parameter - default value 0. Y position of the new display |
sResizeMode | input, Optional parameter - default value "". "" Default from the config file (see config entry visionResizeMode chapter User interface on PVSS Help) "None" ... Scaling not possible in the VISION module. "Scale" ... Scaling possible in the VISION module by changing the size of the window. "Zoom" ... Scaling only possible with the Navigator |
_fwTrending_isSystemForDpeConnected | ( | string | curveDpe, |
bool & | isConnected, | ||
dyn_string & | exceptionInfo | ||
) |
Check if the system that a dpe is on is connected or not
curveDpe | input, the data point element that you want to access |
isConnected | output, TRUE if required system is connected, else FALSE |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_isSystemConnected | ( | string | systemName, |
bool & | isConnected, | ||
dyn_string & | exceptionInfo | ||
) |
Check if the given system ID is of a system which is connected or not
systemName | input, name of the system that you want to access |
isConnected | output, TRUE if required system is connected, else FALSE |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_getConnectedSystemIds | ( | dyn_int & | systemIds, |
dyn_string & | exceptionInfo | ||
) |
Get a list of the IDs of all connected systems (including local system)
systemIds | output, list of IDs of all connected systems |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_updateHistogram | ( | string | dpa, |
dyn_float | value | ||
) |
Work function called to update the histogram display when the data source dyn_dpe is modified.
dpa | The name of the dpa that changed |
value | The new value of the dpe |
_fwTrending_convertPlotDataToDollars | ( | dyn_dyn_string | plotData, |
dyn_string & | dollarParameters, | ||
dyn_string & | exceptionInfo | ||
) |
Convert a plotData object to a list of $params ready to pass to a trend display.
plotData | input, The plot data object (dyn_dyn_string) |
dollarParameters | output, The list of $ parameters to be passed to a trend display based on the data in plotData |
exceptionInfo | output, details of any exceptions are returned here |
_fwTrending_preparePlotObjectForDisplay | ( | dyn_dyn_string & | plotData, |
string | parameterString, | ||
dyn_string & | exceptionInfo | ||
) |
Prepare a plot data object to display.
This involves: 1) Substituting the template parameters for the known values. 2) Re-getting the extended plot information. This updates the legend texts, units and descriptions with the latest values of the template parameters. 3) Converting any UNICOS style DPEs to PVSS DPEs
plotData | input/output, The plot data object (dyn_dyn_string) |
parameterString | output, The string containing the template parameters and values |
exceptionInfo | output, details of any exceptions are returned here |
fwTrending_addQuickFaceplate | ( | string | moduleName, |
string | panelName, | ||
string | refName, | ||
dyn_string | dpesToPlot, | ||
int | x, | ||
int | y, | ||
dyn_string & | exceptionInfo, | ||
string | plotDpName = "_FwTrendingQuickPlotDefaults" , |
||
float | xScale = 1.0 , |
||
float | yScale = 1.0 |
||
) |
This function provides an easy way of adding a faceplate to plot a given list of dpes
to a panel as a symbol (instead of using addSymbol() directly).
moduleName | the name of the module on which the faceplate should be added |
panelName | the name of the module on which the faceplate should be added |
refName | the reference name of the new symbol to be added to the panel (can not be "") This name is used as the faceplate plot title |
dpesToPlot | the list of dpes to show in the plot |
x | the x position on the panel to add the symbol |
y | the y position on the panel to add the symbol |
exceptionInfo | output, details of any exceptions are returned here |
plotDpName | OPTIONAL PARAMETER: The plot dp name to use a a template from which the plot configuration is read (all configuration of the plot except the dpes to plot). If not specified the standard QuickPlot defaults data point is used. |
xScale | OPTIONAL PARAMETER: A scaling factor to be applied in the X axis, default value 1.0 |
yScale | OPTIONAL PARAMETER: A scaling factor to be applied in the Y axis, default value 1.0 |
fwTrending_addFaceplate | ( | string | moduleName, |
string | panelName, | ||
string | refName, | ||
string | plotDpName, | ||
dyn_string | templateParameterNames, | ||
dyn_string | templateParameterValues, | ||
int | x, | ||
int | y, | ||
dyn_string & | exceptionInfo, | ||
float | xScale = 1.0 , |
||
float | yScale = 1.0 |
||
) |
This function provides an easy way of adding a faceplate to show a given predefined plot dp
to a panel as a symbol (instead of using addSymbol() directly).
moduleName | the name of the module on which the faceplate should be added |
panelName | the name of the module on which the faceplate should be added |
refName | the reference name of the new symbol to be added to the panel (can not be "") This name is used as the faceplate plot title |
plotDpName | the plot data point to use for the configuration of the faceplate |
templateParameterNames | a list of any template parameters that you wish to pass |
templateParameterValues | a list of value for template parameters named in templateParameterNames |
x | the x position on the panel to add the symbol |
y | the y position on the panel to add the symbol |
exceptionInfo | output, details of any exceptions are returned here |
xScale | optional, scaling factor for x (default=1) |
yScale | optional, scaling factor for y (default=1) |
fwTrending_removeFaceplate | ( | string | moduleName, |
string | panelName, | ||
string | refName, | ||
dyn_string & | exceptionInfo | ||
) |
This function provides an easy way of removing a faceplate that was addded with the fwTrending_addFaceplate
or fwTrending_addQuickFaceplate functions.
moduleName | the name of the module on which the faceplate is displayed |
panelName | the name of the module on which the faceplate is displayed |
refName | the reference name of the faceplate to remove |
exceptionInfo | output, details of any exceptions are returned here |
bool _fwTrending_isUnicosEnvironment | ( | dyn_string & | exceptionInfo | ) |
This function checks if the Trending Tool is running in a project where UNICOS FW is installed.
exceptionInfo | output, details of any exceptions are returned here |
dyn_string fwTrending_getPlotTreeTagNames | ( | ) |
This function returns the list of Trending Tool Plot configuration attributes (i.e. dpe names) corresponding to the indexes as defined in the constants definitions. This function is needed by unTree during import/export of trending settings.
dyn_string fwTrending_getPageTreeTagNames | ( | ) |
This function returns the list of Trending Tool Page configuration attributes (i.e. dpe names) corresponding to the indexes as defined in the constants definitions. This function is needed by unTree during import/export of trending settings.
bool fwTrending_isPlotTreeTagExportable | ( | int | iTagIndex | ) |
This function checks if the index corresponding to a specific item of Trending Tool Plot configuration attributes (i.e. dpe names) can be exported or not. It accepts all the constants like fwTrending_PLOT_OBJECT_... This function is needed by unTree during import/export of trending settings.
iTagIndex | index corresponding to the Plot configuration attribute. Any of the constants like fwTrending_PLOT_OBJECT_... |
bool fwTrending_isDpName | ( | string | sDp | ) |
Purpose: Checks if the provided info is a datapoint name
sDp | input, name of the datapoint to be checked |
bool fwTrending_isAlias | ( | string | sDp | ) |
Purpose: Checks if the provided info is an alias
sDp | input, name of the datapoint to be checked |
bool fwTrending_isPageTreeTagExportable | ( | int | iTagIndex | ) |
This function checks if the index corresponding to a specific item of Trending Tool Page configuration attributes (i.e. dpe names) can be exported or not. It accepts all the constants like fwTrending_PAGE_OBJECT_... This function is needed by unTree during import/export of trending settings.
iTagIndex | index corresponding to the Page configuration attribute. Any of the constants like fwTrending_PAGE_OBJECT_... |
string _fwTrending_appendDotTo | ( | string | ref | ) |
Purpose: Append a dot "." to the refName because this function is called from the fwTrending/fwTrendingTrend.pnl
ref | the name of the used reference |
string _fwTrending_adjustRefName | ( | string | ref | ) |
Purpose: Append "trend." to the refName because of a multiple plot and the ref will be ref+"trend."
ref | the name of the used reference |
dyn_string fwTrending_getCurrentScaleMinMaxRanges | ( | string | sReferenceName | ) |
Get the min and max values of all y-scales in the currently visible trend.
[in] | sReferenceName | The reference as string |
dyn_string fwTrending_getCurrentScaleMinMaxRangesX | ( | string | sReferenceName | ) |
Get the min and max values of the x-scale in the currently visible value over value trend.
[in] | sReferenceName | The reference as string |
dyn_string fwTrending_getCurrentScaleVisibilities | ( | string | sReferenceName | ) |
Get scale visibility all y-scales in the currently visible trend.
[in] | sReferenceName | string, the reference |
bool fwTrending_valuesAreValid | ( | dyn_string | dsDpes | ) |
Check if passed DPEs have no invalid values.
Checks for DPEs storing numbers that their values are indeed numbers (finite values).
[in] | dsDpes | dyn_string, the DPEs to be checked |
fwTrending_getAndSaveFromTrendWidget | ( | ) |
get the currently displayed settings and saves them
fwTrending_saveSnapshot | ( | ) |
makes snapshot of the plot and saves it into a file (selected by user)
activeTrendShape | the trending shape |
fwTrending_openZoomedWindow | ( | string | ref, |
dyn_string | dsPlotData | ||
) |
opens the zoomed trending window
ref | the trending shape name |
dsPlotData | the trending data |
void fwTrending_openConfiguration | ( | string | sRef, |
dyn_string | dsPlotData | ||
) |
opens the trending configuration window
ref | the trending shape name |
dsPlotData | the trending data |
fwTrending_save | ( | string | ref | ) |
opens the trending "Save As" dialog window
ref | the trending shape name |
dsPlotData | the trending data |
fwTrending_saveAs | ( | string | ref, |
dyn_string | dsPlotData, | ||
bool | bCanUserEditPlot = true |
||
) |
opens the trending "Save As" dialog window
ref | the trending shape name |
dsPlotData | the trending data |
bCanUserEditPlot | indicates that the user saving the plot also has edit privileges on it from fwAccessControl |
fwTrending_toggleLog | ( | bool | state | ) |
enable disable logarithmic scale
state | true for logarithmic, false for linear |
fwTrendingControl_autoScalePushed | ( | bool | state | ) |
event callback for enable disable auto scale
state | true for autoscale |
fwTrendingTrendControl_setAutoscale | ( | string | trendName, |
bool | state, | ||
dyn_string | dsCurveRange, | ||
float | minForLog, | ||
float | maxPercentageForLog, | ||
string | sIsLog | ||
) |
enable disable auto scale
state | true for autoscale |
fwTrending_setCurveScaleVisibility | ( | string | ref, |
dyn_bool | axii, | ||
int | curveNumber, | ||
dyn_string | dsDpe, | ||
dyn_string | dsLegend | ||
) |
enable disable Y scale for a selected curve
ref | trending shape name |
axii | axii status (visible or not) |
curveNumber | number of the curve whose visibility must be toggled |
dsDpe | dpes of the curves |
dsLegend | legends |
fwTrending_encodeTime | ( | int & | t, |
int | d, | ||
int | h, | ||
int | m | ||
) |
encode time as seconds
t | encoded time in seconds |
d | days |
h | hours |
m | minutes |
fwTrending_decodeTime | ( | int | t, |
int & | d, | ||
int & | h, | ||
int & | m | ||
) |
decode time from seconds to d,h,m
t | time in seconds |
d | days |
h | hours |
m | minutes |
bool _fwTrending_isAutoLimits | ( | string | sMinMaxRange, |
bool & | bIsAuto | ||
) |
Check if Auto scale is selected.
sMinMaxRange,input,string | with the following format: "MinLimit : MaxLimit". For example: "0 : 0", "0.000 : 0.000" |
bIsAuto,output,if | auto limit is selected |
void fwTrending_copyPlot | ( | string | _from, |
string | _to | ||
) |
Creates a new plot and copies all the configuration data from a source plot to the new plot.
_from | the data point name of the source plot |
_to | the data point name of the plot to create |
fwTrending_setTimeScaleFormat | ( | string | trendName, |
dyn_string & | exceptionInfo | ||
) |
Reads the current visible time range and picks a scale format (dates or times) that best suits the range.
Currently the switch between times and dates occurs around a time range of 2 days.
trendName | input, the name of the trend widget to work on |
exceptionInfo | input, details of any exceptions are returned here |
string fwTrending_getColRow | ( | dyn_string | plotsList, |
int | column, | ||
int | row | ||
) |
Read the relevant plot name from the dyn_string containing a list of the plots on a page by giving the column and row of the plot.
plotsList | input, the list of plots on a page |
column | input, the column of the plot to read |
row | input, the row of the plot to read |