DRTRequestAttributesSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTRequestAttributesSequence::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	getAccessionNumber (OFString &value, const signed long pos=0) const
	get AccessionNumber (0008,0050) More...
OFCondition	getReasonForTheRequestedProcedure (OFString &value, const signed long pos=0) const
	get ReasonForTheRequestedProcedure (0040,1002) More...
OFCondition	getRequestedProcedureDescription (OFString &value, const signed long pos=0) const
	get RequestedProcedureDescription (0032,1060) More...
OFCondition	getRequestedProcedureID (OFString &value, const signed long pos=0) const
	get RequestedProcedureID (0040,1001) More...
OFCondition	getScheduledProcedureStepDescription (OFString &value, const signed long pos=0) const
	get ScheduledProcedureStepDescription (0040,0007) More...
OFCondition	getScheduledProcedureStepID (OFString &value, const signed long pos=0) const
	get ScheduledProcedureStepID (0040,0009) More...
OFCondition	getStudyInstanceUID (OFString &value, const signed long pos=0) const
	get StudyInstanceUID (0020,000d) More...
DRTIssuerOfAccessionNumberSequence &	getIssuerOfAccessionNumberSequence ()
	get IssuerOfAccessionNumberSequence (0008,0051) More...
const DRTIssuerOfAccessionNumberSequence &	getIssuerOfAccessionNumberSequence () const
	get IssuerOfAccessionNumberSequence (0008,0051) More...
DRTReasonForRequestedProcedureCodeSequence &	getReasonForRequestedProcedureCodeSequence ()
	get ReasonForRequestedProcedureCodeSequence (0040,100a) More...
const DRTReasonForRequestedProcedureCodeSequence &	getReasonForRequestedProcedureCodeSequence () const
	get ReasonForRequestedProcedureCodeSequence (0040,100a) More...
DRTReferencedStudySequence &	getReferencedStudySequence ()
	get ReferencedStudySequence (0008,1110) More...
const DRTReferencedStudySequence &	getReferencedStudySequence () const
	get ReferencedStudySequence (0008,1110) More...
DRTRequestedProcedureCodeSequence &	getRequestedProcedureCodeSequence ()
	get RequestedProcedureCodeSequence (0032,1064) More...
const DRTRequestedProcedureCodeSequence &	getRequestedProcedureCodeSequence () const
	get RequestedProcedureCodeSequence (0032,1064) More...
DRTScheduledProtocolCodeSequence &	getScheduledProtocolCodeSequence ()
	get ScheduledProtocolCodeSequence (0040,0008) More...
const DRTScheduledProtocolCodeSequence &	getScheduledProtocolCodeSequence () const
	get ScheduledProtocolCodeSequence (0040,0008) More...
OFCondition	setAccessionNumber (const OFString &value, const OFBool check=OFTrue)
	set AccessionNumber (0008,0050) More...
OFCondition	setReasonForTheRequestedProcedure (const OFString &value, const OFBool check=OFTrue)
	set ReasonForTheRequestedProcedure (0040,1002) More...
OFCondition	setRequestedProcedureDescription (const OFString &value, const OFBool check=OFTrue)
	set RequestedProcedureDescription (0032,1060) More...
OFCondition	setRequestedProcedureID (const OFString &value, const OFBool check=OFTrue)
	set RequestedProcedureID (0040,1001) More...
OFCondition	setScheduledProcedureStepDescription (const OFString &value, const OFBool check=OFTrue)
	set ScheduledProcedureStepDescription (0040,0007) More...
OFCondition	setScheduledProcedureStepID (const OFString &value, const OFBool check=OFTrue)
	set ScheduledProcedureStepID (0040,0009) More...
OFCondition	setStudyInstanceUID (const OFString &value, const OFBool check=OFTrue)
	set StudyInstanceUID (0020,000d) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmShortString	AccessionNumber
	AccessionNumber (0008,0050) vr=SH, vm=1, type=3.
DRTIssuerOfAccessionNumberSequence	IssuerOfAccessionNumberSequence
	IssuerOfAccessionNumberSequence (0008,0051) vr=SQ, vm=1, type=3.
DRTReasonForRequestedProcedureCodeSequence	ReasonForRequestedProcedureCodeSequence
	ReasonForRequestedProcedureCodeSequence (0040,100a) vr=SQ, vm=1, type=3.
DcmLongString	ReasonForTheRequestedProcedure
	ReasonForTheRequestedProcedure (0040,1002) vr=LO, vm=1, type=3.
DRTReferencedStudySequence	ReferencedStudySequence
	ReferencedStudySequence (0008,1110) vr=SQ, vm=1, type=3.
DRTRequestedProcedureCodeSequence	RequestedProcedureCodeSequence
	RequestedProcedureCodeSequence (0032,1064) vr=SQ, vm=1, type=3.
DcmLongString	RequestedProcedureDescription
	RequestedProcedureDescription (0032,1060) vr=LO, vm=1, type=3.
DcmShortString	RequestedProcedureID
	RequestedProcedureID (0040,1001) vr=SH, vm=1, type=1C.
DcmLongString	ScheduledProcedureStepDescription
	ScheduledProcedureStepDescription (0040,0007) vr=LO, vm=1, type=3.
DcmShortString	ScheduledProcedureStepID
	ScheduledProcedureStepID (0040,0009) vr=SH, vm=1, type=1C.
DRTScheduledProtocolCodeSequence	ScheduledProtocolCodeSequence
	ScheduledProtocolCodeSequence (0040,0008) vr=SQ, vm=1, type=3.
DcmUniqueIdentifier	StudyInstanceUID
	StudyInstanceUID (0020,000d) vr=UI, 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

DRTRequestAttributesSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters

emptyDefaultItem

flag used to mark the empty default item

DRTRequestAttributesSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

OFCondition DRTRequestAttributesSequence::Item::getAccessionNumber	(	OFString &	value,
		const signed long	pos = 0
	)		const

get AccessionNumber (0008,0050)

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

DRTIssuerOfAccessionNumberSequence& DRTRequestAttributesSequence::Item::getIssuerOfAccessionNumberSequence ( )

inline

get IssuerOfAccessionNumberSequence (0008,0051)

Returns

reference to sequence element

const DRTIssuerOfAccessionNumberSequence& DRTRequestAttributesSequence::Item::getIssuerOfAccessionNumberSequence ( ) const

inline

get IssuerOfAccessionNumberSequence (0008,0051)

Returns

const reference to sequence element

DRTReasonForRequestedProcedureCodeSequence& DRTRequestAttributesSequence::Item::getReasonForRequestedProcedureCodeSequence ( )

inline

get ReasonForRequestedProcedureCodeSequence (0040,100a)

Returns

reference to sequence element

const DRTReasonForRequestedProcedureCodeSequence& DRTRequestAttributesSequence::Item::getReasonForRequestedProcedureCodeSequence ( ) const

inline

get ReasonForRequestedProcedureCodeSequence (0040,100a)

Returns

const reference to sequence element

OFCondition DRTRequestAttributesSequence::Item::getReasonForTheRequestedProcedure	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ReasonForTheRequestedProcedure (0040,1002)

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

DRTReferencedStudySequence& DRTRequestAttributesSequence::Item::getReferencedStudySequence ( )

inline

get ReferencedStudySequence (0008,1110)

Returns

reference to sequence element

const DRTReferencedStudySequence& DRTRequestAttributesSequence::Item::getReferencedStudySequence ( ) const

inline

get ReferencedStudySequence (0008,1110)

Returns

const reference to sequence element

DRTRequestedProcedureCodeSequence& DRTRequestAttributesSequence::Item::getRequestedProcedureCodeSequence ( )

inline

get RequestedProcedureCodeSequence (0032,1064)

Returns

reference to sequence element

const DRTRequestedProcedureCodeSequence& DRTRequestAttributesSequence::Item::getRequestedProcedureCodeSequence ( ) const

inline

get RequestedProcedureCodeSequence (0032,1064)

Returns

const reference to sequence element

OFCondition DRTRequestAttributesSequence::Item::getRequestedProcedureDescription	(	OFString &	value,
		const signed long	pos = 0
	)		const

get RequestedProcedureDescription (0032,1060)

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

get RequestedProcedureID (0040,1001)

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

get ScheduledProcedureStepDescription (0040,0007)

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

get ScheduledProcedureStepID (0040,0009)

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

DRTScheduledProtocolCodeSequence& DRTRequestAttributesSequence::Item::getScheduledProtocolCodeSequence ( )

inline

get ScheduledProtocolCodeSequence (0040,0008)

Returns

reference to sequence element

const DRTScheduledProtocolCodeSequence& DRTRequestAttributesSequence::Item::getScheduledProtocolCodeSequence ( ) const

inline

get ScheduledProtocolCodeSequence (0040,0008)

Returns

const reference to sequence element

OFCondition DRTRequestAttributesSequence::Item::getStudyInstanceUID	(	OFString &	value,
		const signed long	pos = 0
	)		const

get StudyInstanceUID (0020,000d)

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

(

)

check if item is empty

Returns

OFTrue if item is empty, OFFalse otherwise

OFBool DRTRequestAttributesSequence::Item::isValid

(

)

const

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

Returns

OFTrue if item is valid, OFFalse otherwise

Item& DRTRequestAttributesSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters

copy	item object to be copied

Returns

reference to this object

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

set AccessionNumber (0008,0050)

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

set ReasonForTheRequestedProcedure (0040,1002)

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

set RequestedProcedureDescription (0032,1060)

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

set RequestedProcedureID (0040,1001)

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

set ScheduledProcedureStepDescription (0040,0007)

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

set ScheduledProcedureStepID (0040,0009)

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

set StudyInstanceUID (0020,000d)

Parameters

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

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTRequestAttributesSequence::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/drtras.h