fwAlarmHandling  8.4.1
fwAlarmHandling.ctl File Reference

Functions

 fwAlarmHandling_getDpsMatchingCriteria (dyn_string systemNameFilters, dyn_string dpNameFilters, dyn_string dpAliasFilters, dyn_string dpTypeFilters, dyn_string &matchingDps, dyn_string &exceptionInfo)
 
 fwAlarmHandling_openScreen (bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0)
 
 fwAlarmHandling_openScreenWithDpeList (dyn_string dpeList, bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0)
 
 fwAlarmHandling_openScreenWithSavedFilter (string filterName, bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0)
 
 fwAlarmHandling_openScreenWithFilter (dyn_dyn_anytype filter, bool bAsNewModule, bool bStayOnTopOrModal, string sModuleName, string sPanelName, dyn_string &exceptionInfo, unsigned x=0, unsigned y=0, string sFilterName="")
 
bool fwAlarmHandling_AESConfig_isForFw ()
 
bool fwAlarmHandling_AESConfig_isForUn ()
 
bool fwAlarmHandling_AESConfig_useFwConfig (dyn_string exceptionInfo)
 
bool fwAlarmHandling_AESConfig_useUnConfig (dyn_string exceptionInfo)
 

Detailed Description

This library contains functions for handling JCOP framework alarms. There are functions for filtering data points which have alarms as well as functions to open the JCOP Alarm Screen

Creation Date
02/02/2006
Modification History

25/06/2012: Marco Boccioli

  • {FWAH-257} Check for current alarm settings: bug in dpGet. In fwAlarmHandling_AESConfig_isForFw(), wAlarmHandling_AESConfig_isForUn(): Removed system name. Added check if dp exists.

12/06/2012: Marco Boccioli

29/06/2011 Marco Boccioli

2011-07-05 Marco Boccioli

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Author
Oliver Holme (IT-CO)

Function Documentation

fwAlarmHandling_getDpsMatchingCriteria ( dyn_string  systemNameFilters,
dyn_string  dpNameFilters,
dyn_string  dpAliasFilters,
dyn_string  dpTypeFilters,
dyn_string &  matchingDps,
dyn_string &  exceptionInfo 
)
Returns a list of data points that match the given criteria.

The result returned is as follows: result = ((dps that meet ALL DP name filter) && (dps that meet ALL DP alias filters)) of ANY specified type, on ANY specified system

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
systemNameFiltersA list of systems to search in. The criteria are OR'ed
dpNameFiltersA list of criteria to filter on the dp name. The criteria are AND'ed.
dpAliasFiltersA list of criteria to filter on the dp alias. The criteria are AND'ed.
dpTypeFiltersA list of data point types to search. The criteria are ORed.
matchingDpsThe list of matching dps is returned here.
exceptionInfoDetails of any exceptions are returned here
fwAlarmHandling_openScreen ( bool  bAsNewModule,
bool  bStayOnTopOrModal,
string  sModuleName,
string  sPanelName,
dyn_string &  exceptionInfo,
unsigned  x = 0,
unsigned  y = 0 
)
Opens a JCOP Alarm Screen with the default filter - filter shows ALL alarms in ALL systems.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bAsNewModuleinput, should the display be opened in a new module, TRUE = new module, FALSE = child panel
bStayOnTopOrModalinput, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour
sModuleNameinput, the name of the new module (if required)
sPanelNameinput, the name of the new panel
exceptionInfoDetails of any exceptions are returned here
xinput, Optional parameter - default value 0. X position of the new display
yinput, Optional parameter - default value 0. Y position of the new display
fwAlarmHandling_openScreenWithDpeList ( dyn_string  dpeList,
bool  bAsNewModule,
bool  bStayOnTopOrModal,
string  sModuleName,
string  sPanelName,
dyn_string &  exceptionInfo,
unsigned  x = 0,
unsigned  y = 0 
)
Opens a JCOP Alarm Screen to monitor a specific list of DPEs.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpeListinput, the list of data points or data point elements that the alarm screen should monitor and display
bAsNewModuleinput, should the display be opened in a new module, TRUE = new module, FALSE = child panel
bStayOnTopOrModalinput, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour
sModuleNameinput, the name of the new module (if required)
sPanelNameinput, the name of the new panel
exceptionInfoDetails of any exceptions are returned here
xinput, Optional parameter - default value 0. X position of the new display
yinput, Optional parameter - default value 0. Y position of the new display
fwAlarmHandling_openScreenWithSavedFilter ( string  filterName,
bool  bAsNewModule,
bool  bStayOnTopOrModal,
string  sModuleName,
string  sPanelName,
dyn_string &  exceptionInfo,
unsigned  x = 0,
unsigned  y = 0 
)
Opens a JCOP Alarm Screen with the specified pre-saved filter.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
filterNameinput, the name of the pre-saved filter that should be loaded and displayed
bAsNewModuleinput, should the display be opened in a new module, TRUE = new module, FALSE = child panel
bStayOnTopOrModalinput, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour
sModuleNameinput, the name of the new module (if required)
sPanelNameinput, the name of the new panel
exceptionInfoDetails of any exceptions are returned here
xinput, Optional parameter - default value 0. X position of the new display
yinput, Optional parameter - default value 0. Y position of the new display
fwAlarmHandling_openScreenWithFilter ( dyn_dyn_anytype  filter,
bool  bAsNewModule,
bool  bStayOnTopOrModal,
string  sModuleName,
string  sPanelName,
dyn_string &  exceptionInfo,
unsigned  x = 0,
unsigned  y = 0,
string  sFilterName = "" 
)
Opens a JCOP Alarm Screen with the specified custom filter.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
filterinput, the filter shoule be passed here, check the fwAlarmHandlingScreen_CONFIG_OBJECT_FILTER_XXX constants that define the filter object
bAsNewModuleinput, should the display be opened in a new module, TRUE = new module, FALSE = child panel
bStayOnTopOrModalinput, for a new module - TRUE = stay on top, FALSE = normal behaviour for a child panel - TRUE = modal child panel, FALSE = normal behaviour
sModuleNameinput, the name of the new module (if required)
sPanelNameinput, the name of the new panel
exceptionInfoDetails of any exceptions are returned here
xinput, Optional parameter - default value 0. X position of the new display
yinput, Optional parameter - default value 0. Y position of the new display
sFilterNameinput, Optional parameter - default value "". Filter name to be shown on the Quick Filters box
bool fwAlarmHandling_AESConfig_isForFw ( )
Checks if the alarm screen configuration stored in _AESConfig is the one for JCOP FW.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Returns
true if the config is for JCOP fw, false if else (i.e. it can be UNICOS config)
See Also
fwAlarmHandling_AESConfig_isForUn()
fwAlarmHandling_AESConfig_useUnConfig()
fwAlarmHandling_AESConfig_useFwConfig()
bool fwAlarmHandling_AESConfig_isForUn ( )
Checks if the alarm screen configuration stored in _AESConfig is the one for UNICOS.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Returns
true if the config is for UNICOS, false if else (i.e. it can be JCOP framework config)
See Also
fwAlarmHandling_AESConfig_isForFw()
fwAlarmHandling_AESConfig_useUnConfig()
fwAlarmHandling_AESConfig_useFwConfig()
bool fwAlarmHandling_AESConfig_useFwConfig ( dyn_string  exceptionInfo)
Applies the alarm screen configuration (stored in _AESConfig) for the JCOP FW.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
exceptionInfoerrors returned here
Returns
true if success
See Also
fwAlarmHandling_AESConfig_isForUn()
fwAlarmHandling_AESConfig_isForFw()
fwAlarmHandling_AESConfig_useUnConfig()
bool fwAlarmHandling_AESConfig_useUnConfig ( dyn_string  exceptionInfo)
Applies the alarm screen configuration (stored in _AESConfig) for the UNICOS.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
exceptionInfoerrors returned here
Returns
true if success
See Also
fwAlarmHandling_AESConfig_isForUn()
fwAlarmHandling_AESConfig_isForFw()
fwAlarmHandling_AESConfig_useFwConfig()