Class DicomMessage

Namespace

FellowOakDicom.Network

Assembly

fo-dicom.core.dll

Base class for DIMSE-C and DIMSE-N message items.

public class DicomMessage

Inheritance

object

DicomMessage

Derived

DicomRequest

DicomResponse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LinqExtensions.IsOneOf<T>(T, params T[])

Constructors

DicomMessage()

Initializes a new instance of the DicomMessage class.

public DicomMessage()

DicomMessage(DicomDataset)

Initializes a new instance of the DicomMessage class.

public DicomMessage(DicomDataset command)

Parameters

command DicomDataset

The DICOM dataset representing the message command.

Properties

ApplicationInfo

Gets or sets the SOP Class Extended Negotiation Service Class Application Information.

public DicomServiceApplicationInfo ApplicationInfo { get; set; }

Property Value

DicomServiceApplicationInfo

Command

Gets or sets the associated DICOM command.

public DicomDataset Command { get; protected set; }

Property Value

DicomDataset

Dataset

Gets or sets the dataset potentially included in the message..

public DicomDataset Dataset { get; set; }

Property Value

DicomDataset

HasDataset

Gets a value indicating whether the message contains a dataset.

public bool HasDataset { get; }

Property Value

bool

LastPendingResponseReceived

Gets or sets the timestamp of when the last response with status 'Pending' was received

public DateTime? LastPendingResponseReceived { get; set; }

Property Value

DateTime?

PendingSince

Gets or sets the timestamp when the message was taken from the message queue and added to the pending list (i.e. the DICOM request is being sent or already waiting for a response)

public DateTime? PendingSince { get; set; }

Property Value

DateTime?

PresentationContext

Gets or sets the presentation Context.

public DicomPresentationContext PresentationContext { get; set; }

Property Value

DicomPresentationContext

SOPClassUID

Gets or sets the affected or requested SOP Class UID

public DicomUID SOPClassUID { get; protected set; }

Property Value

DicomUID

Type

Gets or sets the command field type.

public DicomCommandField Type { get; protected set; }

Property Value

DicomCommandField

UserState

Gets or sets the state object that will be passed from request to response objects.

public object UserState { get; set; }

Property Value

object

Methods

IsRequest(DicomCommandField)

Evaluates whether a DICOM message is a request or a response.

public static bool IsRequest(DicomCommandField type)

Parameters

type DicomCommandField

DICOM command field type.

Returns

bool

True if message is a request, false otherwise.

IsTimedOut(TimeSpan)

Given a timeout duration, returns whether this DICOM message is considered timed out or not.

public bool IsTimedOut(TimeSpan timeout)

Parameters

timeout TimeSpan

The timeout duration that should be taken into account

Returns

bool

Whether this DICOM message is considered timed out or not.

ToString()

Formatted output of the DICOM message.

public override string ToString()

Returns

string

Formatted output string of the DICOM message.

ToString(DicomCommandField)

Formatted output of the DICOM message.

public static string ToString(DicomCommandField type)

Parameters

type DicomCommandField

DICOM command field type.

Returns

string

Formatted output string of the DICOM message.

ToString(bool)

Formatted output of the DICOM message.

public string ToString(bool printDatasets)

Parameters

printDatasets bool

Indicates whether datasets should be printed.

Returns

string

Formatted output string of the DICOM message.