Adds a new
Alarm with the specified name, description, and configuration to the
Alarms section.
This method uses a constant to specify the
UpperLimit and a channel to specify the
LowerLimit within which
AlarmSource must stay to avoid triggering the alarm.
Namespace:
NationalInstruments.VeriStand.SystemDefinitionAPI
Assembly:
NationalInstruments.VeriStand.SystemDefinitionAPI (in NationalInstruments.VeriStand.SystemDefinitionAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
| Visual Basic (Declaration) |
|---|
Public Function AddNewAlarm ( _
Name As String, _
Description As String, _
AlarmSource As Channel, _
UpperLimit As Double, _
LowerLimit As BaseNode, _
AlarmAction As Procedure, _
Mode As AlarmMode, _
DefaultState As AlarmState, _
Priority As AlarmPriority, _
Delay As Double, _
TripMessage As String _
) As Boolean |
| C# |
|---|
public bool AddNewAlarm(
string Name,
string Description,
Channel AlarmSource,
double UpperLimit,
BaseNode LowerLimit,
Procedure AlarmAction,
AlarmMode Mode,
AlarmState DefaultState,
AlarmPriority Priority,
double Delay,
string TripMessage
) |
| Visual C++ |
|---|
public:
bool AddNewAlarm(
String^ Name,
String^ Description,
Channel^ AlarmSource,
double UpperLimit,
BaseNode^ LowerLimit,
Procedure^ AlarmAction,
AlarmMode Mode,
AlarmState DefaultState,
AlarmPriority Priority,
double Delay,
String^ TripMessage
) |
Return Value
true (True in Visual Basic) if the
Alarm was added successfully.