Inheritance diagram for DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item:

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	getDeviceSerialNumber (OFString &value, const signed long pos=0) const
	get DeviceSerialNumber (0018,1000)
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	getInstitutionalDepartmentName (OFString &value, const signed long pos=0) const
	get InstitutionalDepartmentName (0008,1040)
OFCondition	getManufacturer (OFString &value, const signed long pos=0) const
	get Manufacturer (0008,0070)
OFCondition	getManufacturerModelName (OFString &value, const signed long pos=0) const
	get ManufacturerModelName (0008,1090)
OFCondition	getTreatmentMachineName (OFString &value, const signed long pos=0) const
	get TreatmentMachineName (300a,00b2)
OFCondition	setDeviceSerialNumber (const OFString &value, const OFBool check=OFTrue)
	set DeviceSerialNumber (0018,1000)
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	setInstitutionalDepartmentName (const OFString &value, const OFBool check=OFTrue)
	set InstitutionalDepartmentName (0008,1040)
OFCondition	setManufacturer (const OFString &value, const OFBool check=OFTrue)
	set Manufacturer (0008,0070)
OFCondition	setManufacturerModelName (const OFString &value, const OFBool check=OFTrue)
	set ManufacturerModelName (0008,1090)
OFCondition	setTreatmentMachineName (const OFString &value, const OFBool check=OFTrue)
	set TreatmentMachineName (300a,00b2)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	DeviceSerialNumber
	DeviceSerialNumber (0018,1000) vr=LO, vm=1, type=3.
DcmShortText	InstitutionAddress
	InstitutionAddress (0008,0081) vr=ST, vm=1, type=3.
DcmLongString	InstitutionName
	InstitutionName (0008,0080) vr=LO, vm=1, type=3.
DcmLongString	InstitutionalDepartmentName
	InstitutionalDepartmentName (0008,1040) vr=LO, vm=1, type=3.
DcmLongString	Manufacturer
	Manufacturer (0008,0070) vr=LO, vm=1, type=3.
DcmLongString	ManufacturerModelName
	ManufacturerModelName (0008,1090) vr=LO, vm=1, type=3.
DcmShortString	TreatmentMachineName
	TreatmentMachineName (300a,00b2) vr=SH, vm=1, type=2.

Detailed Description

Item class.

Constructor & Destructor Documentation

DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item::Item ( const OFBool emptyDefaultItem = OFFalse )

(default) constructor

Parameters:

emptyDefaultItem flag used to mark the empty default item

DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item::Item ( const Item & copy )

copy constructor

Parameters:

copy	item object to be copied

Member Function Documentation

OFCondition DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item::getDeviceSerialNumber	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get DeviceSerialNumber (0018,1000)

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 DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::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

OFCondition DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item::getInstitutionalDepartmentName	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get InstitutionalDepartmentName (0008,1040)

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

get Manufacturer (0008,0070)

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

get ManufacturerModelName (0008,1090)

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

get TreatmentMachineName (300a,00b2)

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 DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item::isEmpty ( )

check if item is empty

Returns:: OFTrue if item is empty, OFFalse otherwise

OFBool DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item::isValid ( ) const

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

Returns:: OFTrue if item is valid, OFFalse otherwise

Item& DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::Item::operator= ( const Item & copy )

assigment operator

Parameters:

copy	item object to be copied

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

set DeviceSerialNumber (0018,1000)

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

set InstitutionalDepartmentName (0008,1040)

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

set Manufacturer (0008,0070)

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

set ManufacturerModelName (0008,1090)

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

set TreatmentMachineName (300a,00b2)

Parameters:

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

Returns:: status, EC_Normal if successful, an error code otherwise

OFCondition DRTTreatmentMachineSequenceInRTBrachyApplicationSetupsModule::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/drttms9.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation