.NET API Set Functions¶
Blocking set functions¶
These functions return only once the device has received the set value. If the set operation fails, an error will be returned.
Note
Before version 25.04, these functions returned without waiting for the device to acknowledge the node value. This is not anymore the case.
setDouble¶
void setDouble(String^ path, double value)
Set the value as double for a specified node.
The command blocks until the device has acknowledged the set request.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | double | in | Value of the node. |
setDouble¶
void setDouble(String^ path, double value)
Set the value as double for a specified node.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | double | in | Value of the node. |
setComplex¶
void setComplex(String^ path, Complex^ value)
Set the value as complex double for a specified node.
The command blocks until the device has acknowledged the set request.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | Complex^ | in | Value of the node. |
setInt¶
void setInt(String^ path, int64_t value)
Set the value as integer for a specified node.
The command blocks until the device has acknowledged the set request.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | int64_t | in | Value of the node. |
setInt¶
void setInt(String^ path, int64_t value)
Set the value as integer for a specified node.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | int64_t | in | Value of the node. |
setByte¶
void setByte(String^ path, String^ value)
Set the value as byte array (string) for a specified node.
The command blocks until the device has acknowledged the set request.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | String^ | in | Value of the node. |
setByte¶
void setByte(String^ path, String^ value)
Set the value as byte array (string) for a specified node.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | String^ | in | Value of the node. |
setString¶
void setString(String^ path, String^ value)
Set the value as string for a specified node.
The command blocks until the device has acknowledged the set request.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | String^ | in | Value of the node. |
setString¶
void setString(String^ path, String^ value)
Set the value as string for a specified node.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | String^ | in | Value of the node. |
setVector¶
void setVector(String^ path, ZIVector^ vector)
Sets a parameter to the specified vector.
This function is used to configure (set) parameters which have vector types.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path of the module parameter to set. |
| vector | ZIVector^ | in | Vector data. |
setVector¶
void setVector(String^ path, ZIVector^ vector)
Sets a parameter to the specified vector.
This function is used to configure (set) parameters which have vector types.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path of the module parameter to set. |
| vector | ZIVector^ | in | Vector data. |
Batch set functions¶
When many values need to be set, better performance can be achieved by grouping the sets together, instead of sending the set commands one by one. This can be done using the beginTransaction and endTransaction functions. The set calls between beginTransaction and endTransaction return immediately. endTransaction waits until all the sets have completed. If any of the set failed, the error will be raised by endTransaction.
beginTransaction¶
void beginTransaction()
Start a set transaction.
endTransaction¶
void endTransaction()
End a set transaction.
endTransaction blocks until all set requests have been acknowledged, and possibly returns an error if any of them failed.
Legacy blocking set functions¶
These functions block until the device has acknowledged the set value. Since version 25.04, setInt, setDouble, setComplex, setString and setByte have the same behavior so these functions are now superfluous and kept only for backward compatibility.
syncSetDouble¶
void syncSetDouble(String^ path, double value)
Synchronously set the value as byte array (string) for a specified node.
Synchronously means that the command is blocking until the device has acknowledged the set request. Since version 25.04, syncSetDouble and setDouble have the same behavior. It is recommended to use setDouble instead of syncSetDouble.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | double | in | Value of the node. |
syncSetInt¶
void syncSetInt(String^ path, int64_t value)
Synchronously set the value as integer for a specified node.
Synchronously means that the command is blocking until the device has acknowledged the set request. Since version 25.04, syncSetInt and setInt have the same behavior. It is recommended to use setInt instead of syncSetInt.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | int64_t | in | Value of the node. |
syncSetByte¶
void syncSetByte(String^ path, String^ value)
Synchronously set the value as byte array (string) for a specified node.
Synchronously means that the command is blocking until the device has acknowledged the set request. Since version 25.04, syncSetByte and setByte have the same behavior. It is recommended to use setByte instead of syncSetByte.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | String^ | in | Value of the node. |
syncSetString¶
void syncSetString(String^ path, String^ value)
Synchronously set the value as string for a specified node.
Synchronously means that the command is blocking until the device has acknowledged the set request. Since version 25.04, syncSetString and setString have the same behavior. It is recommended to use setString instead of syncSetString.
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| path | String^ | in | Path to the node holding the value |
| value | String^ | in | Value of the node. |