Class VirtualApplicationEntity

Namespace

Monai.Deploy.InformaticsGateway.Api

Assembly

Monai.Deploy.InformaticsGateway.Api.dll

Virtual Application Entity (VAE).

A VAE identifies a service or application similar to a DIMSE AE but is designed to be used for DICOMWeb.

For example, users can configure VAEs on DICOMWeb STOW-RS endpoints to enable data input plug-ins, IInputDataPlugIn. This allows different plug-ins to be associated with each VAE for data manipulation, etc...

In addition, one can trigger a new workflow request with the workflows defined in Workflows when studies are posted to a VAE-enabled STOW-RS endpoint.

public class VirtualApplicationEntity : MongoDBEntityBase

Inheritance

object

MongoDBEntityBase

VirtualApplicationEntity

Inherited Members

MongoDBEntityBase.Id

MongoDBEntityBase.DateTimeCreated

Extension Methods

ValidationExtensions.IsValid(VirtualApplicationEntity, out IList<string>)

Constructors

VirtualApplicationEntity()

public VirtualApplicationEntity()

Properties

CreatedBy

Gets or set the user who created the DICOM entity.

public string? CreatedBy { get; set; }

Property Value

string

DateTimeUpdated

Gets or set the most recent date time the DICOM entity was updated.

public DateTime? DateTimeUpdated { get; set; }

Property Value

DateTime?

Name

Gets or sets the name of a MONAI DICOM application entity. This value must be unique.

[Key]
[Column(Order = 0)]
public string Name { get; set; }

Property Value

string

PlugInAssemblies

Optional list of data input plug-in type names to be executed by the IInputDataPlugInEngine.

public List<string> PlugInAssemblies { get; set; }

Property Value

List<string>

UpdatedBy

Gets or set the most recent user who updated the DICOM entity.

public string? UpdatedBy { get; set; }

Property Value

string

VirtualAeTitle

Gets or sets the virtual AE TItle which is used as the URL fragment in the DICOMWeb STOW-RS endpoint. E.g. POST /dicomweb/vae/{aet}/studies where {aet} is the value from this property.

public string VirtualAeTitle { get; set; }

Property Value

string

Workflows

Optional field to map AE to one or more workflows.

public List<string> Workflows { get; set; }

Property Value

List<string>

Methods

SetAuthor(ClaimsPrincipal, EditMode)

public void SetAuthor(ClaimsPrincipal user, EditMode editMode)

Parameters

user ClaimsPrincipal

editMode EditMode

SetDefaultValues()

public void SetDefaultValues()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.