Class WorkItemEventArgs

Work item event data for a given WorkItem.

Inheritance

System.Object

WorkItemEventArgs

Namespace: DNVGL.One.Compute.Core.Scheduling

Assembly: DNVGL.One.Compute.Core.dll

Syntax

public class WorkItemEventArgs : EventArgs

Properties

JobId

Gets the job identifier.

Declaration

public string JobId { get; }

Property Value

Type	Description
System.String	The job identifier.

Message

Gets the message.

Declaration

public string Message { get; }

Property Value

Type	Description
System.String	The message.

Progress

Gets the progress as a value between 0 and 1.

Declaration

public double Progress { get; }

Property Value

Type	Description
System.Double	The progress.

WorkItemId

Gets the work item identifier.

Declaration

public string WorkItemId { get; }

Property Value

Type	Description
System.String	The work item identifier.

WorkStatus

Gets the work status.

Declaration

public WorkStatus WorkStatus { get; }

Property Value

Type	Description
WorkStatus	The work status.

Methods

CreateProgressChangedEvent(String, String, Double, String)

Creates a progress changed event for a given job and work item.

Declaration

public static WorkItemEventArgs CreateProgressChangedEvent(string jobId, string workItemId, double progress, string message = null)

Parameters

Type	Name	Description
System.String	jobId	The job identifier.
System.String	workItemId	The work item identifier.
System.Double	progress	The progress as a value between 0 and 1.
System.String	message	The message.

Returns

Type	Description
WorkItemEventArgs	A WorkItemEventArgs.

CreateStatusChangedEvent(String, String, WorkStatus, String)

Creates a status changed event for a given job and work item.

Declaration

public static WorkItemEventArgs CreateStatusChangedEvent(string jobId, string workItemId, WorkStatus workStatus, string message = null)

Parameters

Type	Name	Description
System.String	jobId	The job identifier.
System.String	workItemId	The work item identifier.
WorkStatus	workStatus	The work status.
System.String	message	The message.

Returns

Type	Description
WorkItemEventArgs	A WorkItemEventArgs.