Inheritance diagram for DRTApplicatorSequenceInRTBeamsModule::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	getAccessoryCode (OFString &value, const signed long pos=0) const
	get AccessoryCode (300a,00f9) More...

OFCondition	getApplicatorDescription (OFString &value, const signed long pos=0) const
	get ApplicatorDescription (300a,010a) More...

OFCondition	getApplicatorID (OFString &value, const signed long pos=0) const
	get ApplicatorID (300a,0108) More...

OFCondition	getApplicatorType (OFString &value, const signed long pos=0) const
	get ApplicatorType (300a,0109) More...

OFCondition	getSourceToApplicatorMountingPositionDistance (Float32 &value, const unsigned long pos=0) const
	get SourceToApplicatorMountingPositionDistance (300a,0436) More...

DRTApplicatorGeometrySequence &	getApplicatorGeometrySequence ()
	get ApplicatorGeometrySequence (300a,0431) More...

const DRTApplicatorGeometrySequence &	getApplicatorGeometrySequence () const
	get ApplicatorGeometrySequence (300a,0431) More...

OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9) More...

OFCondition	setApplicatorDescription (const OFString &value, const OFBool check=OFTrue)
	set ApplicatorDescription (300a,010a) More...

OFCondition	setApplicatorID (const OFString &value, const OFBool check=OFTrue)
	set ApplicatorID (300a,0108) More...

OFCondition	setApplicatorType (const OFString &value, const OFBool check=OFTrue)
	set ApplicatorType (300a,0109) More...

OFCondition	setSourceToApplicatorMountingPositionDistance (const Float32 value, const unsigned long pos=0)
	set SourceToApplicatorMountingPositionDistance (300a,0436) More...

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

DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.

DcmLongString	ApplicatorDescription
	ApplicatorDescription (300a,010a) vr=LO, vm=1, type=3.

DRTApplicatorGeometrySequence	ApplicatorGeometrySequence
	ApplicatorGeometrySequence (300a,0431) vr=SQ, vm=1, type=3.

DcmShortString	ApplicatorID
	ApplicatorID (300a,0108) vr=SH, vm=1, type=1.

DcmCodeString	ApplicatorType
	ApplicatorType (300a,0109) vr=CS, vm=1, type=1.

DcmFloatingPointSingle	SourceToApplicatorMountingPositionDistance
	SourceToApplicatorMountingPositionDistance (300a,0436) vr=FL, 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

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

DRTApplicatorSequenceInRTBeamsModule::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

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

get AccessoryCode (300a,00f9)

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

get ApplicatorDescription (300a,010a)

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

DRTApplicatorGeometrySequence& DRTApplicatorSequenceInRTBeamsModule::Item::getApplicatorGeometrySequence ( )

inline

get ApplicatorGeometrySequence (300a,0431)

Returns: reference to sequence element

const DRTApplicatorGeometrySequence& DRTApplicatorSequenceInRTBeamsModule::Item::getApplicatorGeometrySequence ( ) const

inline

get ApplicatorGeometrySequence (300a,0431)

Returns: const reference to sequence element

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

get ApplicatorID (300a,0108)

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

get ApplicatorType (300a,0109)

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 DRTApplicatorSequenceInRTBeamsModule::Item::getSourceToApplicatorMountingPositionDistance	(	Float32 &	value,
		const unsigned long	pos = `0`
	)		const

get SourceToApplicatorMountingPositionDistance (300a,0436)

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

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

OFBool DRTApplicatorSequenceInRTBeamsModule::Item::isValid ( ) const

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

Returns: OFTrue if item is valid, OFFalse otherwise

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

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

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

set AccessoryCode (300a,00f9)

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

set ApplicatorDescription (300a,010a)

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

set ApplicatorID (300a,0108)

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

set ApplicatorType (300a,0109)

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 DRTApplicatorSequenceInRTBeamsModule::Item::setSourceToApplicatorMountingPositionDistance	(	const Float32	value,
		const unsigned long	pos = `0`
	)

set SourceToApplicatorMountingPositionDistance (300a,0436)

Parameters

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=1

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

OFCondition DRTApplicatorSequenceInRTBeamsModule::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/drtas1.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation