Class to provide access to DRTRecordedBlockSequence. More...

#include <mlDcmDRTRecordedBlockSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTRecordedBlockSequenceInterface ()
	DcmDRTRecordedBlockSequenceInterface (std::vector< DcmDRTRecordedBlockSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTRecordedBlockSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTRecordedBlockSequenceInterface ()
	Default virtual Destructor.
bool	getAccessoryCode (unsigned long idx, std::string &parameter) const
bool	getAccessoryCode (DCMTree::TreePtr item, std::string &parameter) const
std::string	getAccessoryCodeTag () const
bool	setAccessoryCode (unsigned long idx, std::string parameter)
bool	getBlockName (unsigned long idx, std::string &parameter) const
bool	getBlockName (DCMTree::TreePtr item, std::string &parameter) const
std::string	getBlockNameTag () const
bool	setBlockName (unsigned long idx, std::string parameter)
bool	getBlockTrayID (unsigned long idx, std::string &parameter) const
bool	getBlockTrayID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getBlockTrayIDTag () const
bool	setBlockTrayID (unsigned long idx, std::string parameter)
bool	getReferencedBlockNumber (unsigned long idx, std::string &parameter) const
bool	getReferencedBlockNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getReferencedBlockNumberTag () const
bool	setReferencedBlockNumber (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTRecordedBlockSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTRecordedBlockSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTRecordedBlockSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTRecordedBlockSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTRecordedBlockSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

Protected Attributes
std::vector< DcmDRTRecordedBlockSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTRecordedBlockSequence.

Definition at line 43 of file mlDcmDRTRecordedBlockSequenceInterface.h.

Constructor & Destructor Documentation

◆ DcmDRTRecordedBlockSequenceInterface() [1/3]

ml::DcmDRTRecordedBlockSequenceInterface::DcmDRTRecordedBlockSequenceInterface ( )

inline

Definition at line 93 of file mlDcmDRTRecordedBlockSequenceInterface.h.

◆ DcmDRTRecordedBlockSequenceInterface() [2/3]

ml::DcmDRTRecordedBlockSequenceInterface::DcmDRTRecordedBlockSequenceInterface ( std::vector< DcmDRTRecordedBlockSequenceInterface::Item > dcmSequence )

inline

Default Constructor.

Definition at line 96 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ DcmDRTRecordedBlockSequenceInterface() [3/3]

ml::DcmDRTRecordedBlockSequenceInterface::DcmDRTRecordedBlockSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 98 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ ~DcmDRTRecordedBlockSequenceInterface()

virtual ml::DcmDRTRecordedBlockSequenceInterface::~DcmDRTRecordedBlockSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 106 of file mlDcmDRTRecordedBlockSequenceInterface.h.

Member Function Documentation

◆ addItem() [1/2]

DcmDRTRecordedBlockSequenceInterface::Item & ml::DcmDRTRecordedBlockSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns: Return the new item which has been added to the sequence

Definition at line 167 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ addItem() [2/2]

void ml::DcmDRTRecordedBlockSequenceInterface::addItem ( DcmDRTRecordedBlockSequenceInterface::Item newItem )

inline

Definition at line 172 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ getAccessoryCode() [1/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getAccessoryCode	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getAccessoryCode() [2/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getAccessoryCode	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getAccessoryCodeTag()

std::string ml::DcmDRTRecordedBlockSequenceInterface::getAccessoryCodeTag ( ) const

inline

Definition at line 110 of file mlDcmDRTRecordedBlockSequenceInterface.h.

◆ getBlockName() [1/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getBlockName	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getBlockName() [2/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getBlockName	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getBlockNameTag()

std::string ml::DcmDRTRecordedBlockSequenceInterface::getBlockNameTag ( ) const

inline

Definition at line 116 of file mlDcmDRTRecordedBlockSequenceInterface.h.

◆ getBlockTrayID() [1/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getBlockTrayID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getBlockTrayID() [2/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getBlockTrayID	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getBlockTrayIDTag()

std::string ml::DcmDRTRecordedBlockSequenceInterface::getBlockTrayIDTag ( ) const

inline

Definition at line 122 of file mlDcmDRTRecordedBlockSequenceInterface.h.

◆ getItem()

DcmDRTRecordedBlockSequenceInterface::Item ml::DcmDRTRecordedBlockSequenceInterface::getItem ( const size_t idx ) const

inline

Gets the item at the indicated position.

Returns: The requested item, an empty item when the position is invalid

Definition at line 158 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ getNumberOfItems()

MLint ml::DcmDRTRecordedBlockSequenceInterface::getNumberOfItems ( ) const

inline

Return number of items the internal sequence consists of.

Returns: Number of items of internal sequence, 0 if internal sequence is NULL.

Definition at line 152 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ getReferencedBlockNumber() [1/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getReferencedBlockNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

◆ getReferencedBlockNumber() [2/2]

bool ml::DcmDRTRecordedBlockSequenceInterface::getReferencedBlockNumber	(	unsigned long	idx,
		std::string &	parameter ) const

◆ getReferencedBlockNumberTag()

std::string ml::DcmDRTRecordedBlockSequenceInterface::getReferencedBlockNumberTag ( ) const

inline

Definition at line 128 of file mlDcmDRTRecordedBlockSequenceInterface.h.

◆ getSequence()

std::vector< DcmDRTRecordedBlockSequenceInterface::Item > ml::DcmDRTRecordedBlockSequenceInterface::getSequence ( ) const

inline

Return the DRTRecordedBlockSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTRecordedBlockSequence

Definition at line 140 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

Referenced by DRTRecordedBlockSequenceWrapper::DRTRecordedBlockSequenceWrapper(), and DRTRecordedBlockSequenceWrapper::operator=().

◆ hasSequence()

bool ml::DcmDRTRecordedBlockSequenceInterface::hasSequence ( ) const

inline

Check if the DRTRecordedBlockSequence is set.

Returns: True if internal pointer is set, False else.

Definition at line 146 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ insertItem()

bool ml::DcmDRTRecordedBlockSequenceInterface::insertItem ( const size_t idx )

inline

Insert an item at the indicated position

Returns: true is the insertion was successful, false if position is invalid

Definition at line 178 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ removeItem()

bool ml::DcmDRTRecordedBlockSequenceInterface::removeItem ( const size_t idx )

inline

Removes the indicated item from the sequence

Returns: true if the item was deleted successfully, false if the indicated position is invalid

Definition at line 190 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

◆ setAccessoryCode()

bool ml::DcmDRTRecordedBlockSequenceInterface::setAccessoryCode	(	unsigned long	idx,
		std::string	parameter )

◆ setBlockName()

bool ml::DcmDRTRecordedBlockSequenceInterface::setBlockName	(	unsigned long	idx,
		std::string	parameter )

◆ setBlockTrayID()

bool ml::DcmDRTRecordedBlockSequenceInterface::setBlockTrayID	(	unsigned long	idx,
		std::string	parameter )

◆ setReferencedBlockNumber()

bool ml::DcmDRTRecordedBlockSequenceInterface::setReferencedBlockNumber	(	unsigned long	idx,
		std::string	parameter )

◆ setSequence()

void ml::DcmDRTRecordedBlockSequenceInterface::setSequence ( std::vector< DcmDRTRecordedBlockSequenceInterface::Item > dcmSequence )

inline

Set the DRTRecordedBlockSequence this interface class provides access to.

Parameters

dcmSequence Pointer to DRTRecordedBlockSequence

Definition at line 134 of file mlDcmDRTRecordedBlockSequenceInterface.h.

References _itemVec.

Member Data Documentation

◆ _itemVec

std::vector<DcmDRTRecordedBlockSequenceInterface::Item> ml::DcmDRTRecordedBlockSequenceInterface::_itemVec

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 202 of file mlDcmDRTRecordedBlockSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTRecordedBlockSequenceInterface(), DcmDRTRecordedBlockSequenceInterface(), getItem(), getNumberOfItems(), getSequence(), hasSequence(), insertItem(), removeItem(), and setSequence().

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

FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTRecordedBlockSequenceInterface.h

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DcmDRTRecordedBlockSequenceInterface() [1/3]

◆ DcmDRTRecordedBlockSequenceInterface() [2/3]

◆ DcmDRTRecordedBlockSequenceInterface() [3/3]

◆ ~DcmDRTRecordedBlockSequenceInterface()

Member Function Documentation

◆ addItem() [1/2]

◆ addItem() [2/2]

◆ getAccessoryCode() [1/2]

◆ getAccessoryCode() [2/2]

◆ getAccessoryCodeTag()

◆ getBlockName() [1/2]

◆ getBlockName() [2/2]

◆ getBlockNameTag()

◆ getBlockTrayID() [1/2]

◆ getBlockTrayID() [2/2]

◆ getBlockTrayIDTag()

◆ getItem()

◆ getNumberOfItems()

◆ getReferencedBlockNumber() [1/2]

◆ getReferencedBlockNumber() [2/2]

◆ getReferencedBlockNumberTag()

◆ getSequence()

◆ hasSequence()

◆ insertItem()

◆ removeItem()

◆ setAccessoryCode()

◆ setBlockName()

◆ setBlockTrayID()

◆ setReferencedBlockNumber()

◆ setSequence()

Member Data Documentation

◆ _itemVec