odil
Public Types | Public Member Functions | List of all members
odil::Value Class Reference

A value held in a DICOM element. More...

#include <Value.h>

Public Types

enum  Type {
  Empty, Integers, Reals, Strings,
  DataSets, Binary
}
 Possible types stored in the value.
 
typedef int64_t Integer
 
typedef double Real
 
typedef std::string String
 
typedef std::vector< Integer > Integers
 Integer container.
 
typedef std::vector< Real > Reals
 Real container.
 
typedef std::vector< String > Strings
 String container.
 
typedef std::vector< DataSetDataSets
 Data sets container.
 
typedef std::vector< uint8_t > Binary
 Binary data container.
 

Public Member Functions

 Value ()
 Build an empty value.
 
 Value (Integers const &integers)
 Build a value from integers.
 
 Value (Reals const &reals)
 Build a value from reals.
 
 Value (Strings const &strings)
 Build a value from strings.
 
 Value (DataSets const &datasets)
 Build a value from data sets.
 
 Value (Binary const &binary)
 Build a value from binary data.
 
 Value (std::initializer_list< int > const &list)
 Build a value from integers.
 
 Value (std::initializer_list< Integer > const &list)
 Build a value from integers.
 
 Value (std::initializer_list< Real > const &list)
 Build a value from reals.
 
 Value (std::initializer_list< String > const &list)
 Build a value from strings.
 
 Value (std::initializer_list< DataSet > const &list)
 Build a value from data sets.
 
Type get_type () const
 Return the type store in the value.
 
bool empty () const
 Test whether the value is empty.
 
Integers const & as_integers () const
 Return the integers contained in the value. More...
 
Integersas_integers ()
 Return the integers contained in the value. More...
 
Reals const & as_reals () const
 Return the reals contained in the value. More...
 
Realsas_reals ()
 Return the reals contained in the value. More...
 
Strings const & as_strings () const
 Return the strings contained in the value. More...
 
Stringsas_strings ()
 Return the strings contained in the value. More...
 
DataSets const & as_data_sets () const
 Return the data sets contained in the value. More...
 
DataSetsas_data_sets ()
 Return the data sets contained in the value. More...
 
Binary const & as_binary () const
 Return the binary data contained in the value. More...
 
Binaryas_binary ()
 Return the binary data contained in the value. More...
 
bool operator== (Value const &other) const
 Equality test.
 
bool operator!= (Value const &other) const
 Difference test.
 

Detailed Description

A value held in a DICOM element.

Member Function Documentation

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

Return the binary data contained in the value.

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

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

Return the binary data contained in the value.

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

Value::DataSets const & odil::Value::as_data_sets ( ) const

Return the data sets contained in the value.

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

Value::DataSets & odil::Value::as_data_sets ( )

Return the data sets contained in the value.

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

Value::Integers const & odil::Value::as_integers ( ) const

Return the integers contained in the value.

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

Value::Integers & odil::Value::as_integers ( )

Return the integers contained in the value.

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

Value::Reals const & odil::Value::as_reals ( ) const

Return the reals contained in the value.

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

Value::Reals & odil::Value::as_reals ( )

Return the reals contained in the value.

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

Value::Strings const & odil::Value::as_strings ( ) const

Return the strings contained in the value.

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

Value::Strings & odil::Value::as_strings ( )

Return the strings contained in the value.

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


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