Class DicomFileStorageMetadata

Namespace

Monai.Deploy.InformaticsGateway.Api.Storage

Assembly

Monai.Deploy.InformaticsGateway.Api.dll

Provides basic information for a DICOM instance and storage hierarchy/path.

public sealed record DicomFileStorageMetadata : FileStorageMetadata, IEquatable<FileStorageMetadata>, IEquatable<DicomFileStorageMetadata>

Inheritance

object

FileStorageMetadata

DicomFileStorageMetadata

Implements

IEquatable<FileStorageMetadata>

IEquatable<DicomFileStorageMetadata>

Inherited Members

FileStorageMetadata.Id

FileStorageMetadata.CorrelationId

FileStorageMetadata.DataOrigin

FileStorageMetadata.Workflows

FileStorageMetadata.DateReceived

FileStorageMetadata.WorkflowInstanceId

FileStorageMetadata.TaskId

FileStorageMetadata.PayloadId

FileStorageMetadata.SetWorkflows(params string[])

FileStorageMetadata.ChangeCorrelationId(ILogger, string)

FileStorageMetadata.IpAddress()

Constructors

DicomFileStorageMetadata()

DO NOT USE This constructor is intended for JSON serializer. Due to limitation in current version of .NET, the constructor must be public. https://github.com/dotnet/runtime/issues/31511

[JsonConstructor]
public DicomFileStorageMetadata()

DicomFileStorageMetadata(string, string, string, string, string, DataService, string, string)

public DicomFileStorageMetadata(string associationId, string identifier, string studyInstanceUid, string seriesInstanceUid, string sopInstanceUid, DataService dataService, string callingAeTitle, string calledAeTitle)

Parameters

associationId string

identifier string

studyInstanceUid string

seriesInstanceUid string

sopInstanceUid string

dataService DataService

callingAeTitle string

calledAeTitle string

Fields

DicomContentType

public static readonly string DicomContentType

Field Value

string

DicomJsonContentType

public static readonly string DicomJsonContentType

Field Value

string

DicomJsonFileExtension

public static readonly string DicomJsonFileExtension

Field Value

string

DicomSubDirectoryName

public static readonly string DicomSubDirectoryName

Field Value

string

FileExtension

public static readonly string FileExtension

Field Value

string

Properties

DataTypeDirectoryName

Gets the root directory name

[JsonIgnore]
public override string DataTypeDirectoryName { get; }

Property Value

string

File

Gets the storage object associated.

[JsonPropertyName("file")]
public override StorageObjectMetadata File { get; set; }

Property Value

StorageObjectMetadata

IsMoveCompleted

[JsonIgnore]
public override bool IsMoveCompleted { get; }

Property Value

bool

IsUploadFailed

[JsonIgnore]
public override bool IsUploadFailed { get; }

Property Value

bool

IsUploaded

[JsonIgnore]
public override bool IsUploaded { get; }

Property Value

bool

JsonFile

Gets the storage object metadata for the JSON file associated with the DICOM instance.

[JsonPropertyName("jsonFile")]
public StorageObjectMetadata JsonFile { get; set; }

Property Value

StorageObjectMetadata

SeriesInstanceUid

Gets or set the Series Instance UID of the DICOM instance.

[JsonPropertyName("seriesInstanceUid")]
public string SeriesInstanceUid { get; init; }

Property Value

string

SopInstanceUid

Gets or set the SOP Instance UID of the DICOM instance.

[JsonPropertyName("sopInstanceUid")]
public string SopInstanceUid { get; init; }

Property Value

string

StudyInstanceUid

Gets or set the Study Instance UID of the DICOM instance.

[JsonPropertyName("studyInstanceUid")]
public string StudyInstanceUid { get; set; }

Property Value

string

Methods

SetFailed()

public override void SetFailed()

SetStudyInstanceUid(string)

public void SetStudyInstanceUid(string newStudyInstanceUid)

Parameters

newStudyInstanceUid string

SetupGivenFilePaths(string?)

public void SetupGivenFilePaths(string? DestinationFolder)

Parameters

DestinationFolder string