Represents a DICOM Code Sequence with optional modifiers. More...

#include <mitkDICOMCodeSequenceWithModifiers.h>

Inheritance diagram for mitk::DICOMCodeSequenceWithModifiers:

Collaboration diagram for mitk::DICOMCodeSequenceWithModifiers:

[legend]

Public Types
using	ModifierVector = std::vector< DICOMCodeSequence >

Public Member Functions
	DICOMCodeSequenceWithModifiers ()=default

	DICOMCodeSequenceWithModifiers (const std::string &value, const std::string &scheme, const std::string &meaning)
	Constructs a DICOMCodeSequenceWithModifiers with the specified attributes. More...

	DICOMCodeSequenceWithModifiers (const DICOMCodeSequence &code)
	Constructs from a DICOMCodeSequence. More...

DICOMCodeSequenceWithModifiers &	operator= (const DICOMCodeSequence &code)

	~DICOMCodeSequenceWithModifiers () override=default

	DICOMCodeSequenceWithModifiers (const DICOMCodeSequenceWithModifiers &)=default

DICOMCodeSequenceWithModifiers &	operator= (const DICOMCodeSequenceWithModifiers &)=default

	DICOMCodeSequenceWithModifiers (DICOMCodeSequenceWithModifiers &&)=default

DICOMCodeSequenceWithModifiers &	operator= (DICOMCodeSequenceWithModifiers &&)=default

void	AddModifier (const DICOMCodeSequence &modifier)
	Adds a modifier code. More...

const ModifierVector &	GetModifiers () const
	Gets all modifier codes. More...

const DICOMCodeSequence &	GetModifier (std::size_t index) const
	Gets a modifier code at the specified index. More...

DICOMCodeSequence &	GetModifier (std::size_t index)
	Gets a modifier code at the specified index. More...

void	SetModifier (std::size_t index, const DICOMCodeSequence &modifier)
	Sets a modifier code at the specified index. More...

void	SetModifiers (const ModifierVector &modifiers)
	Sets all modifier codes. More...

void	ClearModifiers ()
	Clears all modifier codes. More...

std::size_t	GetModifierCount () const
	Gets the number of modifiers. More...

bool	HasModifiers () const
	Checks if there are any modifiers. More...

bool	operator== (const DICOMCodeSequenceWithModifiers &other) const
	Equality comparison operator. More...

bool	operator!= (const DICOMCodeSequenceWithModifiers &other) const
	Inequality comparison operator. More...

Public Member Functions inherited from mitk::DICOMCodeSequence
	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...

Additional Inherited Members
Protected Attributes inherited from mitk::DICOMCodeSequence
std::string	m_Value

std::string	m_Scheme

std::string	m_Meaning

Detailed Description

Represents a DICOM Code Sequence with optional modifiers.

This class extends DICOMCodeSequence to include a sequence of modifier codes, similar to DCMTK's CodeWithModifiers class. It provides a simplified interface for storing a primary code along with its modifying codes.

Definition at line 32 of file mitkDICOMCodeSequenceWithModifiers.h.

Member Typedef Documentation

◆ ModifierVector

using mitk::DICOMCodeSequenceWithModifiers::ModifierVector = std::vector<DICOMCodeSequence>

Definition at line 35 of file mitkDICOMCodeSequenceWithModifiers.h.

Constructor & Destructor Documentation

◆ DICOMCodeSequenceWithModifiers() [1/5]

mitk::DICOMCodeSequenceWithModifiers::DICOMCodeSequenceWithModifiers ( )

default

◆ DICOMCodeSequenceWithModifiers() [2/5]

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

Constructs a DICOMCodeSequenceWithModifiers 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)

◆ DICOMCodeSequenceWithModifiers() [3/5]

mitk::DICOMCodeSequenceWithModifiers::DICOMCodeSequenceWithModifiers ( const DICOMCodeSequence & code )

explicit

Constructs from a DICOMCodeSequence.

Parameters

code	The base DICOMCodeSequence

◆ ~DICOMCodeSequenceWithModifiers()

mitk::DICOMCodeSequenceWithModifiers::~DICOMCodeSequenceWithModifiers ( )

overridedefault

◆ DICOMCodeSequenceWithModifiers() [4/5]

mitk::DICOMCodeSequenceWithModifiers::DICOMCodeSequenceWithModifiers ( const DICOMCodeSequenceWithModifiers & )

default

◆ DICOMCodeSequenceWithModifiers() [5/5]

mitk::DICOMCodeSequenceWithModifiers::DICOMCodeSequenceWithModifiers ( DICOMCodeSequenceWithModifiers && )

default

Member Function Documentation

◆ AddModifier()

void mitk::DICOMCodeSequenceWithModifiers::AddModifier ( const DICOMCodeSequence & modifier )

Adds a modifier code.

Parameters

modifier The modifier code to add

◆ ClearModifiers()

void mitk::DICOMCodeSequenceWithModifiers::ClearModifiers ( )

Clears all modifier codes.

◆ GetModifier() [1/2]

DICOMCodeSequence& mitk::DICOMCodeSequenceWithModifiers::GetModifier ( std::size_t index )

Gets a modifier code at the specified index.

Parameters

index The index of the modifier to retrieve

Returns: Reference to the modifier at the given index

Precondition: index must be valid

◆ GetModifier() [2/2]

const DICOMCodeSequence& mitk::DICOMCodeSequenceWithModifiers::GetModifier ( std::size_t index ) const

Gets a modifier code at the specified index.

Parameters

index The index of the modifier to retrieve

Returns: Const reference to the modifier at the given index

Precondition: index must be valid

◆ GetModifierCount()

std::size_t mitk::DICOMCodeSequenceWithModifiers::GetModifierCount ( ) const

Gets the number of modifiers.

Returns: The count of modifier codes

◆ GetModifiers()

const ModifierVector& mitk::DICOMCodeSequenceWithModifiers::GetModifiers ( ) const

Gets all modifier codes.

Returns: Const reference to the vector of modifiers

◆ HasModifiers()

bool mitk::DICOMCodeSequenceWithModifiers::HasModifiers ( ) const

Checks if there are any modifiers.

Returns: true if at least one modifier exists, false otherwise

◆ operator!=()

bool mitk::DICOMCodeSequenceWithModifiers::operator!= ( const DICOMCodeSequenceWithModifiers & other ) const

Inequality comparison operator.

Parameters

other The DICOMCodeSequenceWithModifiers to compare with

Returns: true if base code or modifiers differ

◆ operator=() [1/3]

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

◆ operator=() [2/3]

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

default

◆ operator=() [3/3]

DICOMCodeSequenceWithModifiers& mitk::DICOMCodeSequenceWithModifiers::operator= ( DICOMCodeSequenceWithModifiers && )

default

◆ operator==()

bool mitk::DICOMCodeSequenceWithModifiers::operator== ( const DICOMCodeSequenceWithModifiers & other ) const

Equality comparison operator.

Parameters

other The DICOMCodeSequenceWithModifiers to compare with

Returns: true if base code and all modifiers are equal

◆ SetModifier()

void mitk::DICOMCodeSequenceWithModifiers::SetModifier	(	std::size_t	index,
		const DICOMCodeSequence &	modifier
	)

Sets a modifier code at the specified index.

Parameters

index	The index where to set the modifier
modifier	The modifier code to set

Precondition: index must be valid

◆ SetModifiers()

void mitk::DICOMCodeSequenceWithModifiers::SetModifiers ( const ModifierVector & modifiers )

Sets all modifier codes.

Parameters

modifiers The vector of modifiers to set

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

mitkDICOMCodeSequenceWithModifiers.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ModifierVector

Constructor & Destructor Documentation

◆ DICOMCodeSequenceWithModifiers() [1/5]

◆ DICOMCodeSequenceWithModifiers() [2/5]

◆ DICOMCodeSequenceWithModifiers() [3/5]

◆ ~DICOMCodeSequenceWithModifiers()

◆ DICOMCodeSequenceWithModifiers() [4/5]

◆ DICOMCodeSequenceWithModifiers() [5/5]

Member Function Documentation

◆ AddModifier()

◆ ClearModifiers()

◆ GetModifier() [1/2]

◆ GetModifier() [2/2]

◆ GetModifierCount()

◆ GetModifiers()

◆ HasModifiers()

◆ operator!=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ SetModifier()

◆ SetModifiers()