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

WADO-RS response generator and parser. More...

#include <WADORSResponse.h>

Public Member Functions

 WADORSResponse ()
 Constructor. More...
 
 WADORSResponse (HTTPResponse const &response)
 Parse an HTTPResponse as a WADORSResponse. More...
 
 WADORSResponse (WADORSResponse const &)=default
 
 WADORSResponse (WADORSResponse &&)=default
 
 ~WADORSResponse ()=default
 
WADORSResponseoperator= (WADORSResponse &&)=default
 
bool operator== (WADORSResponse const &other) const
 Equality operator. More...
 
bool operator!= (WADORSResponse const &other) const
 Difference operator. More...
 
const Value::DataSetsget_data_sets () const
 Get the response items. More...
 
Value::DataSetsget_data_sets ()
 Modify the response items. More...
 
void set_data_sets (Value::DataSets const &data_sets)
 Set the response items. More...
 
const std::vector< BulkData > & get_bulk_data () const
 Get the response items. More...
 
std::vector< BulkData > & get_bulk_data ()
 Modify the response items. More...
 
void set_bulk_data (std::vector< BulkData > const &bulk_data)
 Set the response items. More...
 
bool is_partial () const
 Return whether the requested content is partially transferred. More...
 
void set_partial (bool partial)
 Set whether the requested content is partially transferred. More...
 
Type get_type () const
 Return the response type. More...
 
const Representationget_representation () const
 Return the representation. More...
 
void respond_dicom (Representation representation)
 Prepare a DICOM response. More...
 
void respond_bulk_data ()
 Prepare a bulk data response. More...
 
void respond_pixel_data (std::string const &media_type="application/octet-stream")
 Prepare a pixel data response. More...
 
HTTPResponse get_http_response () const
 Generate the associated HTTP response. More...
 

Detailed Description

WADO-RS response generator and parser.

Constructor & Destructor Documentation

◆ WADORSResponse() [1/4]

odil::webservices::WADORSResponse::WADORSResponse ( )

Constructor.

◆ WADORSResponse() [2/4]

odil::webservices::WADORSResponse::WADORSResponse ( HTTPResponse const &  response)

Parse an HTTPResponse as a WADORSResponse.

◆ WADORSResponse() [3/4]

odil::webservices::WADORSResponse::WADORSResponse ( WADORSResponse const &  )
default

◆ WADORSResponse() [4/4]

odil::webservices::WADORSResponse::WADORSResponse ( WADORSResponse &&  )
default

◆ ~WADORSResponse()

odil::webservices::WADORSResponse::~WADORSResponse ( )
default

Member Function Documentation

◆ get_bulk_data() [1/2]

std::vector<BulkData>& odil::webservices::WADORSResponse::get_bulk_data ( )

Modify the response items.

◆ get_bulk_data() [2/2]

const std::vector<BulkData>& odil::webservices::WADORSResponse::get_bulk_data ( ) const

Get the response items.

◆ get_data_sets() [1/2]

Value::DataSets& odil::webservices::WADORSResponse::get_data_sets ( )

Modify the response items.

◆ get_data_sets() [2/2]

const Value::DataSets& odil::webservices::WADORSResponse::get_data_sets ( ) const

Get the response items.

◆ get_http_response()

HTTPResponse odil::webservices::WADORSResponse::get_http_response ( ) const

Generate the associated HTTP response.

◆ get_representation()

const Representation& odil::webservices::WADORSResponse::get_representation ( ) const

Return the representation.

◆ get_type()

Type odil::webservices::WADORSResponse::get_type ( ) const

Return the response type.

◆ is_partial()

bool odil::webservices::WADORSResponse::is_partial ( ) const

Return whether the requested content is partially transferred.

◆ operator!=()

bool odil::webservices::WADORSResponse::operator!= ( WADORSResponse const &  other) const

Difference operator.

◆ operator=()

WADORSResponse& odil::webservices::WADORSResponse::operator= ( WADORSResponse &&  )
default

◆ operator==()

bool odil::webservices::WADORSResponse::operator== ( WADORSResponse const &  other) const

Equality operator.

◆ respond_bulk_data()

void odil::webservices::WADORSResponse::respond_bulk_data ( )

Prepare a bulk data response.

◆ respond_dicom()

void odil::webservices::WADORSResponse::respond_dicom ( Representation  representation)

Prepare a DICOM response.

With a DICOM representation, the transfer_syntax of each data set will be used.

◆ respond_pixel_data()

void odil::webservices::WADORSResponse::respond_pixel_data ( std::string const &  media_type = "application/octet-stream")

Prepare a pixel data response.

◆ set_bulk_data()

void odil::webservices::WADORSResponse::set_bulk_data ( std::vector< BulkData > const &  bulk_data)

Set the response items.

◆ set_data_sets()

void odil::webservices::WADORSResponse::set_data_sets ( Value::DataSets const &  data_sets)

Set the response items.

◆ set_partial()

void odil::webservices::WADORSResponse::set_partial ( bool  partial)

Set whether the requested content is partially transferred.


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