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

Base class for all DIMSE messages. More...

#include <Message.h>

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

Classes

struct  Command
 
struct  DataSetType
 
struct  Priority
 

Public Member Functions

 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...
 

Protected Attributes

DataSet _command_set
 Command set of the message. More...
 
DataSet _data_set
 Data set of the message. More...
 

Detailed Description

Base class for all DIMSE messages.

Constructor & Destructor Documentation

◆ Message() [1/5]

odil::message::Message::Message ( )

Create a message with an empty command set and an empty data set.

◆ Message() [2/5]

odil::message::Message::Message ( DataSet const &  command_set)

Create a message from existing data.

◆ Message() [3/5]

odil::message::Message::Message ( DataSet &&  command_set)

Create a message from existing data.

◆ Message() [4/5]

odil::message::Message::Message ( DataSet const &  command_set,
DataSet const &  data_set 
)

Create a message from existing data.

◆ Message() [5/5]

odil::message::Message::Message ( DataSet &&  command_set,
DataSet &&  data_set 
)

Create a message from existing data.

◆ ~Message()

virtual odil::message::Message::~Message ( )
virtual

Destructor;.

Member Function Documentation

◆ delete_data_set()

void odil::message::Message::delete_data_set ( )

Delete the data set in this message.

◆ get_command_field()

Value::Integer const& odil::message::Message::get_command_field ( ) const
inline

Return the registry::CommandField element of the command set.

◆ get_command_set()

DataSet const& odil::message::Message::get_command_set ( ) const

Return the command set of the message.

◆ get_data_set() [1/2]

DataSet const& odil::message::Message::get_data_set ( ) const

Return the data set of the message, raise an exception if no data set is present.

◆ get_data_set() [2/2]

DataSet& odil::message::Message::get_data_set ( )

Return the data set of the message, raise an exception if no data set is present.

◆ has_data_set()

bool odil::message::Message::has_data_set ( ) const

Test whether as data set is present in the message.

◆ set_command_field()

void odil::message::Message::set_command_field ( Value::Integer const &  value)
inline

Set the registry::CommandField element of the command set.

◆ set_data_set() [1/2]

void odil::message::Message::set_data_set ( DataSet const &  data_set)

Set the data set of the message.

◆ set_data_set() [2/2]

void odil::message::Message::set_data_set ( DataSet &&  data_set)

Set the data set of the message.

Member Data Documentation

◆ _command_set

DataSet odil::message::Message::_command_set
protected

Command set of the message.

◆ _data_set

DataSet odil::message::Message::_data_set
protected

Data set of the message.


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