unShelvedAE 9.1.1
unShelvedAE.ctl File Reference

Functions

 unShelvedAE_getTableInfo (bool isBlockedAlarms, bool isMaskedAlarms, bool isMaskedEvents, unShelvedAE_TableParameters &tableParameters, dyn_string &exceptionInfo)
 
 unShelvedAE_getRemote (dyn_string &dsRemote)
 
 unShelvedAE_getBlockedAlarms (string sRemote, dyn_dyn_anytype &ddResults, dyn_string &exceptionInfo)
 
 unShelvedAE_getMaskedAlarms (string sRemote, dyn_dyn_anytype &ddResults, dyn_string &exceptionInfo)
 
 unShelvedAE_getMaskedEvents (string sRemote, dyn_dyn_anytype &ddResults, dyn_string &exceptionInfo)
 
 unShelvedAE_getDpsBlockedAlarms (dyn_dyn_anytype ddResults, dyn_string &dsDp, dyn_string &dsType, dyn_string &dsTimestamp)
 
 unShelvedAE_getDpsMaskedAlarms (dyn_dyn_anytype ddResults, dyn_string &dsDp, dyn_string &dsType, dyn_string &dsTimestamp)
 
 unShelvedAE_getDpsMaskedEvents (dyn_dyn_anytype ddResults, dyn_string &dsDp, dyn_string &dsType, dyn_string &dsTimestamp)
 
 unShelvedAE_getFieldsFromDps (dyn_string dsDp, unShelvedAE_TableParameters &tableParameters)
 
 unShelvedAE_getFormattedComments (dyn_string dsUnformattedComments, string &sFormatComment)
 
 unShelvedAE_setDynamicRemoteSystems (dyn_string &exceptionInfo)
 
 unShelvedAE_setDynamicTable (dyn_string &exceptionInfo)
 
 unShelvedAE_connectBlockedAlarms (string sRemote, dyn_string &exceptionInfo)
 
 unShelvedAE_connectMaskedAlarms (string sRemote, dyn_string &exceptionInfo)
 
 unShelvedAE_connectMaskedEvents (string sRemote, dyn_string &exceptionInfo)
 
 unShelvedAE_alarmEventTrigger (anytype userData, dyn_dyn_anytype ddResults)
 

Detailed Description

unShelvedAE.ctl This library contains the functions to populate and manage the unShelvedAE panel

Creation Date
25/07/2022
Modification History
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Author
Juan-Manuel Pablo-Rodriguez

Function Documentation

◆ unShelvedAE_getTableInfo()

unShelvedAE_getTableInfo ( bool  isBlockedAlarms,
bool  isMaskedAlarms,
bool  isMaskedEvents,
unShelvedAE_TableParameters &  tableParameters,
dyn_string &  exceptionInfo 
)

Purpose: return the different values to fill the table fields of the unShelvedAE panel

Parameters:

  • bool isBlockedAlarms, bool, input, block alarms checkbox status
  • bool isMaskedAlarms, bool, input, masked alarms checkbox status
  • bool isMaskedEvents, bool, input, masked events checkbox status
  • tableParameters, unShelvedAE_TableParameters, output, configured table parameters object
  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_getRemote()

unShelvedAE_getRemote ( dyn_string &  dsRemote)

Purpose: return the remote system if there is any

Parameters:

  • dsRemote, dyn_string, output, remote systems

◆ unShelvedAE_getBlockedAlarms()

unShelvedAE_getBlockedAlarms ( string  sRemote,
dyn_dyn_anytype &  ddResults,
dyn_string &  exceptionInfo 
)

Purpose: return the result of the blocked alarm query

Parameters:

  • sRemote, string, input, remote system
  • ddResults, dyn_dyn_anytype, output, result of the query call
  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_getMaskedAlarms()

unShelvedAE_getMaskedAlarms ( string  sRemote,
dyn_dyn_anytype &  ddResults,
dyn_string &  exceptionInfo 
)

Purpose: return the result of the masked alarm query

Parameters:

  • sRemote, string, input, remote system
  • ddResults, dyn_dyn_anytype, output, result of the query call
  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_getMaskedEvents()

unShelvedAE_getMaskedEvents ( string  sRemote,
dyn_dyn_anytype &  ddResults,
dyn_string &  exceptionInfo 
)

Purpose: return the result of the masked event query

Parameters:

  • sRemote, string, input, remote system
  • ddResults, dyn_dyn_anytype, output, result of the query call
  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_getDpsBlockedAlarms()

unShelvedAE_getDpsBlockedAlarms ( dyn_dyn_anytype  ddResults,
dyn_string &  dsDp,
dyn_string &  dsType,
dyn_string &  dsTimestamp 
)

Purpose: return the datapoints associated to the blocked alarms

Parameters:

  • ddResults, dyn_dyn_anytype, input, result from the query call
  • dsDp, dyn_string, output, blocked alarm datapoint's list
  • dsType, dyn_string, output, blocked alarm type's list
  • dsTimestamp, dyn_string, output, blocked alarm timestamps

◆ unShelvedAE_getDpsMaskedAlarms()

unShelvedAE_getDpsMaskedAlarms ( dyn_dyn_anytype  ddResults,
dyn_string &  dsDp,
dyn_string &  dsType,
dyn_string &  dsTimestamp 
)

Purpose: return the datapoints associated to the masked alarms

Parameters:

  • ddResults, dyn_dyn_anytype, input, result from the query call
  • dsDp, dyn_string, output, masked alarm datapoint's list
  • dsType, dyn_string, output, masked alarm type's list
  • dsTimestamp, dyn_string, output, masked alarm timestamps (empty for masked alarms)

◆ unShelvedAE_getDpsMaskedEvents()

unShelvedAE_getDpsMaskedEvents ( dyn_dyn_anytype  ddResults,
dyn_string &  dsDp,
dyn_string &  dsType,
dyn_string &  dsTimestamp 
)

Purpose: return the datapoints associated to the masked events

Parameters:

  • ddResults, dyn_dyn_anytype, input, result from the query call
  • dsDp, dyn_string, output, masked event datapoint's list
  • dsType, dyn_string, output, masked event type's list
  • dsTimestamp, dyn_string, output, masked events timestamps

◆ unShelvedAE_getFieldsFromDps()

unShelvedAE_getFieldsFromDps ( dyn_string  dsDp,
unShelvedAE_TableParameters &  tableParameters 
)

Purpose: extract the values from the datapoints to populate the corresponding fields of the unShelvedAE panel after

Parameters:

  • dsDp, dyn_string, input, blocked/masked alarms' and events' datapoint list
  • tableParameters, unShelvedAE_TableParameters, output, configured table parameters object

◆ unShelvedAE_getFormattedComments()

unShelvedAE_getFormattedComments ( dyn_string  dsUnformattedComments,
string &  sFormatComment 
)

Purpose: format the comments in order to display them in the table

Parameters:

  • dsUnformattedComments, dyn_string, input, unformatted comments
  • sFormatComment, string, output, formatted comment

◆ unShelvedAE_setDynamicRemoteSystems()

unShelvedAE_setDynamicRemoteSystems ( dyn_string &  exceptionInfo)

Purpose: call the query that connects to the list of distributed systems in distributed control

Parameters:

  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_setDynamicTable()

unShelvedAE_setDynamicTable ( dyn_string &  exceptionInfo)

Purpose: call the functions that connect to the corresponding alarms and events datapoints for further processing in case of changes

Parameters:

  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_connectBlockedAlarms()

unShelvedAE_connectBlockedAlarms ( string  sRemote,
dyn_string &  exceptionInfo 
)

Purpose: Connect to the blocked alarm datapoints and call the unShelvedAE_alarmEventTrigger callback function if there are changes

Parameters:

  • sRemote, string, input, remote system
  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_connectMaskedAlarms()

unShelvedAE_connectMaskedAlarms ( string  sRemote,
dyn_string &  exceptionInfo 
)

Purpose: Connect to the masked alarm datapoints and call the unShelvedAE_alarmEventTrigger callback function if there are changes

Parameters:

  • sRemote, string, input, remote system
  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_connectMaskedEvents()

unShelvedAE_connectMaskedEvents ( string  sRemote,
dyn_string &  exceptionInfo 
)

Purpose: Connect to the masked event datapoints and call the unShelvedAE_alarmEventTrigger callback function if there are changes

Parameters:

  • sRemote, string, input, remote system
  • exceptionInfo, dyn_string, output, standard exception handling variable

◆ unShelvedAE_alarmEventTrigger()

unShelvedAE_alarmEventTrigger ( anytype  userData,
dyn_dyn_anytype  ddResults 
)

Purpose: Callback function that triggers the event alarmEventChange

Parameters:

  • userData, anytype, input, user-defined data which is passed as parameter to the callback function.
  • ddResults, dyn_dyn_anytype, input, result of the query (values)