DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item:

List of all members.

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor
	Item (const Item &copy)
	copy constructor
virtual	~Item ()
	destructor
Item &	operator= (const Item &copy)
	assigment operator
void	clear ()
	clear all internal member variables
OFBool	isEmpty ()
	check if item is empty
OFBool	isValid () const
	check if item is valid, i.e. not the empty default item
OFCondition	read (DcmItem &item)
	read elements from sequence item
OFCondition	write (DcmItem &item)
	write elements to sequence item
OFCondition	getChannelIdentificationCode (OFString &value, const signed long pos=0) const
	get ChannelIdentificationCode (003a,0301)
OFCondition	getChannelIdentificationCode (Sint32 &value, const unsigned long pos=0) const
	get ChannelIdentificationCode (003a,0301)
OFCondition	getChannelMode (OFString &value, const signed long pos=0) const
	get ChannelMode (003a,0302)
DRTChannelSourceSequence &	getChannelSourceSequence ()
	get ChannelSourceSequence (003a,0208)
const DRTChannelSourceSequence &	getChannelSourceSequence () const
	get ChannelSourceSequence (003a,0208)
OFCondition	setChannelIdentificationCode (const OFString &value, const OFBool check=OFTrue)
	set ChannelIdentificationCode (003a,0301)
OFCondition	setChannelMode (const OFString &value, const OFBool check=OFTrue)
	set ChannelMode (003a,0302)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	ChannelIdentificationCode
	ChannelIdentificationCode (003a,0301) vr=IS, vm=1, type=1.
DcmCodeString	ChannelMode
	ChannelMode (003a,0302) vr=CS, vm=1, type=1.
DRTChannelSourceSequence	ChannelSourceSequence
	ChannelSourceSequence (003a,0208) vr=SQ, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelIdentificationCode	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ChannelIdentificationCode (003a,0301)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelIdentificationCode	(	Sint32 &	value,
		const unsigned long	pos = 0
	)		const

get ChannelIdentificationCode (003a,0301)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelMode	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ChannelMode (003a,0302)

Parameters:

value	reference to variable in which the value should be stored
pos	index of the value to get (0..vm-1), -1 for all components

Returns:

status, EC_Normal if successful, an error code otherwise

DRTChannelSourceSequence& DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelSourceSequence

(

)

[inline]

get ChannelSourceSequence (003a,0208)

Returns:

reference to sequence element

const DRTChannelSourceSequence& DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::getChannelSourceSequence

(

)

const [inline]

get ChannelSourceSequence (003a,0208)

Returns:

const reference to sequence element

OFBool DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::isValid

(

)

const

check if item is valid, i.e. not the empty default item

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::read

(

DcmItem &

item

)

read elements from sequence item

Parameters:

item	reference to DICOM sequence item from which the elements should be read

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::setChannelIdentificationCode	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ChannelIdentificationCode (003a,0301)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (IS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::setChannelMode	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ChannelMode (003a,0302)

Parameters:

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMultiplexedAudioChannelsDescriptionCodeSequence::Item::write

(

DcmItem &

item

)

write elements to sequence item

Parameters:

item	reference to DICOM sequence item to which the elements should be written

Returns:

status, EC_Normal if successful, an error code otherwise

---

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

• dcmrt/include/dcmtk/dcmrt/seq/drtmacds.h