com.archimed.dicom.network
Class Command

java.lang.Object
  com.archimed.dicom.GroupList
      com.archimed.dicom.DicomObject
          com.archimed.dicom.network.Command

public class Command
extends DicomObject

represents the command part in a DIMSE message. The Command class does not have a public constructor. Instances of the command class are always created through static methods.

For every request command their is static factory method that takes as it's arguments tha mandatory tags of the request. For every response command their is static factory method that takes as it's arguments the corresponding request command and any mandatory parameters not implicitly supplied by the corresponding request.

This class also has some setters/getters for tag values common to commands such as status,affectedSOPClassUID,affectedSOPInstanceUID, ... .

Since:

1.50

Field Summary

static int	C_CANCEL_REQUEST
static int	C_ECHO_REQUEST
static int	C_ECHO_RESPONSE
static int	C_FIND_REQUEST
static int	C_FIND_RESPONSE
static int	C_GET_REQUEST
static int	C_GET_RESPONSE
static int	C_MOVE_REQUEST
static int	C_MOVE_RESPONSE
static int	C_STORE_REQUEST
static int	C_STORE_RESPONSE
static int	HIGH_PRIORITY
static int	LOW_PRIORITY
static int	MEDIUM_PRIORITY
static int	N_ACTION_REQUEST
static int	N_ACTION_RESPONSE
static int	N_CREATE_REQUEST
static int	N_CREATE_RESPONSE
static int	N_DELETE_REQUEST
static int	N_DELETE_RESPONSE
static int	N_EVENT_REPORT_REQUEST
static int	N_EVENT_REPORT_RESPONSE
static int	N_GET_REQUEST
static int	N_GET_RESPONSE
static int	N_SET_REQUEST
static int	N_SET_RESPONSE

Fields inherited from class com.archimed.dicom.DicomObject

log

Method Summary

static Command	createCCancel(Command cReq)
static Command	createCEchoReq(int messageID, int affectedSOPClassUID)
static Command	createCEchoRes(Command cechoreqcmd, int status)
static Command	createCFindReq(int messageID, int affectedSOPClassUID, int priority)
static Command	createCFindRes(Command cFindReq, int status, boolean identifier)
static Command	createCGetReq(int messageID, int affectedSOPClassUID, int priority)
static Command	createCGetRes(Command cGetReq, int status, boolean identifier)
static Command	createCMoveReq(int messageID, int affectedSOPClassUID, int priority, java.lang.String moveDestinationAE)
static Command	createCMoveRes(Command cMoveReq, int status, boolean identifier)
static Command	createCStoreReq(int messageID, int affectedSOPClassUID, int priority, java.lang.String affectedSOPInstanceUID)
static Command	createCStoreRes(Command cStoreReq, int status)
static Command	createNActionReq(int messageID, int requestedSOPClassUID, java.lang.String requestedSOPInstanceUID, int actionTypeID, boolean identifier)
static Command	createNActionRes(Command nActionReq, int status, boolean identifier)
static Command	createNCreateReq(int messageID, int affectedSOPClassUID, java.lang.String affectedSOPInstanceUID, boolean identifier)
static Command	createNCreateRes(Command nCreateReq, int status, boolean identifier)
static Command	createNDeleteReq(int messageID, int requestedSOPClassUID, java.lang.String requestedSOPInstanceUID)
static Command	createNDeleteRes(Command nDeleteReq, int status)
static Command	createNEventReportReq(int messageID, int affectedSOPClassUID, java.lang.String affectedSOPInstanceUID, int eventTypeID, boolean identifier)
static Command	createNEventReportRes(Command nEventReportReq, int status, boolean identifier)
static Command	createNGetReq(int messageID, int requestedSOPClassUID, java.lang.String requestedSOPInstanceUID)
static Command	createNGetRes(Command nGetReq, int status, boolean identifier)
static Command	createNSetReq(int messageID, int requestedSOPClassUID, java.lang.String requestedSOPInstanceUID)
static Command	createNSetRes(Command nSetReq, int status, boolean identifier)
int	getActionTypeID()
int	getAffectedSOPClass()
java.lang.String	getAffectedSOPInstance()
java.lang.String	getCommandName()
int	getCommandType()
int	getCompletedSuboperations()
int	getEventTypeID()
int	getFailedSuboperations()
int	getMessageID()
java.lang.String	getMoveOriginatorAE()
int	getMoveOriginatorID()
int	getPriority()
int	getRemainingSuboperations()
int	getRequestedSOPClass()
java.lang.String	getRequestedSOPInstance()
int	getResponseMessageID()
int	getStatus()
int	getWarningSuboperations()
boolean	hasData()
void	hasData(boolean b)
void	setActionTypeID(int actionTypeID)
void	setAffectedSOPClass(int affectedSOPClassUID)
void	setAffectedSOPInstance(java.lang.String sopInstanceUID)
void	setCommandType(int commandType)
void	setCompletedSuboperations(int completedSubops)
void	setEventTypeID(int eventTypeID)
void	setFailedSuboperations(int failedSubops)
void	setMessageID(int messageID)
void	setMoveDestination(java.lang.String moveDestinationAE)
void	setMoveOriginatorAE(java.lang.String moveAE)
void	setMoveOriginatorMessageID(int moveOriginatorMessageID)
void	setPriority(int priority)
void	setRemainingSuboperations(int remainingSubops)
void	setRequestedSOPClass(int requestedSOPClassUID)
void	setRequestedSOPInstance(java.lang.String sopInstanceUID)
void	setResponseMessageID(int messageID)
void	setStatus(int status)
void	setWarningSuboperations(int warningSubops)

Methods inherited from class com.archimed.dicom.DicomObject

addATValue_ge, addATValue, addBigDecimal_ge, addBigDecimal, addBytes_ge, addBytes, addDouble_ge, addDouble, addFloat_ge, addFloat, addFloats_ge, addFloats, addInteger_ge, addInteger, addLong_ge, addLong, addPersonName_ge, addPersonName_ge, addPersonName, addPersonName, addSequenceItem_ge, addSequenceItem, addShort_ge, addShort, addString_ge, addString, append_ge, append, calculateOffset, deleteItem_ge, deleteItem_ge, deleteItem, deleteItem, dicomCharsets, dumpVRs, dumpVRs, get_ge, get_ge, get, get, getATValue_ge, getATValue, getBigDecimal_ge, getBigDecimal, getBytes_ge, getBytes, getDataElement, getDataElement, getDouble_ge, getDouble, getFileMetaInformation, getFloat_ge, getFloat, getFloats_ge, getFloats, getI_ge, getI_ge, getI, getI, getInteger_ge, getInteger, getLong_ge, getLong, getOffset, getParent, getPersonName_ge, getPersonName, getPreamble, getS_ge, getS_ge, getS, getS, getSeqItemLenState, getSeqLenState_ge, getSeqLenState, getSequenceItem_ge, getSequenceItem, getShort_ge, getShort, getSize_ge, getSize, getString_ge, getString_ge, getString, getString, getType_ge, getType, newDataElement_ge, newDataElement, read, read, read, remove_ge, remove, set_ge, set_ge, set, set, setATValue_ge, setATValue, setBigDecimal_ge, setBigDecimal, setBytes_ge, setBytes, setDouble_ge, setDouble, setFileMetaInformation, setFloat_ge, setFloat, setFloats_ge, setFloats, setInteger_ge, setInteger, setLong_ge, setLong, setPersonName_ge, setPersonName_ge, setPersonName, setPersonName, setPreamble, setSeqItemLenState, setSeqLenState_ge, setSeqLenState, setSequenceItem_ge, setSequenceItem, setShort_ge, setShort, setString_ge, setString, setType_ge, setType, write, write, write

Methods inherited from class com.archimed.dicom.GroupList

addGroups, clear, containsGroup, copyGroup, enumerateVRs, enumerateVRs, isEmpty, numberOfElements, numberOfGroups, removeGroup

Methods inherited from class java.lang.Object

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

Field Detail

N_EVENT_REPORT_REQUEST

public static final int N_EVENT_REPORT_REQUEST

See Also:

Constant Field Values

N_EVENT_REPORT_RESPONSE

public static final int N_EVENT_REPORT_RESPONSE

See Also:

Constant Field Values

N_GET_REQUEST

public static final int N_GET_REQUEST

See Also:

Constant Field Values

N_GET_RESPONSE

public static final int N_GET_RESPONSE

See Also:

Constant Field Values

N_SET_REQUEST

public static final int N_SET_REQUEST

See Also:

Constant Field Values

N_SET_RESPONSE

public static final int N_SET_RESPONSE

See Also:

Constant Field Values

N_ACTION_REQUEST

public static final int N_ACTION_REQUEST

See Also:

Constant Field Values

N_ACTION_RESPONSE

public static final int N_ACTION_RESPONSE

See Also:

Constant Field Values

N_CREATE_REQUEST

public static final int N_CREATE_REQUEST

See Also:

Constant Field Values

N_CREATE_RESPONSE

public static final int N_CREATE_RESPONSE

See Also:

Constant Field Values

N_DELETE_REQUEST

public static final int N_DELETE_REQUEST

See Also:

Constant Field Values

N_DELETE_RESPONSE

public static final int N_DELETE_RESPONSE

See Also:

Constant Field Values

C_STORE_REQUEST

public static final int C_STORE_REQUEST

See Also:

Constant Field Values

C_STORE_RESPONSE

public static final int C_STORE_RESPONSE

See Also:

Constant Field Values

C_GET_REQUEST

public static final int C_GET_REQUEST

See Also:

Constant Field Values

C_GET_RESPONSE

public static final int C_GET_RESPONSE

See Also:

Constant Field Values

C_FIND_REQUEST

public static final int C_FIND_REQUEST

See Also:

Constant Field Values

C_FIND_RESPONSE

public static final int C_FIND_RESPONSE

See Also:

Constant Field Values

C_MOVE_REQUEST

public static final int C_MOVE_REQUEST

See Also:

Constant Field Values

C_MOVE_RESPONSE

public static final int C_MOVE_RESPONSE

See Also:

Constant Field Values

C_ECHO_REQUEST

public static final int C_ECHO_REQUEST

See Also:

Constant Field Values

C_ECHO_RESPONSE

public static final int C_ECHO_RESPONSE

See Also:

Constant Field Values

C_CANCEL_REQUEST

public static final int C_CANCEL_REQUEST

See Also:

Constant Field Values

MEDIUM_PRIORITY

public static final int MEDIUM_PRIORITY

See Also:

Constant Field Values

HIGH_PRIORITY

public static final int HIGH_PRIORITY

See Also:

Constant Field Values

LOW_PRIORITY

public static final int LOW_PRIORITY

See Also:

Constant Field Values

Method Detail

getCommandType

public int getCommandType()
                   throws DicomException

Throws:

DicomException

setCommandType

public void setCommandType(int commandType)
                    throws DicomException

Throws:

DicomException

getMessageID

public int getMessageID()
                 throws DicomException

Throws:

DicomException

setMessageID

public void setMessageID(int messageID)
                  throws DicomException

Throws:

DicomException

getResponseMessageID

public int getResponseMessageID()
                         throws DicomException

Throws:

DicomException

setResponseMessageID

public void setResponseMessageID(int messageID)
                          throws DicomException

Throws:

DicomException

getStatus

public int getStatus()
              throws DicomException

Throws:

DicomException

setStatus

public void setStatus(int status)
               throws DicomException

Throws:

DicomException

getAffectedSOPClass

public int getAffectedSOPClass()
                        throws DicomException

Throws:

DicomException

setAffectedSOPClass

public void setAffectedSOPClass(int affectedSOPClassUID)
                         throws DicomException

Throws:

DicomException

getRequestedSOPClass

public int getRequestedSOPClass()
                         throws DicomException

Throws:

DicomException

setRequestedSOPClass

public void setRequestedSOPClass(int requestedSOPClassUID)
                          throws DicomException

Throws:

DicomException

getAffectedSOPInstance

public java.lang.String getAffectedSOPInstance()
                                        throws DicomException

Throws:

DicomException

setRequestedSOPInstance

public void setRequestedSOPInstance(java.lang.String sopInstanceUID)
                             throws DicomException

Throws:

DicomException

getRequestedSOPInstance

public java.lang.String getRequestedSOPInstance()
                                         throws DicomException

Throws:

DicomException

setAffectedSOPInstance

public void setAffectedSOPInstance(java.lang.String sopInstanceUID)
                            throws DicomException

Throws:

DicomException

hasData

public void hasData(boolean b)
             throws DicomException

Throws:

DicomException

hasData

public boolean hasData()
                throws DicomException

Throws:

DicomException

getPriority

public int getPriority()
                throws DicomException

Throws:

DicomException

setPriority

public void setPriority(int priority)
                 throws DicomException

Throws:

DicomException

getMoveOriginatorAE

public java.lang.String getMoveOriginatorAE()
                                     throws DicomException

Throws:

DicomException

setMoveOriginatorAE

public void setMoveOriginatorAE(java.lang.String moveAE)
                         throws DicomException

Throws:

DicomException

getRemainingSuboperations

public int getRemainingSuboperations()
                              throws DicomException

Throws:

DicomException

setRemainingSuboperations

public void setRemainingSuboperations(int remainingSubops)
                               throws DicomException

Throws:

DicomException

getCompletedSuboperations

public int getCompletedSuboperations()
                              throws DicomException

Throws:

DicomException

setCompletedSuboperations

public void setCompletedSuboperations(int completedSubops)
                               throws DicomException

Throws:

DicomException

getFailedSuboperations

public int getFailedSuboperations()
                           throws DicomException

Throws:

DicomException

setFailedSuboperations

public void setFailedSuboperations(int failedSubops)
                            throws DicomException

Throws:

DicomException

getWarningSuboperations

public int getWarningSuboperations()
                            throws DicomException

Throws:

DicomException

setWarningSuboperations

public void setWarningSuboperations(int warningSubops)
                             throws DicomException

Throws:

DicomException

getMoveOriginatorID

public int getMoveOriginatorID()
                        throws DicomException

Throws:

DicomException

setMoveOriginatorMessageID

public void setMoveOriginatorMessageID(int moveOriginatorMessageID)
                                throws DicomException

Throws:

DicomException

setMoveDestination

public void setMoveDestination(java.lang.String moveDestinationAE)
                        throws DicomException

Throws:

DicomException

getEventTypeID

public int getEventTypeID()
                   throws DicomException

Throws:

DicomException

setEventTypeID

public void setEventTypeID(int eventTypeID)
                    throws DicomException

Throws:

DicomException

getActionTypeID

public int getActionTypeID()
                    throws DicomException

Throws:

DicomException

setActionTypeID

public void setActionTypeID(int actionTypeID)
                     throws DicomException

Throws:

DicomException

getCommandName

public java.lang.String getCommandName()
                                throws DicomException

Throws:

DicomException

createCEchoReq

public static Command createCEchoReq(int messageID,
                                     int affectedSOPClassUID)
                              throws DicomException

Throws:

DicomException

createCEchoRes

public static Command createCEchoRes(Command cechoreqcmd,
                                     int status)
                              throws DicomException

Throws:

DicomException

createCStoreReq

public static Command createCStoreReq(int messageID,
                                      int affectedSOPClassUID,
                                      int priority,
                                      java.lang.String affectedSOPInstanceUID)
                               throws DicomException

Throws:

DicomException

createCStoreRes

public static Command createCStoreRes(Command cStoreReq,
                                      int status)
                               throws DicomException

Throws:

DicomException

createCFindReq

public static Command createCFindReq(int messageID,
                                     int affectedSOPClassUID,
                                     int priority)
                              throws DicomException

Throws:

DicomException

createCFindRes

public static Command createCFindRes(Command cFindReq,
                                     int status,
                                     boolean identifier)
                              throws DicomException

Throws:

DicomException

createCCancel

public static Command createCCancel(Command cReq)
                             throws DicomException

Throws:

DicomException

createCGetReq

public static Command createCGetReq(int messageID,
                                    int affectedSOPClassUID,
                                    int priority)
                             throws DicomException

Throws:

DicomException

createCGetRes

public static Command createCGetRes(Command cGetReq,
                                    int status,
                                    boolean identifier)
                             throws DicomException

Throws:

DicomException

createCMoveReq

public static Command createCMoveReq(int messageID,
                                     int affectedSOPClassUID,
                                     int priority,
                                     java.lang.String moveDestinationAE)
                              throws DicomException

Throws:

DicomException

createCMoveRes

public static Command createCMoveRes(Command cMoveReq,
                                     int status,
                                     boolean identifier)
                              throws DicomException

Throws:

DicomException

createNEventReportReq

public static Command createNEventReportReq(int messageID,
                                            int affectedSOPClassUID,
                                            java.lang.String affectedSOPInstanceUID,
                                            int eventTypeID,
                                            boolean identifier)
                                     throws DicomException

Throws:

DicomException

createNEventReportRes

public static Command createNEventReportRes(Command nEventReportReq,
                                            int status,
                                            boolean identifier)
                                     throws DicomException

Throws:

DicomException

createNGetReq

public static Command createNGetReq(int messageID,
                                    int requestedSOPClassUID,
                                    java.lang.String requestedSOPInstanceUID)
                             throws DicomException

Throws:

DicomException

createNGetRes

public static Command createNGetRes(Command nGetReq,
                                    int status,
                                    boolean identifier)
                             throws DicomException

Throws:

DicomException

createNSetReq

public static Command createNSetReq(int messageID,
                                    int requestedSOPClassUID,
                                    java.lang.String requestedSOPInstanceUID)
                             throws DicomException

Throws:

DicomException

createNSetRes

public static Command createNSetRes(Command nSetReq,
                                    int status,
                                    boolean identifier)
                             throws DicomException

Throws:

DicomException

createNActionReq

public static Command createNActionReq(int messageID,
                                       int requestedSOPClassUID,
                                       java.lang.String requestedSOPInstanceUID,
                                       int actionTypeID,
                                       boolean identifier)
                                throws DicomException

Throws:

DicomException

createNActionRes

public static Command createNActionRes(Command nActionReq,
                                       int status,
                                       boolean identifier)
                                throws DicomException

Throws:

DicomException

createNCreateReq

public static Command createNCreateReq(int messageID,
                                       int affectedSOPClassUID,
                                       java.lang.String affectedSOPInstanceUID,
                                       boolean identifier)
                                throws DicomException

Throws:

DicomException

createNCreateRes

public static Command createNCreateRes(Command nCreateReq,
                                       int status,
                                       boolean identifier)
                                throws DicomException

Throws:

DicomException

createNDeleteReq

public static Command createNDeleteReq(int messageID,
                                       int requestedSOPClassUID,
                                       java.lang.String requestedSOPInstanceUID)
                                throws DicomException

Throws:

DicomException

createNDeleteRes

public static Command createNDeleteRes(Command nDeleteReq,
                                       int status)
                                throws DicomException

Throws:

DicomException