mitk::DICOMCodeSequence Class Reference

Represents a DICOM Code Sequence with value, scheme, and meaning. More...

#include <mitkDICOMCodeSequence.h>

Inheritance diagram for mitk::DICOMCodeSequence:

Collaboration diagram for mitk::DICOMCodeSequence:

Public Member Functions
	DICOMCodeSequence ()=default
	DICOMCodeSequence (const std::string &value, const std::string &scheme, const std::string &meaning)
	Constructs a DICOMCodeSequence with the specified attributes. More...
virtual	~DICOMCodeSequence ()=default
	DICOMCodeSequence (const DICOMCodeSequence &)=default
DICOMCodeSequence &	operator= (const DICOMCodeSequence &)=default
	DICOMCodeSequence (DICOMCodeSequence &&)=default
DICOMCodeSequence &	operator= (DICOMCodeSequence &&)=default
const std::string &	GetValue () const
	Gets the Code Value. More...
void	SetValue (const std::string &value)
	Sets the Code Value. More...
const std::string &	GetScheme () const
	Gets the Coding Scheme Designator. More...
void	SetScheme (const std::string &scheme)
	Sets the Coding Scheme Designator. More...
const std::string &	GetMeaning () const
	Gets the Code Meaning. More...
void	SetMeaning (const std::string &meaning)
	Sets the Code Meaning. More...
bool	IsEmpty () const
	Checks if the code is empty (all fields empty). More...
bool	operator== (const DICOMCodeSequence &other) const
	Equality comparison operator. More...
bool	operator!= (const DICOMCodeSequence &other) const
	Inequality comparison operator. More...

Protected Attributes
std::string	m_Value
std::string	m_Scheme
std::string	m_Meaning

Detailed Description

Represents a DICOM Code Sequence with value, scheme, and meaning.

This class provides a simplified representation of a DICOM Code Sequence, storing only the essential elements: Code Value, Coding Scheme Designator, and Code Meaning. It abstracts the underlying DICOM library implementation. The code value might stem from one of the following DICOM tags:

• Code Value (0008,0100)
• Long Code Value (0008,0119)
• or URN Code Value (0008,0120) Which tag to use/correlate to depends on the content (length, or if an URN prefix exists). This is e.g. handled by DCMTK.

Definition at line 35 of file mitkDICOMCodeSequence.h.

Constructor & Destructor Documentation

DICOMCodeSequence() [1/4]

mitk::DICOMCodeSequence::DICOMCodeSequence ( )

default

DICOMCodeSequence() [2/4]

mitk::DICOMCodeSequence::DICOMCodeSequence	(	const std::string &	value,
		const std::string &	scheme,
		const std::string &	meaning
	)

Constructs a DICOMCodeSequence with the specified attributes.

Parameters

value	The Code Value (0008,0100), Long Code Value (0008,0119), or URN Code Value (0008,0120)
scheme	The Coding Scheme Designator (0008,0102)
meaning	The Code Meaning (0008,0104)

~DICOMCodeSequence()

virtual mitk::DICOMCodeSequence::~DICOMCodeSequence ( )

virtualdefault

DICOMCodeSequence() [3/4]

mitk::DICOMCodeSequence::DICOMCodeSequence ( const DICOMCodeSequence &  )

default

DICOMCodeSequence() [4/4]

mitk::DICOMCodeSequence::DICOMCodeSequence ( DICOMCodeSequence &&  )

default

Member Function Documentation

GetMeaning()

const std::string& mitk::DICOMCodeSequence::GetMeaning

(

)

const

Gets the Code Meaning.

GetScheme()

const std::string& mitk::DICOMCodeSequence::GetScheme

(

)

const

Gets the Coding Scheme Designator.

GetValue()

const std::string& mitk::DICOMCodeSequence::GetValue

(

)

const

Gets the Code Value.

IsEmpty()

bool mitk::DICOMCodeSequence::IsEmpty

(

)

const

Checks if the code is empty (all fields empty).

Returns

true if all fields are empty, false otherwise

operator!=()

bool mitk::DICOMCodeSequence::operator!=

(

const DICOMCodeSequence &

other

)

const

Inequality comparison operator.

Parameters

other

The DICOMCodeSequence to compare with

Returns

true if any field differs

operator=() [1/2]

DICOMCodeSequence& mitk::DICOMCodeSequence::operator= ( const DICOMCodeSequence &  )

default

operator=() [2/2]

DICOMCodeSequence& mitk::DICOMCodeSequence::operator= ( DICOMCodeSequence &&  )

default

operator==()

bool mitk::DICOMCodeSequence::operator==

(

const DICOMCodeSequence &

other

)

const

Equality comparison operator.

Parameters

other

The DICOMCodeSequence to compare with

Returns

true if value, scheme, and meaning are equal

SetMeaning()

void mitk::DICOMCodeSequence::SetMeaning

(

const std::string &

meaning

)

Sets the Code Meaning.

SetScheme()

void mitk::DICOMCodeSequence::SetScheme

(

const std::string &

scheme

)

Sets the Coding Scheme Designator.

SetValue()

void mitk::DICOMCodeSequence::SetValue

(

const std::string &

value

)

Sets the Code Value.

Member Data Documentation

m_Meaning

std::string mitk::DICOMCodeSequence::m_Meaning

protected

Definition at line 108 of file mitkDICOMCodeSequence.h.

m_Scheme

std::string mitk::DICOMCodeSequence::m_Scheme

protected

Definition at line 107 of file mitkDICOMCodeSequence.h.

m_Value

std::string mitk::DICOMCodeSequence::m_Value

protected

Definition at line 106 of file mitkDICOMCodeSequence.h.

---

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

• mitkDICOMCodeSequence.h