Procedure.AddNewSetVariable Method (String, String, BaseNode, SetVariableStepFunction, Double, Double)
- Updated2023-02-21
- 3 minute(s) read
Adds a new SetVariable step that performs the Function you specify on Value1 and Value2 and sets the value of the Variable channel to the result. This method uses constants for the values of Value1 and Value2.
Namespace:
NationalInstruments.VeriStand.SystemDefinitionAPIAssembly: NationalInstruments.VeriStand.SystemDefinitionAPI (in NationalInstruments.VeriStand.SystemDefinitionAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)
| Visual Basic (Declaration) |
|---|
Public Function AddNewSetVariable ( _ Name As String, _ Description As String, _ Variable As BaseNode, _ Function As SetVariableStepFunction, _ Value1 As Double, _ Value2 As Double _ ) As Boolean |
| C# |
|---|
public bool AddNewSetVariable( string Name, string Description, BaseNode Variable, SetVariableStepFunction Function, double Value1, double Value2 ) |
| Visual C++ |
|---|
public: bool AddNewSetVariable( String^ Name, String^ Description, BaseNode^ Variable, SetVariableStepFunction Function, double Value1, double Value2 ) |
Parameters
- Name
- Type: System.String
The name of the step.
- Description
- Type: System.String
The description of the step.
- Variable
- Type: NationalInstruments.VeriStand.SystemDefinitionAPI.BaseNode
The channel in the system whose value you want to set.
- Function
- Type: NationalInstruments.VeriStand.SystemDefinitionAPI.SetVariableStepFunction
The function to apply to Value1 and Value2.
- Value1
- Type: System.Double
The constant value of Value1.
- Value2
- Type: System.Double
The constant value of Value2.
Return Value
true (True in Visual Basic) if the SetVariable step was added successfully.
Remarks
 Note: |
|---|
Value1 is always the first term in the Function operation. |