[PAClassAlarmingBase] PAClassAlarmingBase (developer guide)

collapse

Document tree

#
- 1.) Overview
- 2.) Properties
  - 1.) AlarmChangedEvent Property
  - 2.) AlarmsAsText Property
  - 3.) HasAlarms Property
  - 4.) IsSessionConnected Property
  - 5.) SubAlarmsChangedEvent Property
  - 6.) ApplicationManager Property
  - 7.) CountSubAlarms Property
  - 8.) HasLocalAlarms Property
  - 9.) HasUnackLocalAlarms Property
  - 10.) IsRoutingServiceAvailable Property
  - 11.) RoutingService Property
  - 12.) Session Property
- 3.) Methods
  - 1.) AcknowledgeAlarms Method
  - 2.) AcknowledgeAllAlarms Method
  - 3.) AcknowledgeSubAlarms Method
  - 4.) AcknowledgeSubAlarmsMsgList Method
  - 5.) FilterAlarm Method
  - 6.) GenerateNewMaintenanceOrder Method
  - 7.) GetAlarms Method
  - 8.) GetAlarmsConfig Method
  - 9.) ShowMaintenanceOrder Method
  - 10.) ShowMaintenanceOrderHistory Method
  - 11.) AcknowledgeSubAlarmsMsgList(gip Method
  - 12.) BeginAlarmTrans Method
  - 13.) EndAlarmTrans Method
  - 14.) FilterAlarm(System Method
  - 15.) GetAlarms(System Method
  - 16.) GetAlarmsConfig(System Method
  - 17.) IsAlarmActive(gip Method
  - 18.) IsAlarmActive(System Method
  - 19.) OnAlarmDisappeared(gip Method
  - 20.) OnAlarmDisappeared(System Method
  - 21.) OnNewAlarmOccurred(gip Method
  - 22.) OnNewAlarmOccurred(gip Method
  - 23.) OnNewAlarmOccurred(System Method
  - 24.) OnNewAlarmOccurred(System Method
  - 25.) OnSubAlarmChanged(gip Method
  - 26.) RefreshHasAlarms(System Method

;

Methods

gip.core.datamodel.IACComponent
gip.core.datamodel.IACObjectWithInit
gip.core.datamodel.IACObject
gip.core.datamodel.IACObjectBase
gip.core.datamodel.IACMember
System.ComponentModel.INotifyPropertyChanged
gip.core.datamodel.IACInteractiveObject
gip.core.autocomponent.ACComponent

gip.core.autocomponent.PAClassAlarmingBase

Framework properties

Method Name/ID	Class / Summary
AcknowledgeAlarms	Void Acknowledges all alarms that are active only on this instance. After acknowledging the alarms are remove from the alarmlist.
AcknowledgeAllAlarms	Void Acknowledges all alarms that are active on this instance and on all child components as well. After acknowledging the alarms are remove from the alarmlist.
AcknowledgeSubAlarms	Void Acknowledges all alarms that are active on any child component. After acknowledging the alarms are remove from the alarmlist.
AcknowledgeSubAlarmsMsgList	Void
FilterAlarm	Boolean
GenerateNewMaintenanceOrder	Void
GetAlarms	Msg
GetAlarmsConfig	Msg
ShowMaintenanceOrder	Void
ShowMaintenanceOrderHistory	Void

Assembly methods

Method Name/ID	Class / Summary
AcknowledgeSubAlarmsMsgList(gip	Acknowledges all alarms that are active on any child component. After acknowledging the alarms are remove from the alarmlist.
BeginAlarmTrans	Start a new Transaction for adding mupltiple Alarmtexts
EndAlarmTrans	Commit collected Alarms in _TransEntryList
FilterAlarm(System	Override this methof if you want to filter new alarms, that should not be added to the alarmlist. Return false to filter the alarm.
GetAlarms(System	Queries this component and sub components for alarms.
GetAlarmsConfig(System	Queries this component and sub components for alarms that are configured in a PAAlarmMessengerBase
IsAlarmActive(gip	Determines it a alarm ist currently active. If you want to write the alarm message to the log file, call this IsAlarmActive() method beforehand to check whether the same message is still pending. This will prevent the unnecessary and multiple output of the same message in the log file.
IsAlarmActive(System	Determines it a alarm ist currently active. If you want to write the alarm message to the log file, call this IsAlarmActive() method beforehand to check whether the same message is still pending. This will prevent the unnecessary and multiple output of the same message in the log file.
OnAlarmDisappeared(gip	Removes an active Alarm from the alarmlist.
OnAlarmDisappeared(System	Removes an active Alarm from the alarmlist.
OnNewAlarmOccurred(gip	Use the OnNewAlarmOccurred() method to add a new entry to the alarm list. If an unacknowledged alarm with the same message text already exists, no new entry is created. If the message text is different, the existing message will be replaced with the new message.
OnNewAlarmOccurred(gip	Use the OnNewAlarmOccurred() method to add a new entry to the alarm list. If an unacknowledged alarm with the same message text already exists, no new entry is created. If the message text is different, the existing message will be replaced with the new message.
OnNewAlarmOccurred(System	Use the OnNewAlarmOccurred() method to add a new entry to the alarm list. If an unacknowledged alarm with the same message text already exists, no new entry is created. If the message text is different, the existing message will be replaced with the new message.
OnNewAlarmOccurred(System	Use the OnNewAlarmOccurred() method to add a new entry to the alarm list. If an unacknowledged alarm with the same message text already exists, no new entry is created. If the message text is different, the existing message will be replaced with the new message.
OnSubAlarmChanged(gip	Raises the event.
RefreshHasAlarms(System	Refreshes the HasAlarms and AlarmsAsText property.

Cookie settings