Class EvaluationDTO

Persistent record of the inputs and calculations performed during a call to Run(EvaluationArgs)

Inheritance

object

DataTransferObject<Evaluation>

EvaluationDTO

Implements

IDbEntity

IWMEntity

IDocumentedEntity

ISimulationResult

Inherited Members

DataTransferObject<Evaluation>.ID

DataTransferObject<Evaluation>.ModelObject

DataTransferObject<Evaluation>.SetID(string)

DataTransferObject<Evaluation>.CreateModel(WMPrincipal, DbContext, object[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Quantellia.WMServer.Execution

Assembly: WMServer.dll

Syntax

public class EvaluationDTO : DataTransferObject<Evaluation>, IDbEntity, IWMEntity, IDocumentedEntity, ISimulationResult

Constructors

EvaluationDTO()

Create a new instance of a EvaluationDTO object.

Declaration

public EvaluationDTO()

Fields

DecisionModelID

The ID of the DecisionModel that was used to run this Evaluation.

Declaration

public string DecisionModelID

Field Value

Type	Description
string

Properties

Args

A JSON string that encodes the EvaluationArgs associated with this Evaluation.

Declaration

public string Args { get; set; }

Property Value

Type	Description
string

CreatedBy

ID of the user that created this entity.

Declaration

public string CreatedBy { get; set; }

Property Value

Type	Description
string

CreatedDate

Date and time at which this entity was last updated.

Declaration

public DateTime CreatedDate { get; set; }

Property Value

Type	Description
DateTime

Documentation

Longer form documenation possibly in HTML, markdown, or other formats. May be null.

Declaration

public string? Documentation { get; set; }

Property Value

Type	Description
string

DocumentationMIMEType

MIME type used to encode the Documentation property. May be null if Documentation is null, otherwise it must be set to a valid MIME type.

Declaration

public string? DocumentationMIMEType { get; set; }

Property Value

Type	Description
string

Info

Optional additional information on the disqualification of this results.

Declaration

public string Info { get; set; }

Property Value

Type	Description
string

LastUpdatedBy

ID of the user that last updated this entity.

Declaration

public string LastUpdatedBy { get; set; }

Property Value

Type	Description
string

LastUpdatedDate

Date and time at which this entity was last updated.

Declaration

public DateTime LastUpdatedDate { get; set; }

Property Value

Type	Description
DateTime

Name

Name given to the Evaluation. Must not be null.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

OwnerID

Reference to the WMPrincipal that owns this Evaluation

Declaration

public string OwnerID { get; set; }

Property Value

Type	Description
string

OwnerType

Declaration

public string OwnerType { get; set; }

Property Value

Type	Description
string

ProcessorID

ID of the WMProcessor the performed this evaluation.

Declaration

public string ProcessorID { get; set; }

Property Value

Type	Description
string

Qualified

Whether this results is qualified or not

Declaration

public bool Qualified { get; set; }

Property Value

Type	Description
bool

Result

A JSON string that encodes the results of the evaluation as an ElementValue associated with this Evaluation.

Declaration

public string Result { get; set; }

Property Value

Type	Description
string

SimIndex

The iteration number of this results

Declaration

public int SimIndex { get; set; }

Property Value

Type	Description
int

SimulationRunID

The ID of the SimulationRun that generated this results

Declaration

public string SimulationRunID { get; set; }

Property Value

Type	Description
string

Summary

Short summary string for the Evaluation. May be null.

Declaration

public string? Summary { get; set; }

Property Value

Type	Description
string

UserData

Optional user data that may be associated with this evaluation.

Declaration

public string? UserData { get; set; }

Property Value

Type	Description
string

Methods

FromModel()

Populate this EvaluationDTO from the data in the associated ModelObject.

Declaration

public override void FromModel()

Overrides

DataTransferObject<Evaluation>.FromModel()

UpdateModel(WMPrincipal, DbContext, object[]?)

Update the associated ModelObject with the data from this EvaluationDTO.

Declaration

public override Task<Evaluation> UpdateModel(WMPrincipal principal, DbContext context, object[]? data = null)

Parameters

Type	Name	Description
WMPrincipal	principal
DbContext	context
object[]	data	The first element may optionally be set to an ElementValue instance containing the results of the evaluation. The second element may optionall be set to an EvaluationArgs instance containing the arguments on which the Evaluation was based.

Returns

Type	Description
Task<Evaluation>

Overrides

DataTransferObject<Evaluation>.UpdateModel(WMPrincipal, DbContext, object[])

Implements

IDbEntity

IWMEntity

IDocumentedEntity

ISimulationResult