C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Properties | Events | List of all members
AnalyzeRe.Utilities.SimulationStatus Class Reference

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.
 

Detailed Description

Describes the status of a simulation being monitored.

Definition at line 7 of file SimulationStatus.cs.

Member Enumeration Documentation

◆ SimulationState

enum AnalyzeRe.Utilities.SimulationStatus.SimulationState

The running state of a simulation represented by a SimulationStatus object.

Enumerator
Unknown 

SimulationStatus is not properly initialized.

Queued 

Simulation request has been submitted, but simulation has not been run.

Running 

Simulation is being run.

Complete 

Simulation is done running and results should be ready.

Error 

Simulation is done running and has failed. Results will not be ready.

Definition at line 11 of file SimulationStatus.cs.

Constructor & Destructor Documentation

◆ SimulationStatus()

AnalyzeRe.Utilities.SimulationStatus.SimulationStatus ( string  id,
string  description = null 
)
inline

Creates a new SimulationStatus object.

Parameters
idThe id of the resource being simulated.
description(Optional) The description of the resource being simulated.

Definition at line 102 of file SimulationStatus.cs.

Member Function Documentation

◆ SimulationStatusChangedHandler()

delegate void AnalyzeRe.Utilities.SimulationStatus.SimulationStatusChangedHandler ( object  sender,
EventArgs  e 
)

A handler that can respond to a SimulationStatusChanged event.

Parameters
senderThe SimulationStatus that invoked the SimulationStatusChanged event.
eThe SimulationStatusChanged event args.

Property Documentation

◆ BeingPolled

bool AnalyzeRe.Utilities.SimulationStatus.BeingPolled
getset

Determines whether the associated simulation is actively being polled.

Definition at line 34 of file SimulationStatus.cs.

◆ Description

string AnalyzeRe.Utilities.SimulationStatus.Description
getset

The description of the resource being simulated.

Definition at line 79 of file SimulationStatus.cs.

◆ Exception

Exception AnalyzeRe.Utilities.SimulationStatus.Exception
getset

The exception associated with this simulation, if it is in an error state.

Definition at line 61 of file SimulationStatus.cs.

◆ Id

string AnalyzeRe.Utilities.SimulationStatus.Id
get

The id of the resource being simulated.

Definition at line 76 of file SimulationStatus.cs.

◆ LastUpdate

DateTime AnalyzeRe.Utilities.SimulationStatus.LastUpdate
get

The time the server last responded to a poll request.

Definition at line 73 of file SimulationStatus.cs.

◆ State

SimulationState AnalyzeRe.Utilities.SimulationStatus.State
getset

The running state of the simulation represented by this SimulationStatus object.

Definition at line 49 of file SimulationStatus.cs.

◆ TimeRemaining

double AnalyzeRe.Utilities.SimulationStatus.TimeRemaining
getset

Returns the estimated time remaining as of the last polled update from the server.

Definition at line 37 of file SimulationStatus.cs.

Event Documentation

◆ SimulationStatusChanged

SimulationStatusChangedHandler AnalyzeRe.Utilities.SimulationStatus.SimulationStatusChanged

An event that fires whenever this SimulationStatus is updated.

Definition at line 89 of file SimulationStatus.cs.

The documentation for this class was generated from the following file: