ml::DcmDRTCodingSchemeIdentificationSequenceInterface Class Reference

Class to provide access to DRTCodingSchemeIdentificationSequence. More...

#include <mlDcmDRTCodingSchemeIdentificationSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTCodingSchemeIdentificationSequenceInterface ()
	DcmDRTCodingSchemeIdentificationSequenceInterface (std::vector< DcmDRTCodingSchemeIdentificationSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTCodingSchemeIdentificationSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTCodingSchemeIdentificationSequenceInterface ()
	Default virtual Destructor.
bool	getCodingSchemeDesignator (unsigned long idx, std::string &parameter) const
bool	getCodingSchemeDesignator (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodingSchemeDesignatorTag () const
bool	setCodingSchemeDesignator (unsigned long idx, std::string parameter)
bool	getCodingSchemeExternalID (unsigned long idx, std::string &parameter) const
bool	getCodingSchemeExternalID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodingSchemeExternalIDTag () const
bool	setCodingSchemeExternalID (unsigned long idx, std::string parameter)
bool	getCodingSchemeName (unsigned long idx, std::string &parameter) const
bool	getCodingSchemeName (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodingSchemeNameTag () const
bool	setCodingSchemeName (unsigned long idx, std::string parameter)
bool	getCodingSchemeRegistry (unsigned long idx, std::string &parameter) const
bool	getCodingSchemeRegistry (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodingSchemeRegistryTag () const
bool	setCodingSchemeRegistry (unsigned long idx, std::string parameter)
bool	getCodingSchemeResponsibleOrganization (unsigned long idx, std::string &parameter) const
bool	getCodingSchemeResponsibleOrganization (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodingSchemeResponsibleOrganizationTag () const
bool	setCodingSchemeResponsibleOrganization (unsigned long idx, std::string parameter)
bool	getCodingSchemeUID (unsigned long idx, std::string &parameter) const
bool	getCodingSchemeUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodingSchemeUIDTag () const
bool	setCodingSchemeUID (unsigned long idx, std::string parameter)
bool	getCodingSchemeVersion (unsigned long idx, std::string &parameter) const
bool	getCodingSchemeVersion (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodingSchemeVersionTag () const
bool	setCodingSchemeVersion (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTCodingSchemeIdentificationSequenceInterface::Item > dcmSequence)
	Set the DRTCodingSchemeIdentificationSequence this interface class provides access to.
std::vector< DcmDRTCodingSchemeIdentificationSequenceInterface::Item >	getSequence () const
	Return the DRTCodingSchemeIdentificationSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTCodingSchemeIdentificationSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTCodingSchemeIdentificationSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTCodingSchemeIdentificationSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTCodingSchemeIdentificationSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
	Insert an item at the indicated position.
bool	removeItem (const size_t idx)
	Removes the indicated item from the sequence.

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

Detailed Description

Class to provide access to DRTCodingSchemeIdentificationSequence.

Definition at line 43 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTCodingSchemeIdentificationSequenceInterface() [1/3]

ml::DcmDRTCodingSchemeIdentificationSequenceInterface::DcmDRTCodingSchemeIdentificationSequenceInterface ( )

inline

Definition at line 108 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

DcmDRTCodingSchemeIdentificationSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 111 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

DcmDRTCodingSchemeIdentificationSequenceInterface() [3/3]

ml::DcmDRTCodingSchemeIdentificationSequenceInterface::DcmDRTCodingSchemeIdentificationSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 113 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

References mlrange_cast().

~DcmDRTCodingSchemeIdentificationSequenceInterface()

virtual ml::DcmDRTCodingSchemeIdentificationSequenceInterface::~DcmDRTCodingSchemeIdentificationSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 121 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTCodingSchemeIdentificationSequenceInterface::Item & ml::DcmDRTCodingSchemeIdentificationSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 200 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 205 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

References mlrange_cast().

getCodingSchemeDesignator() [1/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeDesignator	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodingSchemeDesignator() [2/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeDesignator	(	unsigned long	idx,
		std::string &	parameter ) const

getCodingSchemeDesignatorTag()

std::string ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeDesignatorTag ( ) const

inline

Definition at line 125 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Referenced by DRTCodingSchemeIdentificationSequenceWrapper::getCodingSchemeDesignatorTag().

getCodingSchemeExternalID() [1/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeExternalID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodingSchemeExternalID() [2/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeExternalID	(	unsigned long	idx,
		std::string &	parameter ) const

getCodingSchemeExternalIDTag()

std::string ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeExternalIDTag ( ) const

inline

Definition at line 131 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Referenced by DRTCodingSchemeIdentificationSequenceWrapper::getCodingSchemeExternalIDTag().

getCodingSchemeName() [1/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeName	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodingSchemeName() [2/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeName	(	unsigned long	idx,
		std::string &	parameter ) const

getCodingSchemeNameTag()

std::string ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeNameTag ( ) const

inline

Definition at line 137 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Referenced by DRTCodingSchemeIdentificationSequenceWrapper::getCodingSchemeNameTag().

getCodingSchemeRegistry() [1/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeRegistry	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodingSchemeRegistry() [2/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeRegistry	(	unsigned long	idx,
		std::string &	parameter ) const

getCodingSchemeRegistryTag()

std::string ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeRegistryTag ( ) const

inline

Definition at line 143 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Referenced by DRTCodingSchemeIdentificationSequenceWrapper::getCodingSchemeRegistryTag().

getCodingSchemeResponsibleOrganization() [1/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeResponsibleOrganization	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodingSchemeResponsibleOrganization() [2/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeResponsibleOrganization	(	unsigned long	idx,
		std::string &	parameter ) const

getCodingSchemeResponsibleOrganizationTag()

std::string ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeResponsibleOrganizationTag ( ) const

inline

Definition at line 149 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Referenced by DRTCodingSchemeIdentificationSequenceWrapper::getCodingSchemeResponsibleOrganizationTag().

getCodingSchemeUID() [1/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodingSchemeUID() [2/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeUID	(	unsigned long	idx,
		std::string &	parameter ) const

getCodingSchemeUIDTag()

std::string ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeUIDTag ( ) const

inline

Definition at line 155 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Referenced by DRTCodingSchemeIdentificationSequenceWrapper::getCodingSchemeUIDTag().

getCodingSchemeVersion() [1/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeVersion	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodingSchemeVersion() [2/2]

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeVersion	(	unsigned long	idx,
		std::string &	parameter ) const

getCodingSchemeVersionTag()

std::string ml::DcmDRTCodingSchemeIdentificationSequenceInterface::getCodingSchemeVersionTag ( ) const

inline

Definition at line 161 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

Referenced by DRTCodingSchemeIdentificationSequenceWrapper::getCodingSchemeVersionTag().

getItem()

DcmDRTCodingSchemeIdentificationSequenceInterface::Item ml::DcmDRTCodingSchemeIdentificationSequenceInterface::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 191 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTCodingSchemeIdentificationSequenceInterface::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 185 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

getSequence()

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

inline

Return the DRTCodingSchemeIdentificationSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTCodingSchemeIdentificationSequence

Definition at line 173 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::hasSequence ( ) const

inline

Check if the DRTCodingSchemeIdentificationSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 179 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

insertItem()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::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 211 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::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 223 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

References mlrange_cast().

setCodingSchemeDesignator()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::setCodingSchemeDesignator	(	unsigned long	idx,
		std::string	parameter )

setCodingSchemeExternalID()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::setCodingSchemeExternalID	(	unsigned long	idx,
		std::string	parameter )

setCodingSchemeName()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::setCodingSchemeName	(	unsigned long	idx,
		std::string	parameter )

setCodingSchemeRegistry()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::setCodingSchemeRegistry	(	unsigned long	idx,
		std::string	parameter )

setCodingSchemeResponsibleOrganization()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::setCodingSchemeResponsibleOrganization	(	unsigned long	idx,
		std::string	parameter )

setCodingSchemeUID()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::setCodingSchemeUID	(	unsigned long	idx,
		std::string	parameter )

setCodingSchemeVersion()

bool ml::DcmDRTCodingSchemeIdentificationSequenceInterface::setCodingSchemeVersion	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTCodingSchemeIdentificationSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTCodingSchemeIdentificationSequence

Definition at line 167 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 235 of file mlDcmDRTCodingSchemeIdentificationSequenceInterface.h.

---

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

• FMEwork/ReleaseMeVis/Sources/Shared/MLDcmtkAccessories/DcmSequenceInterfaces/mlDcmDRTCodingSchemeIdentificationSequenceInterface.h