Inheritance diagram for DRTFractionGroupSummarySequence::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	getFractionGroupType (OFString &value, const signed long pos=0) const
	get FractionGroupType (3008,0224) More...

OFCondition	getNumberOfFractionsDelivered (OFString &value, const signed long pos=0) const
	get NumberOfFractionsDelivered (3008,005a) More...

OFCondition	getNumberOfFractionsDelivered (Sint32 &value, const unsigned long pos=0) const
	get NumberOfFractionsDelivered (3008,005a) More...

OFCondition	getNumberOfFractionsPlanned (OFString &value, const signed long pos=0) const
	get NumberOfFractionsPlanned (300a,0078) More...

OFCondition	getNumberOfFractionsPlanned (Sint32 &value, const unsigned long pos=0) const
	get NumberOfFractionsPlanned (300a,0078) More...

OFCondition	getReferencedFractionGroupNumber (OFString &value, const signed long pos=0) const
	get ReferencedFractionGroupNumber (300c,0022) More...

OFCondition	getReferencedFractionGroupNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedFractionGroupNumber (300c,0022) More...

DRTFractionStatusSummarySequence &	getFractionStatusSummarySequence ()
	get FractionStatusSummarySequence (3008,0240) More...

const DRTFractionStatusSummarySequence &	getFractionStatusSummarySequence () const
	get FractionStatusSummarySequence (3008,0240) More...

OFCondition	setFractionGroupType (const OFString &value, const OFBool check=OFTrue)
	set FractionGroupType (3008,0224) More...

OFCondition	setNumberOfFractionsDelivered (const OFString &value, const OFBool check=OFTrue)
	set NumberOfFractionsDelivered (3008,005a) More...

OFCondition	setNumberOfFractionsPlanned (const OFString &value, const OFBool check=OFTrue)
	set NumberOfFractionsPlanned (300a,0078) More...

OFCondition	setReferencedFractionGroupNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedFractionGroupNumber (300c,0022) More...

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

DcmCodeString	FractionGroupType
	FractionGroupType (3008,0224) vr=CS, vm=1, type=2.

DRTFractionStatusSummarySequence	FractionStatusSummarySequence
	FractionStatusSummarySequence (3008,0240) vr=SQ, vm=1, type=3.

DcmIntegerString	NumberOfFractionsDelivered
	NumberOfFractionsDelivered (3008,005a) vr=IS, vm=1, type=2.

DcmIntegerString	NumberOfFractionsPlanned
	NumberOfFractionsPlanned (300a,0078) vr=IS, vm=1, type=2.

DcmIntegerString	ReferencedFractionGroupNumber
	ReferencedFractionGroupNumber (300c,0022) vr=IS, vm=1, type=3.

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]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTFractionGroupSummarySequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getFractionGroupType()

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

◆ getFractionStatusSummarySequence() [1/2]

DRTFractionStatusSummarySequence& DRTFractionGroupSummarySequence::Item::getFractionStatusSummarySequence ( )

inline

get FractionStatusSummarySequence (3008,0240)

Returns: reference to sequence element

◆ getFractionStatusSummarySequence() [2/2]

const DRTFractionStatusSummarySequence& DRTFractionGroupSummarySequence::Item::getFractionStatusSummarySequence ( ) const

inline

get FractionStatusSummarySequence (3008,0240)

Returns: const reference to sequence element

◆ getNumberOfFractionsDelivered() [1/2]

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

◆ getNumberOfFractionsDelivered() [2/2]

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

◆ getNumberOfFractionsPlanned() [1/2]

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

◆ getNumberOfFractionsPlanned() [2/2]

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

◆ getReferencedFractionGroupNumber() [1/2]

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

◆ getReferencedFractionGroupNumber() [2/2]

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

◆ isEmpty()

OFBool DRTFractionGroupSummarySequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

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

◆ operator=()

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

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

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

◆ setFractionGroupType()

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

◆ setNumberOfFractionsDelivered()

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

◆ setNumberOfFractionsPlanned()

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

◆ setReferencedFractionGroupNumber()

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

◆ write()

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getFractionGroupType()

◆ getFractionStatusSummarySequence() [1/2]

◆ getFractionStatusSummarySequence() [2/2]

◆ getNumberOfFractionsDelivered() [1/2]

◆ getNumberOfFractionsDelivered() [2/2]

◆ getNumberOfFractionsPlanned() [1/2]

◆ getNumberOfFractionsPlanned() [2/2]

◆ getReferencedFractionGroupNumber() [1/2]

◆ getReferencedFractionGroupNumber() [2/2]

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setFractionGroupType()

◆ setNumberOfFractionsDelivered()

◆ setNumberOfFractionsPlanned()

◆ setReferencedFractionGroupNumber()

◆ write()