odil
C++11libraryfortheDICOMstandard
Public Member Functions | Public Attributes | List of all members
odil::Element Class Reference

Element of a DICOM data set. More...

#include <Element.h>

Public Member Functions

 Element (VR const &vr)
 Constructor using the VR to create an according empty container.
 
 Element (Value const &value, VR const &vr)
 Constructor.
 
 Element (Value &&value, VR const &vr)
 Constructor.
 
 Element (Value::Integers const &value, VR const &vr=VR::INVALID)
 
 Element (Value::Integers &&value, VR const &vr=VR::INVALID)
 
 Element (std::initializer_list< Value::Integers ::value_type > const &value, VR const &vr=VR::INVALID)
 
 Element (Value::Reals const &value, VR const &vr=VR::INVALID)
 
 Element (Value::Reals &&value, VR const &vr=VR::INVALID)
 
 Element (std::initializer_list< Value::Reals ::value_type > const &value, VR const &vr=VR::INVALID)
 
 Element (Value::Strings const &value, VR const &vr=VR::INVALID)
 
 Element (Value::Strings &&value, VR const &vr=VR::INVALID)
 
 Element (std::initializer_list< Value::Strings ::value_type > const &value, VR const &vr=VR::INVALID)
 
 Element (Value::DataSets const &value, VR const &vr=VR::INVALID)
 
 Element (Value::DataSets &&value, VR const &vr=VR::INVALID)
 
 Element (std::initializer_list< Value::DataSets ::value_type > const &value, VR const &vr=VR::INVALID)
 
 Element (Value::Binary const &value, VR const &vr=VR::INVALID)
 
 Element (Value::Binary &&value, VR const &vr=VR::INVALID)
 
 Element (std::initializer_list< Value::Binary ::value_type > const &value, VR const &vr=VR::INVALID)
 
 Element (std::initializer_list< int > const &value, VR const &vr=VR::INVALID)
 
 Element (std::initializer_list< std::initializer_list< uint8_t >> const &value, VR const &vr=VR::INVALID)
 
 Element (Element const &)=default
 
 Element (Element &&)=default
 
Elementoperator= (Element const &)=default
 
Elementoperator= (Element &&)=default
 
bool empty () const
 Test whether the element is empty.
 
std::size_t size () const
 Return the number of items in the value.
 
Value const & get_value () const
 Return the raw value.
 
bool is_int () const
 Test whether the value contains integers.
 
Value::Integers const & as_int () const
 Return the integers contained in the element. More...
 
Value::Integersas_int ()
 Return the integers contained in the element. More...
 
bool is_real () const
 Test whether the value contains reals.
 
Value::Reals const & as_real () const
 Return the reals contained in the element. More...
 
Value::Realsas_real ()
 Return the reals contained in the element. More...
 
bool is_string () const
 Test whether the value contains strings.
 
Value::Strings const & as_string () const
 Return the strings contained in the element. More...
 
Value::Stringsas_string ()
 Return the strings contained in the element. More...
 
bool is_data_set () const
 Test whether the value contains data sets.
 
Value::DataSets const & as_data_set () const
 Return the data sets contained in the element. More...
 
Value::DataSetsas_data_set ()
 Return the data sets contained in the element. More...
 
bool is_binary () const
 Test whether the value contains data sets.
 
Value::Binary const & as_binary () const
 Return the binary data contained in the element. More...
 
Value::Binaryas_binary ()
 Return the binary data contained in the element. More...
 
bool operator== (Element const &other) const
 Equality test.
 
bool operator!= (Element const &other) const
 Difference test.
 
void clear ()
 Clear the element (element.empty() will be true).
 

Public Attributes

VR vr
 VR of the element.
 

Detailed Description

Element of a DICOM data set.

Member Function Documentation

◆ as_binary() [1/2]

Value::Binary const & odil::Element::as_binary ( ) const

Return the binary data contained in the element.

If the element does not contain binary data, a odil::Exception is raised.

◆ as_binary() [2/2]

Value::Binary & odil::Element::as_binary ( )

Return the binary data contained in the element.

If the element does not contain binary data, a odil::Exception is raised.

◆ as_data_set() [1/2]

Value::DataSets const & odil::Element::as_data_set ( ) const

Return the data sets contained in the element.

If the element does not contain data sets, a odil::Exception is raised.

◆ as_data_set() [2/2]

Value::DataSets & odil::Element::as_data_set ( )

Return the data sets contained in the element.

If the element does not contain data sets, a odil::Exception is raised.

◆ as_int() [1/2]

Value::Integers const & odil::Element::as_int ( ) const

Return the integers contained in the element.

If the element does not contain integers, a odil::Exception is raised.

◆ as_int() [2/2]

Value::Integers & odil::Element::as_int ( )

Return the integers contained in the element.

If the element does not contain integers, a odil::Exception is raised.

◆ as_real() [1/2]

Value::Reals const & odil::Element::as_real ( ) const

Return the reals contained in the element.

If the element does not contain reals, a odil::Exception is raised.

◆ as_real() [2/2]

Value::Reals & odil::Element::as_real ( )

Return the reals contained in the element.

If the element does not contain reals, a odil::Exception is raised.

◆ as_string() [1/2]

Value::Strings const & odil::Element::as_string ( ) const

Return the strings contained in the element.

If the element does not contain strings, a odil::Exception is raised.

◆ as_string() [2/2]

Value::Strings & odil::Element::as_string ( )

Return the strings contained in the element.

If the element does not contain strings, a odil::Exception is raised.


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