DRTCodingSchemeIdentificationSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTCodingSchemeIdentificationSequence::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	getCodingSchemeDesignator (OFString &value, const signed long pos=0) const
	get CodingSchemeDesignator (0008,0102) More...
OFCondition	getCodingSchemeExternalID (OFString &value, const signed long pos=0) const
	get CodingSchemeExternalID (0008,0114) More...
OFCondition	getCodingSchemeName (OFString &value, const signed long pos=0) const
	get CodingSchemeName (0008,0115) More...
OFCondition	getCodingSchemeRegistry (OFString &value, const signed long pos=0) const
	get CodingSchemeRegistry (0008,0112) More...
OFCondition	getCodingSchemeResponsibleOrganization (OFString &value, const signed long pos=0) const
	get CodingSchemeResponsibleOrganization (0008,0116) More...
OFCondition	getCodingSchemeUID (OFString &value, const signed long pos=0) const
	get CodingSchemeUID (0008,010c) More...
OFCondition	getCodingSchemeVersion (OFString &value, const signed long pos=0) const
	get CodingSchemeVersion (0008,0103) More...
OFCondition	setCodingSchemeDesignator (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeDesignator (0008,0102) More...
OFCondition	setCodingSchemeExternalID (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeExternalID (0008,0114) More...
OFCondition	setCodingSchemeName (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeName (0008,0115) More...
OFCondition	setCodingSchemeRegistry (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeRegistry (0008,0112) More...
OFCondition	setCodingSchemeResponsibleOrganization (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeResponsibleOrganization (0008,0116) More...
OFCondition	setCodingSchemeUID (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeUID (0008,010c) More...
OFCondition	setCodingSchemeVersion (const OFString &value, const OFBool check=OFTrue)
	set CodingSchemeVersion (0008,0103) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmShortString	CodingSchemeDesignator
	CodingSchemeDesignator (0008,0102) vr=SH, vm=1, type=1.
DcmShortText	CodingSchemeExternalID
	CodingSchemeExternalID (0008,0114) vr=ST, vm=1, type=2C.
DcmShortText	CodingSchemeName
	CodingSchemeName (0008,0115) vr=ST, vm=1, type=3.
DcmLongString	CodingSchemeRegistry
	CodingSchemeRegistry (0008,0112) vr=LO, vm=1, type=1C.
DcmShortText	CodingSchemeResponsibleOrganization
	CodingSchemeResponsibleOrganization (0008,0116) vr=ST, vm=1, type=3.
DcmUniqueIdentifier	CodingSchemeUID
	CodingSchemeUID (0008,010c) vr=UI, vm=1, type=1C.
DcmShortString	CodingSchemeVersion
	CodingSchemeVersion (0008,0103) vr=SH, 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

DRTCodingSchemeIdentificationSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters

emptyDefaultItem

flag used to mark the empty default item

DRTCodingSchemeIdentificationSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

OFCondition DRTCodingSchemeIdentificationSequence::Item::getCodingSchemeDesignator	(	OFString &	value,
		const signed long	pos = 0
	)		const

get CodingSchemeDesignator (0008,0102)

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

get CodingSchemeExternalID (0008,0114)

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

get CodingSchemeName (0008,0115)

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

get CodingSchemeRegistry (0008,0112)

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

get CodingSchemeResponsibleOrganization (0008,0116)

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

get CodingSchemeUID (0008,010c)

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

get CodingSchemeVersion (0008,0103)

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

(

)

check if item is empty

Returns

OFTrue if item is empty, OFFalse otherwise

OFBool DRTCodingSchemeIdentificationSequence::Item::isValid

(

)

const

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

Returns

OFTrue if item is valid, OFFalse otherwise

Item& DRTCodingSchemeIdentificationSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters

copy	item object to be copied

Returns

reference to this object

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

set CodingSchemeDesignator (0008,0102)

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

set CodingSchemeExternalID (0008,0114)

Parameters

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

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTCodingSchemeIdentificationSequence::Item::setCodingSchemeName	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set CodingSchemeName (0008,0115)

Parameters

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

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTCodingSchemeIdentificationSequence::Item::setCodingSchemeRegistry	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set CodingSchemeRegistry (0008,0112)

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

set CodingSchemeResponsibleOrganization (0008,0116)

Parameters

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

Returns

status, EC_Normal if successful, an error code otherwise

OFCondition DRTCodingSchemeIdentificationSequence::Item::setCodingSchemeUID	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set CodingSchemeUID (0008,010c)

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

set CodingSchemeVersion (0008,0103)

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 DRTCodingSchemeIdentificationSequence::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/drtcsis.h