SetToIdleStatus
SetToIdleStatus

Holds the status information of the Set to Idle command.

SetToIdleResult

The result of the Set To Idle command once the operation has ceased.

setToIdleResult_success

0  - The Node has been successfully set to idle.

setToIdleResult_canceled

1 - The Set to Idle operation has been canceled by the user.

setToIdleResult_failed

2 - The Set to Idle operation has failed. The state of the Node is unknown.

setToIdleResult_notCompleted

3 - The Set to Idle operation has not yet completed.

result
SetToIdleResult result()

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.

Returns

A SetToIdleResult representing the result of the Stop Node command.

complete
bool complete(
uint64 timeout 10
)

Gets whether the Stop Node command has completed or not, waiting for the specified amount of time before returning.

Parameters
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.

Returns

true if the Stop Node command has finished, false if it is still running.

cancel
void cancel()

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.

Exceptions