C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
Describes the status of a simulation being monitored. More...
Public Types | |
enum | SimulationState { Unknown , Queued , Running , Complete , Error } |
The running state of a simulation represented by a SimulationStatus object. More... | |
Public Member Functions | |
SimulationStatus (string id, string description=null) | |
Creates a new SimulationStatus object. | |
delegate void | SimulationStatusChangedHandler (object sender, EventArgs e) |
A handler that can respond to a SimulationStatusChanged event. | |
Properties | |
bool | BeingPolled [get, set] |
Determines whether the associated simulation is actively being polled. | |
string | Description [get, set] |
The description of the resource being simulated. | |
Exception | Exception [get, set] |
The exception associated with this simulation, if it is in an error state. | |
string | Id [get] |
The id of the resource being simulated. | |
DateTime | LastUpdate [get] |
The time the server last responded to a poll request. | |
SimulationState | State [get, set] |
The running state of the simulation represented by this SimulationStatus object. | |
double | TimeRemaining [get, set] |
Returns the estimated time remaining as of the last polled update from the server. | |
Events | |
SimulationStatusChangedHandler | SimulationStatusChanged |
An event that fires whenever this SimulationStatus is updated. | |
Describes the status of a simulation being monitored.
Definition at line 7 of file SimulationStatus.cs.
The running state of a simulation represented by a SimulationStatus object.
Definition at line 11 of file SimulationStatus.cs.
|
inline |
Creates a new SimulationStatus object.
id | The id of the resource being simulated. |
description | (Optional) The description of the resource being simulated. |
Definition at line 102 of file SimulationStatus.cs.
delegate void AnalyzeRe.Utilities.SimulationStatus.SimulationStatusChangedHandler | ( | object | sender, |
EventArgs | e | ||
) |
A handler that can respond to a SimulationStatusChanged event.
sender | The SimulationStatus that invoked the SimulationStatusChanged event. |
e | The SimulationStatusChanged event args. |
|
getset |
Determines whether the associated simulation is actively being polled.
Definition at line 34 of file SimulationStatus.cs.
|
getset |
The description of the resource being simulated.
Definition at line 79 of file SimulationStatus.cs.
|
getset |
The exception associated with this simulation, if it is in an error state.
Definition at line 61 of file SimulationStatus.cs.
|
get |
The id of the resource being simulated.
Definition at line 76 of file SimulationStatus.cs.
|
get |
The time the server last responded to a poll request.
Definition at line 73 of file SimulationStatus.cs.
|
getset |
The running state of the simulation represented by this SimulationStatus object.
Definition at line 49 of file SimulationStatus.cs.
|
getset |
Returns the estimated time remaining as of the last polled update from the server.
Definition at line 37 of file SimulationStatus.cs.
SimulationStatusChangedHandler AnalyzeRe.Utilities.SimulationStatus.SimulationStatusChanged |
An event that fires whenever this SimulationStatus is updated.
Definition at line 89 of file SimulationStatus.cs.