Inheritance diagram for DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::Item:

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor More...

	Item (const Item &copy)
	copy constructor More...

virtual	~Item ()
	destructor

Item &	operator= (const Item &copy)
	assigment operator More...

void	clear ()
	clear all internal member variables

OFBool	isEmpty ()
	check if item is empty More...

OFBool	isValid () const
	check if item is valid, i.e. not the empty default item More...

OFCondition	read (DcmItem &item)
	read elements from sequence item More...

OFCondition	write (DcmItem &item)
	write elements to sequence item More...

OFCondition	getDeviceSerialNumber (OFString &value, const signed long pos=0) const
	get DeviceSerialNumber (0018,1000) More...

OFCondition	getInstitutionAddress (OFString &value, const signed long pos=0) const
	get InstitutionAddress (0008,0081) More...

OFCondition	getInstitutionName (OFString &value, const signed long pos=0) const
	get InstitutionName (0008,0080) More...

OFCondition	getInstitutionalDepartmentName (OFString &value, const signed long pos=0) const
	get InstitutionalDepartmentName (0008,1040) More...

OFCondition	getManufacturer (OFString &value, const signed long pos=0) const
	get Manufacturer (0008,0070) More...

OFCondition	getManufacturerModelName (OFString &value, const signed long pos=0) const
	get ManufacturerModelName (0008,1090) More...

OFCondition	getTreatmentMachineName (OFString &value, const signed long pos=0) const
	get TreatmentMachineName (300a,00b2) More...

OFCondition	setDeviceSerialNumber (const OFString &value, const OFBool check=OFTrue)
	set DeviceSerialNumber (0018,1000) More...

OFCondition	setInstitutionAddress (const OFString &value, const OFBool check=OFTrue)
	set InstitutionAddress (0008,0081) More...

OFCondition	setInstitutionName (const OFString &value, const OFBool check=OFTrue)
	set InstitutionName (0008,0080) More...

OFCondition	setInstitutionalDepartmentName (const OFString &value, const OFBool check=OFTrue)
	set InstitutionalDepartmentName (0008,1040) More...

OFCondition	setManufacturer (const OFString &value, const OFBool check=OFTrue)
	set Manufacturer (0008,0070) More...

OFCondition	setManufacturerModelName (const OFString &value, const OFBool check=OFTrue)
	set ManufacturerModelName (0008,1090) More...

OFCondition	setTreatmentMachineName (const OFString &value, const OFBool check=OFTrue)
	set TreatmentMachineName (300a,00b2) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item

DcmLongString	DeviceSerialNumber
	DeviceSerialNumber (0018,1000) vr=LO, vm=1, type=2.

DcmShortText	InstitutionAddress
	InstitutionAddress (0008,0081) vr=ST, vm=1, type=3.

DcmLongString	InstitutionName
	InstitutionName (0008,0080) vr=LO, vm=1, type=2.

DcmLongString	InstitutionalDepartmentName
	InstitutionalDepartmentName (0008,1040) vr=LO, vm=1, type=3.

DcmLongString	Manufacturer
	Manufacturer (0008,0070) vr=LO, vm=1, type=2.

DcmLongString	ManufacturerModelName
	ManufacturerModelName (0008,1090) vr=LO, vm=1, type=2.

DcmShortString	TreatmentMachineName
	TreatmentMachineName (300a,00b2) vr=SH, vm=1, type=2.

Additional Inherited Members
Protected Member Functions inherited from DRTTypes
virtual	~DRTTypes ()
	destructor. More...

Static Protected Member Functions inherited from DRTTypes
static OFCondition	addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement element, const OFString &vm, const OFString &type, const char moduleName=NULL)
	add given element to the dataset. More...

static OFCondition	getElementFromDataset (DcmItem &dataset, DcmElement &element)
	get element from dataset More...

static OFCondition	getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
	get string value from element More...

static OFCondition	getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
	get string value from dataset More...

static OFCondition	putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
	put string value to dataset More...

static OFBool	checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
	check element value for correct value multiplicity and type More...

static OFCondition	getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get element from dataset and check it for correct value multiplicity and type. More...

static OFCondition	getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL)
	get string value from dataset and check it for correct value multiplicity and type. More...

Detailed Description

Item class.

Constructor & Destructor Documentation

◆ Item() [1/2]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getDeviceSerialNumber()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ getInstitutionAddress()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ getInstitutionalDepartmentName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ getInstitutionName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ getManufacturer()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ getManufacturerModelName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ getTreatmentMachineName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ isEmpty()

OFBool DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::Item::isValid ( ) const

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

Returns: OFTrue if item is valid, OFFalse otherwise

◆ operator=()

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

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ setDeviceSerialNumber()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ setInstitutionAddress()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ setInstitutionalDepartmentName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ setInstitutionName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ setManufacturer()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ setManufacturerModelName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ setTreatmentMachineName()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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

◆ write()

OFCondition DRTTreatmentMachineSequenceInRTTreatmentMachineRecordModule::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/drttms0.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getDeviceSerialNumber()

◆ getInstitutionAddress()

◆ getInstitutionalDepartmentName()

◆ getInstitutionName()

◆ getManufacturer()

◆ getManufacturerModelName()

◆ getTreatmentMachineName()

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setDeviceSerialNumber()

◆ setInstitutionAddress()

◆ setInstitutionalDepartmentName()

◆ setInstitutionName()

◆ setManufacturer()

◆ setManufacturerModelName()

◆ setTreatmentMachineName()

◆ write()