Class MonaiApplicationEntity

MONAI Application Entity MONAI's SCP AE Title is used to accept incoming associations and can, optionally, map to multiple workflows.

Inheritance
System.Object
MongoDBEntityBase
MonaiApplicationEntity
Inherited Members
Namespace: Monai.Deploy.InformaticsGateway.Api.Models
Assembly: Monai.Deploy.InformaticsGateway.Api.dll
Syntax
public class MonaiApplicationEntity : MongoDBEntityBase
Examples
{
    "name": "brain-tumor",
    "aeTitle": "BrainTumorModel"
}
{
    "name": "COVID-19",
    "aeTitle": "COVID-19",
    "workflows": [ "EXAM", "Delta", "b75cd27a-068a-4f9c-b3da-e5d4ea08c55a"],
    "grouping": [ "0010,0020"],
    "ignoredSopClasses": ["1.2.840.10008.5.1.4.1.1.1.1"],
    "allowedSopClasses": ["1.2.840.10008.5.1.4.1.1.1.2"],
    "timeout": 300
}

Constructors

| Improve this Doc View Source

MonaiApplicationEntity()

Declaration
public MonaiApplicationEntity()

Properties

| Improve this Doc View Source

AeTitle

Gets or sets the AE TItle.

Declaration
public string AeTitle { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

AllowedSopClasses

Optional field to specify accepted SOP Class UIDs. IgnoredSopClasses and AllowedSopClasses are mutually exclusive.

Declaration
public List<string> AllowedSopClasses { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

CreatedBy

Gets or set the user who created the DICOM entity.

Declaration
public string CreatedBy { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DateTimeUpdated

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

Declaration
public DateTime? DateTimeUpdated { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

Grouping

Gets or sets the DICOM tag used to group the instances. Defaults to 0020,000D (Study Instance UID). Valid DICOM Tags: > Study Instance UID (0020,000D) and Series Instance UID (0020,000E).

Declaration
public string Grouping { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IgnoredSopClasses

Optional field to specify SOP Class UIDs to ignore. IgnoredSopClasses and AllowedSopClasses are mutually exclusive.

Declaration
public List<string> IgnoredSopClasses { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

Name

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

Declaration
[Key]
[Column(Order = 0)]
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PlugInAssemblies

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

Declaration
public List<string> PlugInAssemblies { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
| Improve this Doc View Source

Timeout

Timeout, in seconds, to wait for instances before notifying other subsystems of data arrival for the specified data group. Defaults to five seconds.

Declaration
public uint Timeout { get; set; }
Property Value
Type Description
System.UInt32
| Improve this Doc View Source

UpdatedBy

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

Declaration
public string UpdatedBy { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Workflows

Optional field to map AE to one or more workflows.

Declaration
public List<string> Workflows { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Methods

| Improve this Doc View Source

SetAuthor(ClaimsPrincipal, EditMode)

Declaration
public void SetAuthor(ClaimsPrincipal user, EditMode editMode)
Parameters
Type Name Description
System.Security.Claims.ClaimsPrincipal user
EditMode editMode
| Improve this Doc View Source

SetDefaultValues()

Declaration
public void SetDefaultValues()
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Extension Methods