DRTPhysiciansOfRecordIdentificationSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTPhysiciansOfRecordIdentificationSequence::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	getInstitutionAddress (OFString &value, const signed long pos=0) const
	get InstitutionAddress (0008,0081)
OFCondition	getInstitutionName (OFString &value, const signed long pos=0) const
	get InstitutionName (0008,0080)
OFCondition	getPersonAddress (OFString &value, const signed long pos=0) const
	get PersonAddress (0040,1102)
OFCondition	getPersonTelephoneNumbers (OFString &value, const signed long pos=0) const
	get PersonTelephoneNumbers (0040,1103)
DRTInstitutionCodeSequence &	getInstitutionCodeSequence ()
	get InstitutionCodeSequence (0008,0082)
const DRTInstitutionCodeSequence &	getInstitutionCodeSequence () const
	get InstitutionCodeSequence (0008,0082)
DRTPersonIdentificationCodeSequence &	getPersonIdentificationCodeSequence ()
	get PersonIdentificationCodeSequence (0040,1101)
const DRTPersonIdentificationCodeSequence &	getPersonIdentificationCodeSequence () const
	get PersonIdentificationCodeSequence (0040,1101)
OFCondition	setInstitutionAddress (const OFString &value, const OFBool check=OFTrue)
	set InstitutionAddress (0008,0081)
OFCondition	setInstitutionName (const OFString &value, const OFBool check=OFTrue)
	set InstitutionName (0008,0080)
OFCondition	setPersonAddress (const OFString &value, const OFBool check=OFTrue)
	set PersonAddress (0040,1102)
OFCondition	setPersonTelephoneNumbers (const OFString &value, const OFBool check=OFTrue)
	set PersonTelephoneNumbers (0040,1103)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmShortText	InstitutionAddress
	InstitutionAddress (0008,0081) vr=ST, vm=1, type=3.
DRTInstitutionCodeSequence	InstitutionCodeSequence
	InstitutionCodeSequence (0008,0082) vr=SQ, vm=1, type=1C.
DcmLongString	InstitutionName
	InstitutionName (0008,0080) vr=LO, vm=1, type=1C.
DcmShortText	PersonAddress
	PersonAddress (0040,1102) vr=ST, vm=1, type=3.
DRTPersonIdentificationCodeSequence	PersonIdentificationCodeSequence
	PersonIdentificationCodeSequence (0040,1101) vr=SQ, vm=1, type=1.
DcmLongString	PersonTelephoneNumbers
	PersonTelephoneNumbers (0040,1103) vr=LO, vm=1-n, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTPhysiciansOfRecordIdentificationSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTPhysiciansOfRecordIdentificationSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTPhysiciansOfRecordIdentificationSequence::Item::getInstitutionAddress	(	OFString &	value,
		const signed long	pos = 0
	)		const

get InstitutionAddress (0008,0081)

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

DRTInstitutionCodeSequence& DRTPhysiciansOfRecordIdentificationSequence::Item::getInstitutionCodeSequence

(

)

[inline]

get InstitutionCodeSequence (0008,0082)

Returns:

reference to sequence element

const DRTInstitutionCodeSequence& DRTPhysiciansOfRecordIdentificationSequence::Item::getInstitutionCodeSequence

(

)

const [inline]

get InstitutionCodeSequence (0008,0082)

Returns:

const reference to sequence element

OFCondition DRTPhysiciansOfRecordIdentificationSequence::Item::getInstitutionName	(	OFString &	value,
		const signed long	pos = 0
	)		const

get InstitutionName (0008,0080)

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

get PersonAddress (0040,1102)

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

DRTPersonIdentificationCodeSequence& DRTPhysiciansOfRecordIdentificationSequence::Item::getPersonIdentificationCodeSequence

(

)

[inline]

get PersonIdentificationCodeSequence (0040,1101)

Returns:

reference to sequence element

const DRTPersonIdentificationCodeSequence& DRTPhysiciansOfRecordIdentificationSequence::Item::getPersonIdentificationCodeSequence

(

)

const [inline]

get PersonIdentificationCodeSequence (0040,1101)

Returns:

const reference to sequence element

OFCondition DRTPhysiciansOfRecordIdentificationSequence::Item::getPersonTelephoneNumbers	(	OFString &	value,
		const signed long	pos = 0
	)		const

get PersonTelephoneNumbers (0040,1103)

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

OFBool DRTPhysiciansOfRecordIdentificationSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTPhysiciansOfRecordIdentificationSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTPhysiciansOfRecordIdentificationSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set InstitutionAddress (0008,0081)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTPhysiciansOfRecordIdentificationSequence::Item::setInstitutionName	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set InstitutionName (0008,0080)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTPhysiciansOfRecordIdentificationSequence::Item::setPersonAddress	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set PersonAddress (0040,1102)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTPhysiciansOfRecordIdentificationSequence::Item::setPersonTelephoneNumbers	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set PersonTelephoneNumbers (0040,1103)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTPhysiciansOfRecordIdentificationSequence::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/drtporis.h