Class SimulationRunDTO

DTO class for SimulationRun

Inheritance
object
DataTransferObject<SimulationRun>
SimulationRunDTO
Implements
Inherited Members
Namespace: Quantellia.WMServer.Simulation
Assembly: WMServer.dll
Syntax
public class SimulationRunDTO : DataTransferObject<SimulationRun>, IDbEntity, IWMEntity, IDocumentedEntity, IWMOwnableResource, IWMResource

Constructors

SimulationRunDTO()

Parameterless constructor

Declaration
public SimulationRunDTO()

SimulationRunDTO(string)

Constructor specifying id

Declaration
public SimulationRunDTO(string ID)
Parameters
Type Name Description
string ID

Properties

CreatedBy

Creator of this object

Declaration
public string CreatedBy { get; set; }
Property Value
Type Description
string

CreatedDate

The date this object was created

Declaration
public DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime

Documentation

Documentation of this object

Declaration
public string? Documentation { get; set; }
Property Value
Type Description
string

DocumentationMIMEType

Documentation of this object in MIME format

Declaration
public string? DocumentationMIMEType { get; set; }
Property Value
Type Description
string

LastUpdatedBy

The person who updated this object

Declaration
public string LastUpdatedBy { get; set; }
Property Value
Type Description
string

LastUpdatedDate

The last date of update for this object

Declaration
public DateTime LastUpdatedDate { get; set; }
Property Value
Type Description
DateTime

Name

Name of this object

Declaration
public string? Name { get; set; }
Property Value
Type Description
string

OwnerID

Owner of this object

Declaration
public string OwnerID { get; set; }
Property Value
Type Description
string

OwnerType

The type of the principal of this object.

Declaration
public string OwnerType { get; set; }
Property Value
Type Description
string

SimulationID

id of the SimulationDTO this run is under.

Declaration
public string SimulationID { get; set; }
Property Value
Type Description
string

Summary

Summary of this object

Declaration
public string? Summary { get; set; }
Property Value
Type Description
string

Methods

FromModel()

Declaration
public override void FromModel()
Overrides

Get(WMPrincipal, string, WMAppDbContext)

Returns SimulationRunDTO with id, throws exception if does not exist.

Declaration
public static Task<SimulationRunDTO> Get(WMPrincipal principal, string id, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal
string id

The id of the entity
WMAppDbContext context
Returns
Type Description
Task<SimulationRunDTO>
Exceptions
Type Condition
Exception

GetAllRuns(WMPrincipal, string, WMAppDbContext)

Returns all SimulationRunDTO instances under the provided Simulation in OpenDI format

Declaration
public static Task<IEnumerable<SimulationRunDTO>> GetAllRuns(WMPrincipal principal, string id, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal

The current user
string id

The id of the simulation record to search under.
WMAppDbContext context
Returns
Type Description
Task<IEnumerable<SimulationRunDTO>>

GetAllRuns(string, WMAppDbContext)

Returns all SimulationRunDTO instances under the provided Simulation

Declaration
public static Task<IEnumerable<SimulationRunDTO>> GetAllRuns(string ID, WMAppDbContext context)
Parameters
Type Name Description
string ID

The id of the simulation record to search under.
WMAppDbContext context
Returns
Type Description
Task<IEnumerable<SimulationRunDTO>>

ResourceDefinition()

The resource operation definition for this asset.

Declaration
public static WMResourceOperationsDefinition ResourceDefinition()
Returns
Type Description
WMResourceOperationsDefinition

UpdateModel(WMPrincipal, DbContext, object[]?)

Declaration
public override Task<SimulationRun> UpdateModel(WMPrincipal principal, DbContext context, object[]? data = null)
Parameters
Type Name Description
WMPrincipal principal
DbContext context
object[] data
Returns
Type Description
Task<SimulationRun>
Overrides

Implements