Interface IExecutionContext

The execution context represents the unique combination of an IComputationalWork processing a particular item of input data.

Inherited Members

IVariableContainer.Variables

IVariableContainer.this[string]

IVariableContainer.IsAssigned(string, bool)

Namespace: DNVGL.One.Compute.WorkExecution.ExecutionModel

Assembly: DNVGL.One.Compute.WorkExecution.dll

Syntax

public interface IExecutionContext : IVariableContainer

Properties

CancellationToken

Gets the cancellation token.

Declaration

CancellationToken CancellationToken { get; }

Property Value

Type	Description
CancellationToken	The cancellation token.

Exception

Gets the exception if an exception occurred while executing the ExecutableWork.

Declaration

Exception Exception { get; }

Property Value

Type	Description
Exception	The exception.

Message

Gets the message.

Declaration

string Message { get; }

Property Value

Type	Description
string	The message.

Progress

Gets the progress as a fraction between 0 (no progress) and 1 (complete).

Declaration

double Progress { get; }

Property Value

Type	Description
double	The progress as a fraction between 0 and 1.

Result

Gets the result.

Declaration

object Result { get; }

Property Value

Type	Description
object	The result.

Status

Gets the work status.

Declaration

WorkStatus Status { get; }

Property Value

Type	Description
WorkStatus	The status.

Methods

Abort(string)

Aborts the work.

Declaration

void Abort(string message = null)

Parameters

Type	Name	Description
string	message	The message.

Complete(object, string)

Completes the work.

Declaration

void Complete(object result, string message = null)

Parameters

Type	Name	Description
object	result	The result.
string	message	The message.

Derive(IComputationalWork)

Derives a child context for a particular combination of work and input.

Declaration

IExecutionContext Derive(IComputationalWork work)

Parameters

Type	Name	Description
IComputationalWork	work	The work.

Returns

Type	Description
IExecutionContext	A child context.

Remarks

This is used when a composite IComputationalWork executes by executing each constituent part. In that case a dedicated context must be derived for each part.

Fail(string, Exception)

Report that the work failed.

Declaration

void Fail(string message, Exception e = null)

Parameters

Type	Name	Description
string	message	The message.
Exception	e	An optional exception, if caught.

UpdateProgress(double, string)

Updates the progress.

Declaration

void UpdateProgress(double progress, string message = null)

Parameters

Type	Name	Description
double	progress	The progress.
string	message	The message.

Events

WorkEvent

Occurs when the status or progress of a work item changes.

Declaration

event EventHandler<ExecutableWorkEventArgs> WorkEvent

Event Type

Type	Description
EventHandler<ExecutableWorkEventArgs>