ml::DcmDRTPatientBreedCodeSequenceInterface Class Reference

Class to provide access to DRTPatientBreedCodeSequence. More...

#include <mlDcmDRTPatientBreedCodeSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTPatientBreedCodeSequenceInterface ()
	DcmDRTPatientBreedCodeSequenceInterface (std::vector< DcmDRTPatientBreedCodeSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTPatientBreedCodeSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTPatientBreedCodeSequenceInterface ()
	Default virtual Destructor.
bool	getCodeMeaning (unsigned long idx, std::string &parameter) const
bool	getCodeMeaning (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodeMeaningTag () const
bool	setCodeMeaning (unsigned long idx, std::string parameter)
bool	getCodeValue (unsigned long idx, std::string &parameter) const
bool	getCodeValue (DCMTree::TreePtr item, std::string &parameter) const
std::string	getCodeValueTag () const
bool	setCodeValue (unsigned long idx, std::string parameter)
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	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)
bool	getContextGroupExtensionCreatorUID (unsigned long idx, std::string &parameter) const
bool	getContextGroupExtensionCreatorUID (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContextGroupExtensionCreatorUIDTag () const
bool	setContextGroupExtensionCreatorUID (unsigned long idx, std::string parameter)
bool	getContextGroupExtensionFlag (unsigned long idx, std::string &parameter) const
bool	getContextGroupExtensionFlag (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContextGroupExtensionFlagTag () const
bool	setContextGroupExtensionFlag (unsigned long idx, std::string parameter)
bool	getContextGroupLocalVersion (unsigned long idx, std::string &parameter) const
bool	getContextGroupLocalVersion (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContextGroupLocalVersionTag () const
bool	setContextGroupLocalVersion (unsigned long idx, std::string parameter)
bool	getContextGroupVersion (unsigned long idx, std::string &parameter) const
bool	getContextGroupVersion (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContextGroupVersionTag () const
bool	setContextGroupVersion (unsigned long idx, std::string parameter)
bool	getContextIdentifier (unsigned long idx, std::string &parameter) const
bool	getContextIdentifier (DCMTree::TreePtr item, std::string &parameter) const
std::string	getContextIdentifierTag () const
bool	setContextIdentifier (unsigned long idx, std::string parameter)
bool	getMappingResource (unsigned long idx, std::string &parameter) const
bool	getMappingResource (DCMTree::TreePtr item, std::string &parameter) const
std::string	getMappingResourceTag () const
bool	setMappingResource (unsigned long idx, std::string parameter)
void	setSequence (std::vector< DcmDRTPatientBreedCodeSequenceInterface::Item > dcmSequence)
	Set the DRTPatientBreedCodeSequence this interface class provides access to.
std::vector< DcmDRTPatientBreedCodeSequenceInterface::Item >	getSequence () const
	Return the DRTPatientBreedCodeSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTPatientBreedCodeSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTPatientBreedCodeSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTPatientBreedCodeSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTPatientBreedCodeSequenceInterface::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< DcmDRTPatientBreedCodeSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTPatientBreedCodeSequence.

Definition at line 43 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTPatientBreedCodeSequenceInterface() [1/3]

ml::DcmDRTPatientBreedCodeSequenceInterface::DcmDRTPatientBreedCodeSequenceInterface ( )

inline

Definition at line 123 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

DcmDRTPatientBreedCodeSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 126 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

DcmDRTPatientBreedCodeSequenceInterface() [3/3]

ml::DcmDRTPatientBreedCodeSequenceInterface::DcmDRTPatientBreedCodeSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 128 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

References mlrange_cast().

~DcmDRTPatientBreedCodeSequenceInterface()

virtual ml::DcmDRTPatientBreedCodeSequenceInterface::~DcmDRTPatientBreedCodeSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 136 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTPatientBreedCodeSequenceInterface::Item & ml::DcmDRTPatientBreedCodeSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 233 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 238 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

References mlrange_cast().

getCodeMeaning() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getCodeMeaning	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodeMeaning() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getCodeMeaning	(	unsigned long	idx,
		std::string &	parameter ) const

getCodeMeaningTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getCodeMeaningTag ( ) const

inline

Definition at line 140 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getCodeMeaningTag().

getCodeValue() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getCodeValue	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getCodeValue() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getCodeValue	(	unsigned long	idx,
		std::string &	parameter ) const

getCodeValueTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getCodeValueTag ( ) const

inline

Definition at line 146 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getCodeValueTag().

getCodingSchemeDesignator() [1/2]

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

getCodingSchemeDesignator() [2/2]

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

getCodingSchemeDesignatorTag()

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

inline

Definition at line 152 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getCodingSchemeDesignatorTag().

getCodingSchemeVersion() [1/2]

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

getCodingSchemeVersion() [2/2]

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

getCodingSchemeVersionTag()

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

inline

Definition at line 158 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getCodingSchemeVersionTag().

getContextGroupExtensionCreatorUID() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupExtensionCreatorUID	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getContextGroupExtensionCreatorUID() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupExtensionCreatorUID	(	unsigned long	idx,
		std::string &	parameter ) const

getContextGroupExtensionCreatorUIDTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupExtensionCreatorUIDTag ( ) const

inline

Definition at line 164 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getContextGroupExtensionCreatorUIDTag().

getContextGroupExtensionFlag() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupExtensionFlag	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getContextGroupExtensionFlag() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupExtensionFlag	(	unsigned long	idx,
		std::string &	parameter ) const

getContextGroupExtensionFlagTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupExtensionFlagTag ( ) const

inline

Definition at line 170 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getContextGroupExtensionFlagTag().

getContextGroupLocalVersion() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupLocalVersion	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getContextGroupLocalVersion() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupLocalVersion	(	unsigned long	idx,
		std::string &	parameter ) const

getContextGroupLocalVersionTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupLocalVersionTag ( ) const

inline

Definition at line 176 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getContextGroupLocalVersionTag().

getContextGroupVersion() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupVersion	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getContextGroupVersion() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupVersion	(	unsigned long	idx,
		std::string &	parameter ) const

getContextGroupVersionTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getContextGroupVersionTag ( ) const

inline

Definition at line 182 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getContextGroupVersionTag().

getContextIdentifier() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextIdentifier	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getContextIdentifier() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getContextIdentifier	(	unsigned long	idx,
		std::string &	parameter ) const

getContextIdentifierTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getContextIdentifierTag ( ) const

inline

Definition at line 188 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getContextIdentifierTag().

getItem()

DcmDRTPatientBreedCodeSequenceInterface::Item ml::DcmDRTPatientBreedCodeSequenceInterface::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 224 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

References mlrange_cast().

getMappingResource() [1/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getMappingResource	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getMappingResource() [2/2]

bool ml::DcmDRTPatientBreedCodeSequenceInterface::getMappingResource	(	unsigned long	idx,
		std::string &	parameter ) const

getMappingResourceTag()

std::string ml::DcmDRTPatientBreedCodeSequenceInterface::getMappingResourceTag ( ) const

inline

Definition at line 194 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

Referenced by DRTPatientBreedCodeSequenceWrapper::getMappingResourceTag().

getNumberOfItems()

MLint ml::DcmDRTPatientBreedCodeSequenceInterface::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 218 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

getSequence()

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

inline

Return the DRTPatientBreedCodeSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTPatientBreedCodeSequence

Definition at line 206 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

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

hasSequence()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::hasSequence ( ) const

inline

Check if the DRTPatientBreedCodeSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 212 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

insertItem()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::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 244 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::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 256 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

References mlrange_cast().

setCodeMeaning()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setCodeMeaning	(	unsigned long	idx,
		std::string	parameter )

setCodeValue()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setCodeValue	(	unsigned long	idx,
		std::string	parameter )

setCodingSchemeDesignator()

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

setCodingSchemeVersion()

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

setContextGroupExtensionCreatorUID()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setContextGroupExtensionCreatorUID	(	unsigned long	idx,
		std::string	parameter )

setContextGroupExtensionFlag()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setContextGroupExtensionFlag	(	unsigned long	idx,
		std::string	parameter )

setContextGroupLocalVersion()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setContextGroupLocalVersion	(	unsigned long	idx,
		std::string	parameter )

setContextGroupVersion()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setContextGroupVersion	(	unsigned long	idx,
		std::string	parameter )

setContextIdentifier()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setContextIdentifier	(	unsigned long	idx,
		std::string	parameter )

setMappingResource()

bool ml::DcmDRTPatientBreedCodeSequenceInterface::setMappingResource	(	unsigned long	idx,
		std::string	parameter )

setSequence()

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

inline

Set the DRTPatientBreedCodeSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTPatientBreedCodeSequence

Definition at line 200 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

References mlrange_cast().

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

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 268 of file mlDcmDRTPatientBreedCodeSequenceInterface.h.

---

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

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