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

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

#include <WADORSRequest.h>

Public Member Functions

 WADORSRequest (URL const &base_url, std::string const &transfer_syntax="", std::string const &character_set="", bool include_media_type_in_query=false, bool include_character_set_in_query=false)
 Constructor. More...
 
 WADORSRequest (HTTPRequest const &request)
 Constructor. More...
 
bool operator== (WADORSRequest const &other) const
 Equality operator. More...
 
bool operator!= (WADORSRequest const &other) const
 Difference operator. More...
 
URL const & get_base_url () const
 Return the base URL. More...
 
void set_base_url (URL const &url)
 Set the base URL; the query and fragment must be empty. More...
 
std::string const & get_transfer_syntax () const
 Return the transfer syntax. More...
 
void set_transfer_syntax (std::string const &transfer_syntax)
 Set the transfer syntax. More...
 
std::string const & get_character_set () const
 Return the transfer syntax. More...
 
void set_character_set (std::string const &character_set)
 Set the transfer syntax. More...
 
bool get_include_media_type_in_query () const
 Return whether to include the media type in the URL query. More...
 
void set_include_media_type_in_query (bool include_media_type_in_query)
 Set whether to include the media type in the URL query. More...
 
bool get_include_character_set_in_query () const
 Return whether to include the character set in the URL query. More...
 
void set_include_character_set_in_query (bool include_charcter_set_in_query)
 Set whether to include the character_set in the URL query. More...
 
Type get_type () const
 Return the query type. More...
 
Selector const & get_selector () const
 Return the selector. More...
 
URL const & get_url () const
 Return the URL. More...
 
std::string const & get_media_type () const
 Return the media type. More...
 
Representation const & get_representation () const
 Return the representation. More...
 
void request_dicom (Representation representation, Selector const &selector)
 Prepare a DICOM request. More...
 
void request_bulk_data (Selector const &selector)
 Prepare a bulk data request. More...
 
void request_bulk_data (URL const &url)
 Prepare a bulk data request. More...
 
void request_pixel_data (Selector const &selector, std::string const &media_type="application/octet-stream")
 Prepare a pixel data request. More...
 
HTTPRequest get_http_request () const
 Generate the associated HTTP request. More...
 

Detailed Description

WADO-RS request generator and parser.

Constructor & Destructor Documentation

◆ WADORSRequest() [1/2]

odil::webservices::WADORSRequest::WADORSRequest ( URL const &  base_url,
std::string const &  transfer_syntax = "",
std::string const &  character_set = "",
bool  include_media_type_in_query = false,
bool  include_character_set_in_query = false 
)

Constructor.

◆ WADORSRequest() [2/2]

odil::webservices::WADORSRequest::WADORSRequest ( HTTPRequest const &  request)

Constructor.

Member Function Documentation

◆ get_base_url()

URL const& odil::webservices::WADORSRequest::get_base_url ( ) const

Return the base URL.

◆ get_character_set()

std::string const& odil::webservices::WADORSRequest::get_character_set ( ) const

Return the transfer syntax.

◆ get_http_request()

HTTPRequest odil::webservices::WADORSRequest::get_http_request ( ) const

Generate the associated HTTP request.

◆ get_include_character_set_in_query()

bool odil::webservices::WADORSRequest::get_include_character_set_in_query ( ) const

Return whether to include the character set in the URL query.

◆ get_include_media_type_in_query()

bool odil::webservices::WADORSRequest::get_include_media_type_in_query ( ) const

Return whether to include the media type in the URL query.

◆ get_media_type()

std::string const& odil::webservices::WADORSRequest::get_media_type ( ) const

Return the media type.

◆ get_representation()

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

Return the representation.

◆ get_selector()

Selector const& odil::webservices::WADORSRequest::get_selector ( ) const

Return the selector.

◆ get_transfer_syntax()

std::string const& odil::webservices::WADORSRequest::get_transfer_syntax ( ) const

Return the transfer syntax.

◆ get_type()

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

Return the query type.

◆ get_url()

URL const& odil::webservices::WADORSRequest::get_url ( ) const

Return the URL.

◆ operator!=()

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

Difference operator.

◆ operator==()

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

Equality operator.

◆ request_bulk_data() [1/2]

void odil::webservices::WADORSRequest::request_bulk_data ( Selector const &  selector)

Prepare a bulk data request.

◆ request_bulk_data() [2/2]

void odil::webservices::WADORSRequest::request_bulk_data ( URL const &  url)

Prepare a bulk data request.

◆ request_dicom()

void odil::webservices::WADORSRequest::request_dicom ( Representation  representation,
Selector const &  selector 
)

Prepare a DICOM request.

◆ request_pixel_data()

void odil::webservices::WADORSRequest::request_pixel_data ( Selector const &  selector,
std::string const &  media_type = "application/octet-stream" 
)

Prepare a pixel data request.

◆ set_base_url()

void odil::webservices::WADORSRequest::set_base_url ( URL const &  url)

Set the base URL; the query and fragment must be empty.

◆ set_character_set()

void odil::webservices::WADORSRequest::set_character_set ( std::string const &  character_set)

Set the transfer syntax.

◆ set_include_character_set_in_query()

void odil::webservices::WADORSRequest::set_include_character_set_in_query ( bool  include_charcter_set_in_query)

Set whether to include the character_set in the URL query.

◆ set_include_media_type_in_query()

void odil::webservices::WADORSRequest::set_include_media_type_in_query ( bool  include_media_type_in_query)

Set whether to include the media type in the URL query.

◆ set_transfer_syntax()

void odil::webservices::WADORSRequest::set_transfer_syntax ( std::string const &  transfer_syntax)

Set the transfer syntax.


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