Procedure.AddNewAlarming Method (String, String, AlarmPriority, AlarmState, BaseNode, Double, BaseNode, BaseNode, BaseNode, Double)

Télécharger (PDF)

Mise à jour2023-02-21
Temps de lecture : 3 minute(s)

Adds a new Alarming step and applies the specified settings to the Alarm. This method uses a channel value to specify the upper limit of the alarm and a constant value to specify the lower limit.

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 AddNewAlarming ( _ Name As String, _ Description As String, _ Priority As AlarmPriority, _ DefaultState As AlarmState, _ Alarm As BaseNode, _ Delay As Double, _ Procedure As BaseNode, _ AlarmChannel As BaseNode, _ UpperLimit As BaseNode, _ LowerLimit As Double _ ) As Boolean

Visual Basic (Declaration)

Public Function AddNewAlarming ( _
	Name As String, _
	Description As String, _
	Priority As AlarmPriority, _
	DefaultState As AlarmState, _
	Alarm As BaseNode, _
	Delay As Double, _
	Procedure As BaseNode, _
	AlarmChannel As BaseNode, _
	UpperLimit As BaseNode, _
	LowerLimit As Double _
) As Boolean

C#
public bool AddNewAlarming( string Name, string Description, AlarmPriority Priority, AlarmState DefaultState, BaseNode Alarm, double Delay, BaseNode Procedure, BaseNode AlarmChannel, BaseNode UpperLimit, double LowerLimit )

public bool AddNewAlarming(
	string Name,
	string Description,
	AlarmPriority Priority,
	AlarmState DefaultState,
	BaseNode Alarm,
	double Delay,
	BaseNode Procedure,
	BaseNode AlarmChannel,
	BaseNode UpperLimit,
	double LowerLimit
)

Visual C++
public: bool AddNewAlarming( String^ Name, String^ Description, AlarmPriority Priority, AlarmState DefaultState, BaseNode^ Alarm, double Delay, BaseNode^ Procedure, BaseNode^ AlarmChannel, BaseNode^ UpperLimit, double LowerLimit )

Visual C++

public:
bool AddNewAlarming(
	String^ Name, 
	String^ Description, 
	AlarmPriority Priority, 
	AlarmState DefaultState, 
	BaseNode^ Alarm, 
	double Delay, 
	BaseNode^ Procedure, 
	BaseNode^ AlarmChannel, 
	BaseNode^ UpperLimit, 
	double LowerLimit
)

Parameters

Name: Type: System.String
The name of the step.

Description: Type: System.String
The description of the step.

Priority: Type: NationalInstruments.VeriStand.SystemDefinitionAPI.AlarmPriority
The priority level of the alarm.

DefaultState: Type: NationalInstruments.VeriStand.SystemDefinitionAPI.AlarmState
The default state of the alarm.

Alarm: Type: NationalInstruments.VeriStand.SystemDefinitionAPI.BaseNode
The alarm to apply settings to.

Delay: Type: System.Double
The amount of time to wait before triggering the alarm.

Procedure: Type: NationalInstruments.VeriStand.SystemDefinitionAPI.BaseNode
The procedure to initiate when the alarm occurs.

AlarmChannel: Type: NationalInstruments.VeriStand.SystemDefinitionAPI.BaseNode
The channel to monitor for alarm conditions.

UpperLimit: Type: NationalInstruments.VeriStand.SystemDefinitionAPI.BaseNode
The channel that specifies the high limit value of the alarm. If the value of AlarmSource exceeds this limit, the alarm is triggered.

LowerLimit: Type: System.Double
The constant that specifies the low limit value of the alarm. If the value of AlarmSource falls below this limit, the alarm is triggered.

Return Value

true (True in Visual Basic) if the Alarming step was added successfully.

VeriStand .NET API Reference

Sommaire

Procedure.AddNewAlarming Method (String, String, AlarmPriority, AlarmState, BaseNode, Double, BaseNode, BaseNode, BaseNode, Double)

Parameters

Return Value

See Also

Reference

Log in to get a better experience