DRTMACParametersSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTMACParametersSequence::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	getDataElementsSigned (OFString &value, const signed long pos=0) const
	get DataElementsSigned (0400,0020)
OFCondition	getMACAlgorithm (OFString &value, const signed long pos=0) const
	get MACAlgorithm (0400,0015)
OFCondition	getMACCalculationTransferSyntaxUID (OFString &value, const signed long pos=0) const
	get MACCalculationTransferSyntaxUID (0400,0010)
OFCondition	getMACIDNumber (Uint16 &value, const unsigned long pos=0) const
	get MACIDNumber (0400,0005)
OFCondition	setDataElementsSigned (const OFString &value, const OFBool check=OFTrue)
	set DataElementsSigned (0400,0020)
OFCondition	setMACAlgorithm (const OFString &value, const OFBool check=OFTrue)
	set MACAlgorithm (0400,0015)
OFCondition	setMACCalculationTransferSyntaxUID (const OFString &value, const OFBool check=OFTrue)
	set MACCalculationTransferSyntaxUID (0400,0010)
OFCondition	setMACIDNumber (const Uint16 value, const unsigned long pos=0)
	set MACIDNumber (0400,0005)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmAttributeTag	DataElementsSigned
	DataElementsSigned (0400,0020) vr=AT, vm=1-n, type=1.
DcmCodeString	MACAlgorithm
	MACAlgorithm (0400,0015) vr=CS, vm=1, type=1.
DcmUniqueIdentifier	MACCalculationTransferSyntaxUID
	MACCalculationTransferSyntaxUID (0400,0010) vr=UI, vm=1, type=1.
DcmUnsignedShort	MACIDNumber
	MACIDNumber (0400,0005) vr=US, vm=1, type=1.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTMACParametersSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTMACParametersSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTMACParametersSequence::Item::getDataElementsSigned	(	OFString &	value,
		const signed long	pos = 0
	)		const

get DataElementsSigned (0400,0020)

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 DRTMACParametersSequence::Item::getMACAlgorithm	(	OFString &	value,
		const signed long	pos = 0
	)		const

get MACAlgorithm (0400,0015)

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 DRTMACParametersSequence::Item::getMACCalculationTransferSyntaxUID	(	OFString &	value,
		const signed long	pos = 0
	)		const

get MACCalculationTransferSyntaxUID (0400,0010)

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 DRTMACParametersSequence::Item::getMACIDNumber	(	Uint16 &	value,
		const unsigned long	pos = 0
	)		const

get MACIDNumber (0400,0005)

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

OFBool DRTMACParametersSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTMACParametersSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTMACParametersSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTMACParametersSequence::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 DRTMACParametersSequence::Item::setDataElementsSigned	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set DataElementsSigned (0400,0020)

Parameters:

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (AT) and VM (1-n) if enabled

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMACParametersSequence::Item::setMACAlgorithm	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set MACAlgorithm (0400,0015)

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 DRTMACParametersSequence::Item::setMACCalculationTransferSyntaxUID	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set MACCalculationTransferSyntaxUID (0400,0010)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMACParametersSequence::Item::setMACIDNumber	(	const Uint16	value,
		const unsigned long	pos = 0
	)

set MACIDNumber (0400,0005)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTMACParametersSequence::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/drtmps.h