ml::DcmDRTApplicationSetupSequenceInterface Class Reference

Class to provide access to DRTApplicationSetupSequence. More...

#include <mlDcmDRTApplicationSetupSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTApplicationSetupSequenceInterface ()
	DcmDRTApplicationSetupSequenceInterface (std::vector< DcmDRTApplicationSetupSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTApplicationSetupSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTApplicationSetupSequenceInterface ()
	Default virtual Destructor.
bool	getApplicationSetupManufacturer (unsigned long idx, std::string &parameter) const
bool	getApplicationSetupManufacturer (DCMTree::TreePtr item, std::string &parameter) const
std::string	getApplicationSetupManufacturerTag () const
bool	setApplicationSetupManufacturer (unsigned long idx, std::string parameter)
bool	getApplicationSetupName (unsigned long idx, std::string &parameter) const
bool	getApplicationSetupName (DCMTree::TreePtr item, std::string &parameter) const
std::string	getApplicationSetupNameTag () const
bool	setApplicationSetupName (unsigned long idx, std::string parameter)
bool	getApplicationSetupNumber (unsigned long idx, std::string &parameter) const
bool	getApplicationSetupNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getApplicationSetupNumberTag () const
bool	setApplicationSetupNumber (unsigned long idx, std::string parameter)
bool	getApplicationSetupType (unsigned long idx, std::string &parameter) const
bool	getApplicationSetupType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getApplicationSetupTypeTag () const
bool	setApplicationSetupType (unsigned long idx, std::string parameter)
bool	getTemplateName (unsigned long idx, std::string &parameter) const
bool	getTemplateName (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTemplateNameTag () const
bool	setTemplateName (unsigned long idx, std::string parameter)
bool	getTemplateNumber (unsigned long idx, std::string &parameter) const
bool	getTemplateNumber (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTemplateNumberTag () const
bool	setTemplateNumber (unsigned long idx, std::string parameter)
bool	getTemplateType (unsigned long idx, std::string &parameter) const
bool	getTemplateType (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTemplateTypeTag () const
bool	setTemplateType (unsigned long idx, std::string parameter)
bool	getTotalReferenceAirKerma (unsigned long idx, std::string &parameter) const
bool	getTotalReferenceAirKerma (DCMTree::TreePtr item, std::string &parameter) const
std::string	getTotalReferenceAirKermaTag () const
bool	setTotalReferenceAirKerma (unsigned long idx, std::string parameter)
DcmDRTBrachyAccessoryDeviceSequenceInterface	getBrachyAccessoryDeviceSequence (unsigned long idx) const
std::string	getBrachyAccessoryDeviceSequenceTag () const
void	setBrachyAccessoryDeviceSequence (DcmDRTBrachyAccessoryDeviceSequenceInterface seq, unsigned long idx)
DcmDRTChannelSequenceInterface	getChannelSequence (unsigned long idx) const
std::string	getChannelSequenceTag () const
void	setChannelSequence (DcmDRTChannelSequenceInterface seq, unsigned long idx)
DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface	getReferencedReferenceImageSequence (unsigned long idx) const
std::string	getReferencedReferenceImageSequenceTag () const
void	setReferencedReferenceImageSequence (DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTApplicationSetupSequenceInterface::Item > dcmSequence)
	Set the DRTApplicationSetupSequence this interface class provides access to.
std::vector< DcmDRTApplicationSetupSequenceInterface::Item >	getSequence () const
	Return the DRTApplicationSetupSequence this interface class provides access to.
bool	hasSequence () const
	Check if the DRTApplicationSetupSequence is set.
MLint	getNumberOfItems () const
	Return number of items the internal sequence consists of.
DcmDRTApplicationSetupSequenceInterface::Item	getItem (const size_t idx) const
	Gets the item at the indicated position.
DcmDRTApplicationSetupSequenceInterface::Item &	addItem ()
	Adds a new item to the sequence.
void	addItem (DcmDRTApplicationSetupSequenceInterface::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< DcmDRTApplicationSetupSequenceInterface::Item >	_itemVec
	Reference to the wrapped DICOM tree pointer vector.

Detailed Description

Class to provide access to DRTApplicationSetupSequence.

Definition at line 46 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTApplicationSetupSequenceInterface() [1/3]

ml::DcmDRTApplicationSetupSequenceInterface::DcmDRTApplicationSetupSequenceInterface ( )

inline

Definition at line 131 of file mlDcmDRTApplicationSetupSequenceInterface.h.

DcmDRTApplicationSetupSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 134 of file mlDcmDRTApplicationSetupSequenceInterface.h.

DcmDRTApplicationSetupSequenceInterface() [3/3]

ml::DcmDRTApplicationSetupSequenceInterface::DcmDRTApplicationSetupSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 136 of file mlDcmDRTApplicationSetupSequenceInterface.h.

References mlrange_cast().

~DcmDRTApplicationSetupSequenceInterface()

virtual ml::DcmDRTApplicationSetupSequenceInterface::~DcmDRTApplicationSetupSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 144 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTApplicationSetupSequenceInterface::Item & ml::DcmDRTApplicationSetupSequenceInterface::addItem ( )

inline

Adds a new item to the sequence.

Returns

Return the new item which has been added to the sequence

Definition at line 244 of file mlDcmDRTApplicationSetupSequenceInterface.h.

addItem() [2/2]

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

inline

Definition at line 249 of file mlDcmDRTApplicationSetupSequenceInterface.h.

References mlrange_cast().

getApplicationSetupManufacturer() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupManufacturer	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getApplicationSetupManufacturer() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupManufacturer	(	unsigned long	idx,
		std::string &	parameter ) const

getApplicationSetupManufacturerTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupManufacturerTag ( ) const

inline

Definition at line 148 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getApplicationSetupManufacturerTag().

getApplicationSetupName() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupName	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getApplicationSetupName() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupName	(	unsigned long	idx,
		std::string &	parameter ) const

getApplicationSetupNameTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupNameTag ( ) const

inline

Definition at line 154 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getApplicationSetupNameTag().

getApplicationSetupNumber() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getApplicationSetupNumber() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getApplicationSetupNumberTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupNumberTag ( ) const

inline

Definition at line 160 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getApplicationSetupNumberTag().

getApplicationSetupType() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getApplicationSetupType() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupType	(	unsigned long	idx,
		std::string &	parameter ) const

getApplicationSetupTypeTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getApplicationSetupTypeTag ( ) const

inline

Definition at line 166 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getApplicationSetupTypeTag().

getBrachyAccessoryDeviceSequence()

DcmDRTBrachyAccessoryDeviceSequenceInterface ml::DcmDRTApplicationSetupSequenceInterface::getBrachyAccessoryDeviceSequence

(

unsigned long

idx

)

const

getBrachyAccessoryDeviceSequenceTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getBrachyAccessoryDeviceSequenceTag ( ) const

inline

Definition at line 195 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getBrachyAccessoryDeviceSequenceTag().

getChannelSequence()

DcmDRTChannelSequenceInterface ml::DcmDRTApplicationSetupSequenceInterface::getChannelSequence

(

unsigned long

idx

)

const

getChannelSequenceTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getChannelSequenceTag ( ) const

inline

Definition at line 200 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getChannelSequenceTag().

getItem()

DcmDRTApplicationSetupSequenceInterface::Item ml::DcmDRTApplicationSetupSequenceInterface::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 235 of file mlDcmDRTApplicationSetupSequenceInterface.h.

References mlrange_cast().

getNumberOfItems()

MLint ml::DcmDRTApplicationSetupSequenceInterface::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 229 of file mlDcmDRTApplicationSetupSequenceInterface.h.

getReferencedReferenceImageSequence()

DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface ml::DcmDRTApplicationSetupSequenceInterface::getReferencedReferenceImageSequence

(

unsigned long

idx

)

const

getReferencedReferenceImageSequenceTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getReferencedReferenceImageSequenceTag ( ) const

inline

Definition at line 205 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getReferencedReferenceImageSequenceTag().

getSequence()

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

inline

Return the DRTApplicationSetupSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTApplicationSetupSequence

Definition at line 217 of file mlDcmDRTApplicationSetupSequenceInterface.h.

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

getTemplateName() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTemplateName	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getTemplateName() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTemplateName	(	unsigned long	idx,
		std::string &	parameter ) const

getTemplateNameTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getTemplateNameTag ( ) const

inline

Definition at line 172 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getTemplateNameTag().

getTemplateNumber() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTemplateNumber	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getTemplateNumber() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTemplateNumber	(	unsigned long	idx,
		std::string &	parameter ) const

getTemplateNumberTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getTemplateNumberTag ( ) const

inline

Definition at line 178 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getTemplateNumberTag().

getTemplateType() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTemplateType	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getTemplateType() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTemplateType	(	unsigned long	idx,
		std::string &	parameter ) const

getTemplateTypeTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getTemplateTypeTag ( ) const

inline

Definition at line 184 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getTemplateTypeTag().

getTotalReferenceAirKerma() [1/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTotalReferenceAirKerma	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getTotalReferenceAirKerma() [2/2]

bool ml::DcmDRTApplicationSetupSequenceInterface::getTotalReferenceAirKerma	(	unsigned long	idx,
		std::string &	parameter ) const

getTotalReferenceAirKermaTag()

std::string ml::DcmDRTApplicationSetupSequenceInterface::getTotalReferenceAirKermaTag ( ) const

inline

Definition at line 190 of file mlDcmDRTApplicationSetupSequenceInterface.h.

Referenced by DRTApplicationSetupSequenceWrapper::getTotalReferenceAirKermaTag().

hasSequence()

bool ml::DcmDRTApplicationSetupSequenceInterface::hasSequence ( ) const

inline

Check if the DRTApplicationSetupSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 223 of file mlDcmDRTApplicationSetupSequenceInterface.h.

insertItem()

bool ml::DcmDRTApplicationSetupSequenceInterface::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 255 of file mlDcmDRTApplicationSetupSequenceInterface.h.

References mlrange_cast().

removeItem()

bool ml::DcmDRTApplicationSetupSequenceInterface::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 267 of file mlDcmDRTApplicationSetupSequenceInterface.h.

References mlrange_cast().

setApplicationSetupManufacturer()

bool ml::DcmDRTApplicationSetupSequenceInterface::setApplicationSetupManufacturer	(	unsigned long	idx,
		std::string	parameter )

setApplicationSetupName()

bool ml::DcmDRTApplicationSetupSequenceInterface::setApplicationSetupName	(	unsigned long	idx,
		std::string	parameter )

setApplicationSetupNumber()

bool ml::DcmDRTApplicationSetupSequenceInterface::setApplicationSetupNumber	(	unsigned long	idx,
		std::string	parameter )

setApplicationSetupType()

bool ml::DcmDRTApplicationSetupSequenceInterface::setApplicationSetupType	(	unsigned long	idx,
		std::string	parameter )

setBrachyAccessoryDeviceSequence()

void ml::DcmDRTApplicationSetupSequenceInterface::setBrachyAccessoryDeviceSequence	(	DcmDRTBrachyAccessoryDeviceSequenceInterface	seq,
		unsigned long	idx )

setChannelSequence()

void ml::DcmDRTApplicationSetupSequenceInterface::setChannelSequence	(	DcmDRTChannelSequenceInterface	seq,
		unsigned long	idx )

setReferencedReferenceImageSequence()

void ml::DcmDRTApplicationSetupSequenceInterface::setReferencedReferenceImageSequence	(	DcmDRTReferencedReferenceImageSequenceInRTBrachyApplicationSetupsModuleInterface	seq,
		unsigned long	idx )

setSequence()

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

inline

Set the DRTApplicationSetupSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTApplicationSetupSequence

Definition at line 211 of file mlDcmDRTApplicationSetupSequenceInterface.h.

References mlrange_cast().

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

setTemplateName()

bool ml::DcmDRTApplicationSetupSequenceInterface::setTemplateName	(	unsigned long	idx,
		std::string	parameter )

setTemplateNumber()

bool ml::DcmDRTApplicationSetupSequenceInterface::setTemplateNumber	(	unsigned long	idx,
		std::string	parameter )

setTemplateType()

bool ml::DcmDRTApplicationSetupSequenceInterface::setTemplateType	(	unsigned long	idx,
		std::string	parameter )

setTotalReferenceAirKerma()

bool ml::DcmDRTApplicationSetupSequenceInterface::setTotalReferenceAirKerma	(	unsigned long	idx,
		std::string	parameter )

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 279 of file mlDcmDRTApplicationSetupSequenceInterface.h.

---

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

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