DRTFractionGroupSummarySequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTFractionGroupSummarySequence::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	getCumulativeDoseToDoseReference (OFString &value, const signed long pos=0) const
	get CumulativeDoseToDoseReference (3008,0052)
OFCondition	getCumulativeDoseToDoseReference (Float64 &value, const unsigned long pos=0) const
	get CumulativeDoseToDoseReference (3008,0052)
OFCondition	getDoseReferenceDescription (OFString &value, const signed long pos=0) const
	get DoseReferenceDescription (300a,0016)
OFCondition	getFractionGroupType (OFString &value, const signed long pos=0) const
	get FractionGroupType (3008,0224)
OFCondition	getNumberOfFractionsDelivered (OFString &value, const signed long pos=0) const
	get NumberOfFractionsDelivered (3008,005a)
OFCondition	getNumberOfFractionsDelivered (Sint32 &value, const unsigned long pos=0) const
	get NumberOfFractionsDelivered (3008,005a)
OFCondition	getNumberOfFractionsPlanned (OFString &value, const signed long pos=0) const
	get NumberOfFractionsPlanned (300a,0078)
OFCondition	getNumberOfFractionsPlanned (Sint32 &value, const unsigned long pos=0) const
	get NumberOfFractionsPlanned (300a,0078)
OFCondition	getReferencedDoseReferenceNumber (OFString &value, const signed long pos=0) const
	get ReferencedDoseReferenceNumber (300c,0051)
OFCondition	getReferencedDoseReferenceNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedDoseReferenceNumber (300c,0051)
OFCondition	getReferencedFractionGroupNumber (OFString &value, const signed long pos=0) const
	get ReferencedFractionGroupNumber (300c,0022)
OFCondition	getReferencedFractionGroupNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedFractionGroupNumber (300c,0022)
DRTFractionStatusSummarySequence &	getFractionStatusSummarySequence ()
	get FractionStatusSummarySequence (3008,0240)
const DRTFractionStatusSummarySequence &	getFractionStatusSummarySequence () const
	get FractionStatusSummarySequence (3008,0240)
OFCondition	setCumulativeDoseToDoseReference (const OFString &value, const OFBool check=OFTrue)
	set CumulativeDoseToDoseReference (3008,0052)
OFCondition	setDoseReferenceDescription (const OFString &value, const OFBool check=OFTrue)
	set DoseReferenceDescription (300a,0016)
OFCondition	setFractionGroupType (const OFString &value, const OFBool check=OFTrue)
	set FractionGroupType (3008,0224)
OFCondition	setNumberOfFractionsDelivered (const OFString &value, const OFBool check=OFTrue)
	set NumberOfFractionsDelivered (3008,005a)
OFCondition	setNumberOfFractionsPlanned (const OFString &value, const OFBool check=OFTrue)
	set NumberOfFractionsPlanned (300a,0078)
OFCondition	setReferencedDoseReferenceNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedDoseReferenceNumber (300c,0051)
OFCondition	setReferencedFractionGroupNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedFractionGroupNumber (300c,0022)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmDecimalString	CumulativeDoseToDoseReference
	CumulativeDoseToDoseReference (3008,0052) vr=DS, vm=1, type=1C.
DcmLongString	DoseReferenceDescription
	DoseReferenceDescription (300a,0016) vr=LO, vm=1, type=3.
DcmCodeString	FractionGroupType
	FractionGroupType (3008,0224) vr=CS, vm=1, type=2C.
DRTFractionStatusSummarySequence	FractionStatusSummarySequence
	FractionStatusSummarySequence (3008,0240) vr=SQ, vm=1, type=3.
DcmIntegerString	NumberOfFractionsDelivered
	NumberOfFractionsDelivered (3008,005a) vr=IS, vm=1, type=2C.
DcmIntegerString	NumberOfFractionsPlanned
	NumberOfFractionsPlanned (300a,0078) vr=IS, vm=1, type=2C.
DcmIntegerString	ReferencedDoseReferenceNumber
	ReferencedDoseReferenceNumber (300c,0051) vr=IS, vm=1, type=3.
DcmIntegerString	ReferencedFractionGroupNumber
	ReferencedFractionGroupNumber (300c,0022) vr=IS, vm=1, type=3.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTFractionGroupSummarySequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTFractionGroupSummarySequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTFractionGroupSummarySequence::Item::getCumulativeDoseToDoseReference	(	OFString &	value,
		const signed long	pos = 0
	)		const

get CumulativeDoseToDoseReference (3008,0052)

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 DRTFractionGroupSummarySequence::Item::getCumulativeDoseToDoseReference	(	Float64 &	value,
		const unsigned long	pos = 0
	)		const

get CumulativeDoseToDoseReference (3008,0052)

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

get DoseReferenceDescription (300a,0016)

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

get FractionGroupType (3008,0224)

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

DRTFractionStatusSummarySequence& DRTFractionGroupSummarySequence::Item::getFractionStatusSummarySequence

(

)

[inline]

get FractionStatusSummarySequence (3008,0240)

Returns:

reference to sequence element

const DRTFractionStatusSummarySequence& DRTFractionGroupSummarySequence::Item::getFractionStatusSummarySequence

(

)

const [inline]

get FractionStatusSummarySequence (3008,0240)

Returns:

const reference to sequence element

OFCondition DRTFractionGroupSummarySequence::Item::getNumberOfFractionsDelivered	(	OFString &	value,
		const signed long	pos = 0
	)		const

get NumberOfFractionsDelivered (3008,005a)

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

get NumberOfFractionsDelivered (3008,005a)

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

get NumberOfFractionsPlanned (300a,0078)

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

get NumberOfFractionsPlanned (300a,0078)

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

get ReferencedDoseReferenceNumber (300c,0051)

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

get ReferencedDoseReferenceNumber (300c,0051)

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

get ReferencedFractionGroupNumber (300c,0022)

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

get ReferencedFractionGroupNumber (300c,0022)

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 DRTFractionGroupSummarySequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTFractionGroupSummarySequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTFractionGroupSummarySequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

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

set CumulativeDoseToDoseReference (3008,0052)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTFractionGroupSummarySequence::Item::setDoseReferenceDescription	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set DoseReferenceDescription (300a,0016)

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

set FractionGroupType (3008,0224)

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

set NumberOfFractionsDelivered (3008,005a)

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

set NumberOfFractionsPlanned (300a,0078)

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

set ReferencedDoseReferenceNumber (300c,0051)

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

set ReferencedFractionGroupNumber (300c,0022)

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 DRTFractionGroupSummarySequence::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/drtfgss.h