Holds the status information of the Set to Idle command.
The result of the Set To Idle command once the operation has ceased.
Gets the SetToIdleResult representing the result of the Stop Node command (success, fail, canceled, etc.). After complete is true, this should be called to discover how the command completed.
A SetToIdleResult representing the result of the Stop Node command.
bool complete( |
| ) |
Gets whether the Stop Node command has completed or not, waiting for the specified amount of time before returning.
timeout uint64 | A timeout (in milliseconds) which determines how long the command may take to return (default of 10 milliseconds). For example, called with a timeout of 1 second, this function will block for up to 1 second if the Stop Node command has not completed. |
true if the Stop Node command has finished, false if it is still running.
Cancels the Stop Node operation that this SetToIdleResult belongs to. If the Stop Node operation has already been completed/canceled, this will have no effect. Note: This function will block for up to the BaseStation's command timeout to verify that the command was canceled.
Error_Communication: Failed to cancel the Stop Node operation.
Error_Connection: A connection error has occurred with the BaseStation.