C# Class Quickstarts.AlarmConditionServer.UnderlyingSystemSource

This class simulates a source in the system.
Afficher le fichier Open project: OPCFoundation/UA-.NET Class Usage Examples

Méthodes publiques

Свойство Type Description
OnAlarmChanged AlarmChangedEventHandler

Méthodes publiques

Méthode Description
AcknowledgeAlarm ( string alarmName, uint recordNumber, Opc.Ua.LocalizedText comment, string userName ) : void

Acknowledges an alarm.

CommentAlarm ( string alarmName, uint recordNumber, Opc.Ua.LocalizedText comment, string userName ) : void

Adds a comment to an alarm.

ConfirmAlarm ( string alarmName, uint recordNumber, Opc.Ua.LocalizedText comment, string userName ) : void

Confirms an alarm.

CreateAlarm ( string alarmName, string alarmType ) : void

Creates a new active alarm for the source.

DoSimulation ( long counter, int index ) : void

Simulates a source by updating the state of the alarms belonging to the condition.

EnableAlarm ( string alarmName, bool enabling ) : void

Enables or disables the alarm.

Refresh ( ) : void

Reports the current state of all conditions.

SetOfflineState ( bool offline ) : void

Sets the state of the source (surpresses any active alarms).

UnderlyingSystemSource ( ) : System

Initializes a new instance of the UnderlyingSystemSource class.

Private Methods

Méthode Description
FindAlarm ( string alarmName, uint recordNumber ) : UnderlyingSystemAlarm

Finds the alarm identified by the name.

ReportAlarmChange ( UnderlyingSystemAlarm alarm ) : void

Reports a change to an alarm record.

UpdateAlarm ( UnderlyingSystemAlarm alarm, long counter, int index, List snapshots ) : void

Updates the state of an alarm.

Method Details

AcknowledgeAlarm() public méthode

Acknowledges an alarm.
public AcknowledgeAlarm ( string alarmName, uint recordNumber, Opc.Ua.LocalizedText comment, string userName ) : void
alarmName string Name of the alarm.
recordNumber uint The record number.
comment Opc.Ua.LocalizedText The comment.
userName string Name of the user.
Résultat void

CommentAlarm() public méthode

Adds a comment to an alarm.
public CommentAlarm ( string alarmName, uint recordNumber, Opc.Ua.LocalizedText comment, string userName ) : void
alarmName string Name of the alarm.
recordNumber uint The record number.
comment Opc.Ua.LocalizedText The comment.
userName string Name of the user.
Résultat void

ConfirmAlarm() public méthode

Confirms an alarm.
public ConfirmAlarm ( string alarmName, uint recordNumber, Opc.Ua.LocalizedText comment, string userName ) : void
alarmName string Name of the alarm.
recordNumber uint The record number.
comment Opc.Ua.LocalizedText The comment.
userName string Name of the user.
Résultat void

CreateAlarm() public méthode

Creates a new active alarm for the source.
public CreateAlarm ( string alarmName, string alarmType ) : void
alarmName string Name of the alarm.
alarmType string Type of the alarm.
Résultat void

DoSimulation() public méthode

Simulates a source by updating the state of the alarms belonging to the condition.
public DoSimulation ( long counter, int index ) : void
counter long The number of simulation cycles that have elapsed.
index int The index of the source within the system.
Résultat void

EnableAlarm() public méthode

Enables or disables the alarm.
public EnableAlarm ( string alarmName, bool enabling ) : void
alarmName string Name of the alarm.
enabling bool if set to true the alarm is enabled.
Résultat void

Refresh() public méthode

Reports the current state of all conditions.
public Refresh ( ) : void
Résultat void

SetOfflineState() public méthode

Sets the state of the source (surpresses any active alarms).
public SetOfflineState ( bool offline ) : void
offline bool if set to true the source is offline.
Résultat void

UnderlyingSystemSource() public méthode

Initializes a new instance of the UnderlyingSystemSource class.
public UnderlyingSystemSource ( ) : System
Résultat System

Property Details

OnAlarmChanged public_oe property

Used to receive events when the state of an alarm changed.
public AlarmChangedEventHandler OnAlarmChanged
Résultat AlarmChangedEventHandler