DRTProtocolContextSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTProtocolContextSequence::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	getDate (OFString &value, const signed long pos=0) const
	get Date (0040,a121) More...
OFCondition	getDateTime (OFString &value, const signed long pos=0) const
	get DateTime (0040,a120) More...
OFCondition	getFloatingPointValue (Float64 &value, const unsigned long pos=0) const
	get FloatingPointValue (0040,a161) More...
OFCondition	getNumericValue (OFString &value, const signed long pos=0) const
	get NumericValue (0040,a30a) More...
OFCondition	getNumericValue (Float64 &value, const unsigned long pos=0) const
	get NumericValue (0040,a30a) More...
OFCondition	getNumericValue (OFVector< Float64 > &value) const
	get NumericValue (0040,a30a) More...
OFCondition	getPersonName (OFString &value, const signed long pos=0) const
	get PersonName (0040,a123) More...
OFCondition	getRationalDenominatorValue (Uint32 &value, const unsigned long pos=0) const
	get RationalDenominatorValue (0040,a163) More...
OFCondition	getRationalNumeratorValue (Sint32 &value, const unsigned long pos=0) const
	get RationalNumeratorValue (0040,a162) More...
OFCondition	getTextValue (OFString &value, const signed long pos=0) const
	get TextValue (0040,a160) More...
OFCondition	getTime (OFString &value, const signed long pos=0) const
	get Time (0040,a122) More...
OFCondition	getUID (OFString &value, const signed long pos=0) const
	get UID (0040,a124) More...
OFCondition	getValueType (OFString &value, const signed long pos=0) const
	get ValueType (0040,a040) More...
DRTConceptCodeSequence &	getConceptCodeSequence ()
	get ConceptCodeSequence (0040,a168) More...
const DRTConceptCodeSequence &	getConceptCodeSequence () const
	get ConceptCodeSequence (0040,a168) More...
DRTConceptNameCodeSequence &	getConceptNameCodeSequence ()
	get ConceptNameCodeSequence (0040,a043) More...
const DRTConceptNameCodeSequence &	getConceptNameCodeSequence () const
	get ConceptNameCodeSequence (0040,a043) More...
DRTContentItemModifierSequence &	getContentItemModifierSequence ()
	get ContentItemModifierSequence (0040,0441) More...
const DRTContentItemModifierSequence &	getContentItemModifierSequence () const
	get ContentItemModifierSequence (0040,0441) More...
DRTMeasurementUnitsCodeSequence &	getMeasurementUnitsCodeSequence ()
	get MeasurementUnitsCodeSequence (0040,08ea) More...
const DRTMeasurementUnitsCodeSequence &	getMeasurementUnitsCodeSequence () const
	get MeasurementUnitsCodeSequence (0040,08ea) More...
DRTReferencedSOPSequence &	getReferencedSOPSequence ()
	get ReferencedSOPSequence (0008,1199) More...
const DRTReferencedSOPSequence &	getReferencedSOPSequence () const
	get ReferencedSOPSequence (0008,1199) More...
OFCondition	setDate (const OFString &value, const OFBool check=OFTrue)
	set Date (0040,a121) More...
OFCondition	setDateTime (const OFString &value, const OFBool check=OFTrue)
	set DateTime (0040,a120) More...
OFCondition	setFloatingPointValue (const Float64 value, const unsigned long pos=0)
	set FloatingPointValue (0040,a161) More...
OFCondition	setNumericValue (const OFString &value, const OFBool check=OFTrue)
	set NumericValue (0040,a30a) More...
OFCondition	setPersonName (const OFString &value, const OFBool check=OFTrue)
	set PersonName (0040,a123) More...
OFCondition	setRationalDenominatorValue (const Uint32 value, const unsigned long pos=0)
	set RationalDenominatorValue (0040,a163) More...
OFCondition	setRationalNumeratorValue (const Sint32 value, const unsigned long pos=0)
	set RationalNumeratorValue (0040,a162) More...
OFCondition	setTextValue (const OFString &value, const OFBool check=OFTrue)
	set TextValue (0040,a160) More...
OFCondition	setTime (const OFString &value, const OFBool check=OFTrue)
	set Time (0040,a122) More...
OFCondition	setUID (const OFString &value, const OFBool check=OFTrue)
	set UID (0040,a124) More...
OFCondition	setValueType (const OFString &value, const OFBool check=OFTrue)
	set ValueType (0040,a040) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DRTConceptCodeSequence	ConceptCodeSequence
	ConceptCodeSequence (0040,a168) vr=SQ, vm=1, type=1C.
DRTConceptNameCodeSequence	ConceptNameCodeSequence
	ConceptNameCodeSequence (0040,a043) vr=SQ, vm=1, type=1.
DRTContentItemModifierSequence	ContentItemModifierSequence
	ContentItemModifierSequence (0040,0441) vr=SQ, vm=1, type=3.
DcmDate	Date
	Date (0040,a121) vr=DA, vm=1, type=1C.
DcmDateTime	DateTime
	DateTime (0040,a120) vr=DT, vm=1, type=1C.
DcmFloatingPointDouble	FloatingPointValue
	FloatingPointValue (0040,a161) vr=FD, vm=1-n, type=1C.
DRTMeasurementUnitsCodeSequence	MeasurementUnitsCodeSequence
	MeasurementUnitsCodeSequence (0040,08ea) vr=SQ, vm=1, type=1C.
DcmDecimalString	NumericValue
	NumericValue (0040,a30a) vr=DS, vm=1-n, type=1C.
DcmPersonName	PersonName
	PersonName (0040,a123) vr=PN, vm=1, type=1C.
DcmUnsignedLong	RationalDenominatorValue
	RationalDenominatorValue (0040,a163) vr=UL, vm=1-n, type=1C.
DcmSignedLong	RationalNumeratorValue
	RationalNumeratorValue (0040,a162) vr=SL, vm=1-n, type=1C.
DRTReferencedSOPSequence	ReferencedSOPSequence
	ReferencedSOPSequence (0008,1199) vr=SQ, vm=1, type=1C.
DcmUnlimitedText	TextValue
	TextValue (0040,a160) vr=UT, vm=1, type=1C.
DcmTime	Time
	Time (0040,a122) vr=TM, vm=1, type=1C.
DcmUniqueIdentifier	UID
	UID (0040,a124) vr=UI, vm=1, type=1C.
DcmCodeString	ValueType
	ValueType (0040,a040) vr=CS, vm=1, type=1.

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

DRTProtocolContextSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters

emptyDefaultItem

flag used to mark the empty default item

DRTProtocolContextSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

DRTConceptCodeSequence& DRTProtocolContextSequence::Item::getConceptCodeSequence ( )

inline

get ConceptCodeSequence (0040,a168)

Returns

reference to sequence element

const DRTConceptCodeSequence& DRTProtocolContextSequence::Item::getConceptCodeSequence ( ) const

inline

get ConceptCodeSequence (0040,a168)

Returns

const reference to sequence element

DRTConceptNameCodeSequence& DRTProtocolContextSequence::Item::getConceptNameCodeSequence ( )

inline

get ConceptNameCodeSequence (0040,a043)

Returns

reference to sequence element

const DRTConceptNameCodeSequence& DRTProtocolContextSequence::Item::getConceptNameCodeSequence ( ) const

inline

get ConceptNameCodeSequence (0040,a043)

Returns

const reference to sequence element

DRTContentItemModifierSequence& DRTProtocolContextSequence::Item::getContentItemModifierSequence ( )

inline

get ContentItemModifierSequence (0040,0441)

Returns

reference to sequence element

const DRTContentItemModifierSequence& DRTProtocolContextSequence::Item::getContentItemModifierSequence ( ) const

inline

get ContentItemModifierSequence (0040,0441)

Returns

const reference to sequence element

OFCondition DRTProtocolContextSequence::Item::getDate	(	OFString &	value,
		const signed long	pos = 0
	)		const

get Date (0040,a121)

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

get DateTime (0040,a120)

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

get FloatingPointValue (0040,a161)

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

DRTMeasurementUnitsCodeSequence& DRTProtocolContextSequence::Item::getMeasurementUnitsCodeSequence ( )

inline

get MeasurementUnitsCodeSequence (0040,08ea)

Returns

reference to sequence element

const DRTMeasurementUnitsCodeSequence& DRTProtocolContextSequence::Item::getMeasurementUnitsCodeSequence ( ) const

inline

get MeasurementUnitsCodeSequence (0040,08ea)

Returns

const reference to sequence element

OFCondition DRTProtocolContextSequence::Item::getNumericValue	(	OFString &	value,
		const signed long	pos = 0
	)		const

get NumericValue (0040,a30a)

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

get NumericValue (0040,a30a)

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 DRTProtocolContextSequence::Item::getNumericValue

(

OFVector< Float64 > &

value

)

const

get NumericValue (0040,a30a)

Parameters

value

reference to variable in which the value(s) should be stored

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::getPersonName	(	OFString &	value,
		const signed long	pos = 0
	)		const

get PersonName (0040,a123)

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 DRTProtocolContextSequence::Item::getRationalDenominatorValue	(	Uint32 &	value,
		const unsigned long	pos = 0
	)		const

get RationalDenominatorValue (0040,a163)

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

get RationalNumeratorValue (0040,a162)

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

DRTReferencedSOPSequence& DRTProtocolContextSequence::Item::getReferencedSOPSequence ( )

inline

get ReferencedSOPSequence (0008,1199)

Returns

reference to sequence element

const DRTReferencedSOPSequence& DRTProtocolContextSequence::Item::getReferencedSOPSequence ( ) const

inline

get ReferencedSOPSequence (0008,1199)

Returns

const reference to sequence element

OFCondition DRTProtocolContextSequence::Item::getTextValue	(	OFString &	value,
		const signed long	pos = 0
	)		const

get TextValue (0040,a160)

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

get Time (0040,a122)

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

get UID (0040,a124)

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

get ValueType (0040,a040)

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

(

)

check if item is empty

Returns

OFTrue if item is empty, OFFalse otherwise

OFBool DRTProtocolContextSequence::Item::isValid

(

)

const

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

Returns

OFTrue if item is valid, OFFalse otherwise

Item& DRTProtocolContextSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters

copy	item object to be copied

Returns

reference to this object

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

set Date (0040,a121)

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

set DateTime (0040,a120)

Parameters

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

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::setFloatingPointValue	(	const Float64	value,
		const unsigned long	pos = 0
	)

set FloatingPointValue (0040,a161)

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-n

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::setNumericValue	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set NumericValue (0040,a30a)

Parameters

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (1-n) if enabled

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::setPersonName	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set PersonName (0040,a123)

Parameters

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

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::setRationalDenominatorValue	(	const Uint32	value,
		const unsigned long	pos = 0
	)

set RationalDenominatorValue (0040,a163)

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-n

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::setRationalNumeratorValue	(	const Sint32	value,
		const unsigned long	pos = 0
	)

set RationalNumeratorValue (0040,a162)

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-n

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::setTextValue	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set TextValue (0040,a160)

Parameters

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

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTProtocolContextSequence::Item::setTime	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set Time (0040,a122)

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

set UID (0040,a124)

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

set ValueType (0040,a040)

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 DRTProtocolContextSequence::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/drtpcxs.h