Odil
A C++11 library for the DICOM standard
Public Member Functions | List of all members
odil::message::CStoreRequest Class Reference

C-STORE-RQ message. More...

#include <CStoreRequest.h>

Inheritance diagram for odil::message::CStoreRequest:
Inheritance graph
[legend]
Collaboration diagram for odil::message::CStoreRequest:
Collaboration graph
[legend]

Public Member Functions

 CStoreRequest (Value::Integer message_id, Value::String const &affected_sop_class_uid, Value::String const &affected_sop_instance_uid, Value::Integer priority, std::shared_ptr< DataSet > dataset, Value::String const &move_originator_ae_title="", Value::Integer move_originator_message_id=-1)
 Create an store request with given Message ID, affected SOP class UID, priority, and data set. More...
 
 CStoreRequest (std::shared_ptr< Message > message)
 Create a C-STORE-RQ from a generic Message. More...
 
 ODIL_MESSAGE_MANDATORY_FIELD_STRING_MACRO (affected_sop_class_uid, registry::AffectedSOPClassUID) ODIL_MESSAGE_MANDATORY_FIELD_STRING_MACRO(affected_sop_instance_uid
 
registry::AffectedSOPInstanceUID ODIL_MESSAGE_OPTIONAL_FIELD_STRING_MACRO (move_originator_ae_title, registry::MoveOriginatorApplicationEntityTitle) ODIL_MESSAGE_OPTIONAL_FIELD_INTEGER_MACRO(move_originator_message_id
 
- Public Member Functions inherited from odil::message::Request
 Request (Value::Integer message_id)
 Create a request with given Message ID. More...
 
 Request (std::shared_ptr< Message const > message)
 Create a request from the Message ID stored in the message command set. More...
 
- Public Member Functions inherited from odil::message::Message
 Message (std::shared_ptr< DataSet > command_set=std::make_shared< DataSet >(), std::shared_ptr< DataSet > data_set={})
 Create a message with an empty command set and no data set. More...
 
 Message (Message const &)=default
 
 Message (Message &&)=default
 
Messageoperator= (Message const &)=default
 
Messageoperator= (Message &&)=default
 
virtual ~Message ()=default
 
std::shared_ptr< DataSet const > get_command_set () const
 Return the command set of the message (by reference or shared pointer). More...
 
bool has_data_set () const
 Test whether as data set is present in the message. More...
 
std::shared_ptr< DataSet const > get_data_set () const
 Return the data set of the message, raise an exception if no data set is present. More...
 
std::shared_ptr< DataSetget_data_set ()
 Return the data set of the message, raise an exception if no data set is present. More...
 
void set_data_set (std::shared_ptr< DataSet > data_set)
 Set the data set of the message. More...
 
void delete_data_set ()
 Delete the data set in this message. More...
 
Value::Integer const & get_command_field () const
 Return the registry::CommandField element of the command set. More...
 
void set_command_field (Value::Integer const &value)
 Set the registry::CommandField element of the command set. More...
 

Additional Inherited Members

- Public Types inherited from odil::message::Message
enum  Command {
  C_STORE_RQ = 0x0001 , C_STORE_RSP = 0x8001 , C_FIND_RQ = 0x0020 , C_FIND_RSP = 0x8020 ,
  C_CANCEL_RQ = 0x0FFF , C_GET_RQ = 0x0010 , C_GET_RSP = 0x8010 , C_MOVE_RQ = 0x0021 ,
  C_MOVE_RSP = 0x8021 , C_ECHO_RQ = 0x0030 , C_ECHO_RSP = 0x8030 , N_EVENT_REPORT_RQ = 0x0100 ,
  N_EVENT_REPORT_RSP = 0x8100 , N_GET_RQ = 0x0110 , N_GET_RSP = 0x8110 , N_SET_RQ = 0x0120 ,
  N_SET_RSP = 0x8120 , N_ACTION_RQ = 0x0130 , N_ACTION_RSP = 0x8130 , N_CREATE_RQ = 0x0140 ,
  N_CREATE_RSP = 0x8140 , N_DELETE_RQ = 0x0150 , N_DELETE_RSP = 0x8150
}
 
enum  Priority { LOW = 0x0002 , MEDIUM = 0x0000 , HIGH = 0x0001 }
 
enum  DataSetType { PRESENT = 0x0000 , ABSENT = 0x0101 }
 
- Protected Attributes inherited from odil::message::Message
std::shared_ptr< DataSet_command_set
 Command set of the message. More...
 
std::shared_ptr< DataSet_data_set
 Data set of the message. More...
 

Detailed Description

C-STORE-RQ message.

Constructor & Destructor Documentation

◆ CStoreRequest() [1/2]

odil::message::CStoreRequest::CStoreRequest ( Value::Integer  message_id,
Value::String const &  affected_sop_class_uid,
Value::String const &  affected_sop_instance_uid,
Value::Integer  priority,
std::shared_ptr< DataSet dataset,
Value::String const &  move_originator_ae_title = "",
Value::Integer  move_originator_message_id = -1 
)

Create an store request with given Message ID, affected SOP class UID, priority, and data set.

◆ CStoreRequest() [2/2]

odil::message::CStoreRequest::CStoreRequest ( std::shared_ptr< Message message)

Create a C-STORE-RQ from a generic Message.

Raise an exception if the Message does not contain a C-STORE-RQ.

Member Function Documentation

◆ ODIL_MESSAGE_MANDATORY_FIELD_STRING_MACRO()

odil::message::CStoreRequest::ODIL_MESSAGE_MANDATORY_FIELD_STRING_MACRO ( affected_sop_class_uid  ,
registry::AffectedSOPClassUID   
)

◆ ODIL_MESSAGE_OPTIONAL_FIELD_STRING_MACRO()

registry::AffectedSOPInstanceUID odil::message::CStoreRequest::ODIL_MESSAGE_OPTIONAL_FIELD_STRING_MACRO ( move_originator_ae_title  ,
registry::MoveOriginatorApplicationEntityTitle   
)

The documentation for this class was generated from the following file: