ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface Class Reference

Class to provide access to DRTMultiplexedAudioChannelsDescriptionCodeSequence. More...

#include <mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h>

Classes
class	Item

Public Member Functions
	DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface ()
	DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface (std::vector< DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item > dcmSequence)
	Default Constructor.
	DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface (DCMTree::TreePtrVector treePtrSeq)
virtual	~DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface ()
	Default virtual Destructor.
bool	getChannelIdentificationCode (unsigned long idx, std::string &parameter) const
bool	getChannelIdentificationCode (DCMTree::TreePtr item, std::string &parameter) const
std::string	getChannelIdentificationCodeTag () const
bool	setChannelIdentificationCode (unsigned long idx, std::string parameter)
bool	getChannelMode (unsigned long idx, std::string &parameter) const
bool	getChannelMode (DCMTree::TreePtr item, std::string &parameter) const
std::string	getChannelModeTag () const
bool	setChannelMode (unsigned long idx, std::string parameter)
DcmDRTChannelSourceSequenceInterface	getChannelSourceSequence (unsigned long idx) const
std::string	getChannelSourceSequenceTag () const
void	setChannelSourceSequence (DcmDRTChannelSourceSequenceInterface seq, unsigned long idx)
void	setSequence (std::vector< DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item > dcmSequence)
std::vector< DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item >	getSequence () const
bool	hasSequence () const
MLint	getNumberOfItems () const
DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item	getItem (const size_t idx) const
DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item &	addItem ()
void	addItem (DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item newItem)
bool	insertItem (const size_t idx)
bool	removeItem (const size_t idx)

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

Detailed Description

Class to provide access to DRTMultiplexedAudioChannelsDescriptionCodeSequence.

Definition at line 44 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

Constructor & Destructor Documentation

DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface() [1/3]

ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface ( )

inline

Definition at line 89 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface() [2/3]

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

inline

Default Constructor.

Definition at line 92 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface() [3/3]

ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface ( DCMTree::TreePtrVector treePtrSeq )

inline

Definition at line 94 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

~DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface()

virtual ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::~DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface ( )

inlinevirtual

Default virtual Destructor.

Definition at line 102 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

Member Function Documentation

addItem() [1/2]

DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item & ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::addItem ( )

inline

Adds a new item to the sequence

Returns

Return the new item which has been added to the sequence

Definition at line 156 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

addItem() [2/2]

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

inline

Definition at line 161 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

getChannelIdentificationCode() [1/2]

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelIdentificationCode	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getChannelIdentificationCode() [2/2]

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelIdentificationCode	(	unsigned long	idx,
		std::string &	parameter ) const

getChannelIdentificationCodeTag()

std::string ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelIdentificationCodeTag ( ) const

inline

Definition at line 106 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

getChannelMode() [1/2]

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelMode	(	DCMTree::TreePtr	item,
		std::string &	parameter ) const

getChannelMode() [2/2]

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelMode	(	unsigned long	idx,
		std::string &	parameter ) const

getChannelModeTag()

std::string ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelModeTag ( ) const

inline

Definition at line 112 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

getChannelSourceSequence()

DcmDRTChannelSourceSequenceInterface ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelSourceSequence

(

unsigned long

idx

)

const

getChannelSourceSequenceTag()

std::string ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::getChannelSourceSequenceTag ( ) const

inline

Definition at line 117 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

getItem()

DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::Item ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::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 147 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

getNumberOfItems()

MLint ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::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 141 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

getSequence()

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

inline

Return the DRTMultiplexedAudioChannelsDescriptionCodeSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMultiplexedAudioChannelsDescriptionCodeSequence

Definition at line 129 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

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

hasSequence()

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::hasSequence ( ) const

inline

Check if the DRTMultiplexedAudioChannelsDescriptionCodeSequence is set.

Returns

True if internal pointer is set, False else.

Definition at line 135 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

insertItem()

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::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 167 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

removeItem()

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::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 179 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

setChannelIdentificationCode()

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::setChannelIdentificationCode	(	unsigned long	idx,
		std::string	parameter )

setChannelMode()

bool ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::setChannelMode	(	unsigned long	idx,
		std::string	parameter )

setChannelSourceSequence()

void ml::DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface::setChannelSourceSequence	(	DcmDRTChannelSourceSequenceInterface	seq,
		unsigned long	idx )

setSequence()

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

inline

Set the DRTMultiplexedAudioChannelsDescriptionCodeSequence this interface class provides access to.

Parameters

dcmSequence

Pointer to DRTMultiplexedAudioChannelsDescriptionCodeSequence

Definition at line 123 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

References _itemVec.

Member Data Documentation

_itemVec

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

protected

Reference to the wrapped DICOM tree pointer vector.

Definition at line 191 of file mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h.

Referenced by addItem(), addItem(), DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface(), DcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface(), 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/mlDcmDRTMultiplexedAudioChannelsDescriptionCodeSequenceInterface.h