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

C-FIND-RSP message. More...

#include <CFindResponse.h>

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

Public Types

enum  Status { RefusedOutOfResources =0xA700, IdentifierDoesNotMatchSOPClass =0xA900, UnableToProcess =0xC000, PendingWarningOptionalKeysNotSupported =0xFF01 }
 C-FIND status codes, PS 3.4, C.4.1.1.4. More...
 
- Public Types inherited from odil::message::Response
enum  Status {
  Success =0x0000, Cancel =0xFE00, Pending =0xFF00, AttributeListError =0x0107,
  AttributeValueOutOfRange =0x0116, SOPClassNotSupported =0x0122, ClassInstanceConflict =0x0119, DuplicateSOPInstance =0x0111,
  DuplicateInvocation =0x0210, InvalidArgumentValue =0x0115, InvalidAttributeValue =0x0106, InvalidObjectInstance =0x0117,
  MissingAttribute =0x0120, MissingAttributeValue =0x0121, MistypedArgument =0x0212, NoSuchArgument =0x0114,
  NoSuchAttribute =0x0105, NoSuchEventType =0x0113, NoSuchSOPInstance =0x0112, NoSuchSOPClass =0x0118,
  ProcessingFailure =0x0110, ResourceLimitation =0x0213, UnrecognizedOperation =0x0211, NoSuchActionType =0x0123,
  RefusedNotAuthorized =0x0124
}
 General status codes, from PS3.7, C. More...
 

Public Member Functions

 CFindResponse (Value::Integer message_id_being_responded_to, Value::Integer status)
 Create an find response with given Message ID, and status. More...
 
 CFindResponse (Value::Integer message_id_being_responded_to, Value::Integer status, DataSet const &dataset)
 Create an find response with given Message ID, status, and data set. More...
 
 CFindResponse (Value::Integer message_id_being_responded_to, Value::Integer status, DataSet &&dataset)
 Create an find response with given Message ID, status, and data set. More...
 
 CFindResponse (Message const &message)
 Create a C-FIND-RSP from a generic Message. More...
 
 CFindResponse (Message &&message)
 Create a C-FIND-RSP from a generic Message. More...
 
virtual ~CFindResponse ()
 Destructor. More...
 
- Public Member Functions inherited from odil::message::Response
 Response (Value::Integer message_id_being_responded_to, Value::Integer status)
 Create a response with given message id and status;. More...
 
 Response (Message const &message)
 Create a response from the Message ID Being Responded To and the Status stored in the message command set. More...
 
virtual ~Response ()
 Destructor. More...
 
 ODIL_MESSAGE_MANDATORY_FIELD_INTEGER_MACRO (message_id_being_responded_to, registry::MessageIDBeingRespondedTo) ODIL_MESSAGE_OPTIONAL_FIELD_STRING_MACRO(offending_element
 
registry::OffendingElement ODIL_MESSAGE_OPTIONAL_FIELD_STRING_MACRO (error_comment, registry::ErrorComment) ODIL_MESSAGE_OPTIONAL_FIELD_INTEGER_MACRO(error_id
 
registry::OffendingElement registry::ErrorID ODIL_MESSAGE_OPTIONAL_FIELD_STRING_MACRO (affected_sop_instance_uid, odil::registry::AffectedSOPInstanceUID) ODIL_MESSAGE_OPTIONAL_FIELD_STRING_MACRO(attribute_identifier_list
 
registry::OffendingElement registry::ErrorID odil::registry::AttributeIdentifierList bool is_pending () const
 Test whether the status class is pending. More...
 
bool is_warning () const
 Test whether the status class is warning. More...
 
bool is_failure () const
 Test whether the status class is failure. More...
 
void set_status_fields (DataSet const &status_fields)
 Set the status fields (cf. PS.37, C) More...
 
- Public Member Functions inherited from odil::message::Message
 Message ()
 Create a message with an empty command set and an empty data set. More...
 
 Message (DataSet const &command_set)
 Create a message from existing data. More...
 
 Message (DataSet &&command_set)
 Create a message from existing data. More...
 
 Message (DataSet const &command_set, DataSet const &data_set)
 Create a message from existing data. More...
 
 Message (DataSet &&command_set, DataSet &&data_set)
 Create a message from existing data. More...
 
virtual ~Message ()
 Destructor;. More...
 
DataSet const & get_command_set () const
 Return the command set of the message. More...
 
bool has_data_set () const
 Test whether as data set is present in the message. More...
 
DataSet const & get_data_set () const
 Return the data set of the message, raise an exception if no data set is present. More...
 
DataSetget_data_set ()
 Return the data set of the message, raise an exception if no data set is present. More...
 
void set_data_set (DataSet const &data_set)
 Set the data set of the message. More...
 
void set_data_set (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

- Static Public Member Functions inherited from odil::message::Response
static bool is_pending (Value::Integer status)
 Test whether the status class is pending. More...
 
static bool is_warning (Value::Integer status)
 Test whether the status class is warning. More...
 
static bool is_failure (Value::Integer status)
 Test whether the status class is failure. More...
 
- Protected Attributes inherited from odil::message::Message
DataSet _command_set
 Command set of the message. More...
 
DataSet _data_set
 Data set of the message. More...
 

Detailed Description

C-FIND-RSP message.

Member Enumeration Documentation

◆ Status

C-FIND status codes, PS 3.4, C.4.1.1.4.

Enumerator
RefusedOutOfResources 
IdentifierDoesNotMatchSOPClass 
UnableToProcess 
PendingWarningOptionalKeysNotSupported 

Constructor & Destructor Documentation

◆ CFindResponse() [1/5]

odil::message::CFindResponse::CFindResponse ( Value::Integer  message_id_being_responded_to,
Value::Integer  status 
)

Create an find response with given Message ID, and status.

◆ CFindResponse() [2/5]

odil::message::CFindResponse::CFindResponse ( Value::Integer  message_id_being_responded_to,
Value::Integer  status,
DataSet const &  dataset 
)

Create an find response with given Message ID, status, and data set.

◆ CFindResponse() [3/5]

odil::message::CFindResponse::CFindResponse ( Value::Integer  message_id_being_responded_to,
Value::Integer  status,
DataSet &&  dataset 
)

Create an find response with given Message ID, status, and data set.

◆ CFindResponse() [4/5]

odil::message::CFindResponse::CFindResponse ( Message const &  message)

Create a C-FIND-RSP from a generic Message.

Raise an exception if the Message does not contain a C-FIND-RSP.

◆ CFindResponse() [5/5]

odil::message::CFindResponse::CFindResponse ( Message &&  message)

Create a C-FIND-RSP from a generic Message.

Raise an exception if the Message does not contain a C-FIND-RSP.

◆ ~CFindResponse()

virtual odil::message::CFindResponse::~CFindResponse ( )
virtual

Destructor.


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