jdcm
Class DimseService

java.lang.Object
  jdcm.DimseService

Direct Known Subclasses:

C_Echo, C_Find, C_Get, C_Move, C_Store, N_Action, N_Create, N_Delete, N_Event_Report, N_Get, N_Set

public class DimseService
extends java.lang.Object

This class encapsulates a DICOM service used by the DIMSE protocol. DICOM provides for two kinds of DIMSE service messages: request messages sent by Service Class User (SCU) applications to Service Class Provider (SCP) applications, and response messages sent by SCP applications in reply to received request messages. In either case, you must instantiate a DimseService sub-class (C_Echo, C_Move, C_Find,C_Get, C_Store, N_Action, N_Create, N_Delete, N_Event_Report, N_Get, N_Set) object to send to the remote application. The exact contents of the command set and data set depend on the service class defined by the DICOM standard.

Field Summary

static int	PRIORITY_HIGH
static int	PRIORITY_LOW
static int	PRIORITY_MEDIUM
static int	STATUS_FAILED
static int	STATUS_PENDING
static int	STATUS_SUCCESS

Method Summary

java.lang.String	getAffectedSOPClassUID() Retrieve the Affected SOP Class UID attribute from the message's command request set.
int	getCommandField() Retrieve the DIMSE operation conveyed by this message
DicomGroup	getCommandRPS() Retrieves the command response associated with this DIMSE message.
DicomGroup	getCommandRQ() Retrieves the command request associated with this DIMSE message.
DicomSet	getDicomSet() Retrieves the data set instance associated with this DIMSE message.
int	getMessageID() Retrieve the message's ID attribute from the message's command request set.
int	getMessageIDBeingRespondedTo() Retrieve the MessageIDBeingRespondedTo attribute from the message's command response set.
int	getPresContextID() Retrieve the presentation context ID in DIMSE messages.
int	getPriority() Retrieve the priority attribute from the message's command request set.
int	getStatus() Retrieves the status attribute code from the message's command response set.
java.lang.String	getTransferSyntaxUID() Retrieve the syntax transfer UID in this DIMSE messages.
void	setAffectedSOPClassUID(java.lang.String affectedSOPClassUID) Set the Affected SOP Class UID attribute in the message's command request set.
void	setMessageID(int messageID) Set the message's ID attribute in the message's command request set.
void	setMessageIDBeingRespondedTo(int messageIDBeingRespondedTo) Set the MessageIDBeingRespondedTo attribute in the message's command response set.
void	setPresContextID(int presContextID) Set the presentation context ID in DIMSE messages.
void	setPriority(int priority) Set the priority attribute in message's command request set.
void	setStatus(int status) Set the status attribute in message's command response set.
void	setTransferSyntaxUID(java.lang.String transferSyntaxUID) Set the syntax transfer UID in this DIMSE message
java.lang.String	toString()
void	writeCancelRQ() Send a cancel message request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PRIORITY_HIGH

public static final int PRIORITY_HIGH

See Also:

Constant Field Values

PRIORITY_MEDIUM

public static final int PRIORITY_MEDIUM

See Also:

Constant Field Values

PRIORITY_LOW

public static final int PRIORITY_LOW

See Also:

Constant Field Values

STATUS_FAILED

public static final int STATUS_FAILED

See Also:

Constant Field Values

STATUS_SUCCESS

public static final int STATUS_SUCCESS

See Also:

Constant Field Values

STATUS_PENDING

public static final int STATUS_PENDING

See Also:

Constant Field Values

Method Detail

writeCancelRQ

public void writeCancelRQ()

Send a cancel message request.

getCommandRQ

public DicomGroup getCommandRQ()

Retrieves the command request associated with this DIMSE message.

getCommandRPS

public DicomGroup getCommandRPS()

Retrieves the command response associated with this DIMSE message.

getDicomSet

public DicomSet getDicomSet()

Retrieves the data set instance associated with this DIMSE message.

getStatus

public int getStatus()

Retrieves the status attribute code from the message's command response set.

Returns:

STATUS_FAILED, STATUS_PENDING, STATUS_SUCCESS

setStatus

public void setStatus(int status)

Set the status attribute in message's command response set.

Parameters:

status - STATUS_FAILED, STATUS_PENDING, STATUS_SUCCESS

getPriority

public int getPriority()

Retrieve the priority attribute from the message's command request set.

Returns:

PRIORITY_LOW, PRIORITY_MEDIUM, PRIORITY_HIGH

setPriority

public void setPriority(int priority)

Set the priority attribute in message's command request set.

Parameters:

priority - PRIORITY_LOW, PRIORITY_MEDIUM, PRIORITY_HIGH

setPresContextID

public void setPresContextID(int presContextID)

Set the presentation context ID in DIMSE messages.

getPresContextID

public int getPresContextID()

Retrieve the presentation context ID in DIMSE messages.

setMessageID

public void setMessageID(int messageID)

Set the message's ID attribute in the message's command request set.

getMessageID

public int getMessageID()

Retrieve the message's ID attribute from the message's command request set.

setMessageIDBeingRespondedTo

public void setMessageIDBeingRespondedTo(int messageIDBeingRespondedTo)

Set the MessageIDBeingRespondedTo attribute in the message's command response set.

getMessageIDBeingRespondedTo

public int getMessageIDBeingRespondedTo()

Retrieve the MessageIDBeingRespondedTo attribute from the message's command response set.

setAffectedSOPClassUID

public void setAffectedSOPClassUID(java.lang.String affectedSOPClassUID)

Set the Affected SOP Class UID attribute in the message's command request set.

getAffectedSOPClassUID

public java.lang.String getAffectedSOPClassUID()

Retrieve the Affected SOP Class UID attribute from the message's command request set.

getTransferSyntaxUID

public java.lang.String getTransferSyntaxUID()

Retrieve the syntax transfer UID in this DIMSE messages.

setTransferSyntaxUID

public void setTransferSyntaxUID(java.lang.String transferSyntaxUID)

Set the syntax transfer UID in this DIMSE message

getCommandField

public int getCommandField()

Retrieve the DIMSE operation conveyed by this message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object