Inheritance diagram for DRTFractionStatusSummarySequence::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	getReferencedFractionNumber (OFString &value, const signed long pos=0) const
	get ReferencedFractionNumber (3008,0223)
OFCondition	getReferencedFractionNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedFractionNumber (3008,0223)
OFCondition	getTreatmentDate (OFString &value, const signed long pos=0) const
	get TreatmentDate (3008,0250)
OFCondition	getTreatmentTerminationStatus (OFString &value, const signed long pos=0) const
	get TreatmentTerminationStatus (3008,002a)
OFCondition	getTreatmentTime (OFString &value, const signed long pos=0) const
	get TreatmentTime (3008,0251)
OFCondition	setReferencedFractionNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedFractionNumber (3008,0223)
OFCondition	setTreatmentDate (const OFString &value, const OFBool check=OFTrue)
	set TreatmentDate (3008,0250)
OFCondition	setTreatmentTerminationStatus (const OFString &value, const OFBool check=OFTrue)
	set TreatmentTerminationStatus (3008,002a)
OFCondition	setTreatmentTime (const OFString &value, const OFBool check=OFTrue)
	set TreatmentTime (3008,0251)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmIntegerString	ReferencedFractionNumber
	ReferencedFractionNumber (3008,0223) vr=IS, vm=1, type=1C.
DcmDate	TreatmentDate
	TreatmentDate (3008,0250) vr=DA, vm=1, type=2C.
DcmCodeString	TreatmentTerminationStatus
	TreatmentTerminationStatus (3008,002a) vr=CS, vm=1, type=2C.
DcmTime	TreatmentTime
	TreatmentTime (3008,0251) vr=TM, vm=1, type=2C.

Detailed Description

Item class.

Constructor & Destructor Documentation

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

(default) constructor

Parameters:

emptyDefaultItem flag used to mark the empty default item

DRTFractionStatusSummarySequence::Item::Item ( const Item & copy )

copy constructor

Parameters:

copy	item object to be copied

Member Function Documentation

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

get ReferencedFractionNumber (3008,0223)

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 DRTFractionStatusSummarySequence::Item::getReferencedFractionNumber	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get ReferencedFractionNumber (3008,0223)

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

get TreatmentDate (3008,0250)

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

get TreatmentTerminationStatus (3008,002a)

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

get TreatmentTime (3008,0251)

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

check if item is empty

Returns:: OFTrue if item is empty, OFFalse otherwise

OFBool DRTFractionStatusSummarySequence::Item::isValid ( ) const

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

Returns:: OFTrue if item is valid, OFFalse otherwise

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

assigment operator

Parameters:

copy	item object to be copied

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

set ReferencedFractionNumber (3008,0223)

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

set TreatmentDate (3008,0250)

Parameters:

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

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

OFCondition DRTFractionStatusSummarySequence::Item::setTreatmentTerminationStatus	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set TreatmentTerminationStatus (3008,002a)

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

set TreatmentTime (3008,0251)

Parameters:

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

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

OFCondition DRTFractionStatusSummarySequence::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/drtfsss.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation