Inheritance diagram for DRTGeneralAccessorySequence::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	getGeneralAccessoryDescription (OFString &value, const signed long pos=0) const
	get GeneralAccessoryDescription (300a,0422) More...

OFCondition	getGeneralAccessoryID (OFString &value, const signed long pos=0) const
	get GeneralAccessoryID (300a,0421) More...

OFCondition	getGeneralAccessoryNumber (OFString &value, const signed long pos=0) const
	get GeneralAccessoryNumber (300a,0424) More...

OFCondition	getGeneralAccessoryNumber (Sint32 &value, const unsigned long pos=0) const
	get GeneralAccessoryNumber (300a,0424) More...

OFCondition	getGeneralAccessoryType (OFString &value, const signed long pos=0) const
	get GeneralAccessoryType (300a,0423) More...

OFCondition	getSourceToGeneralAccessoryDistance (Float32 &value, const unsigned long pos=0) const
	get SourceToGeneralAccessoryDistance (300a,0425) More...

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

OFCondition	setGeneralAccessoryDescription (const OFString &value, const OFBool check=OFTrue)
	set GeneralAccessoryDescription (300a,0422) More...

OFCondition	setGeneralAccessoryID (const OFString &value, const OFBool check=OFTrue)
	set GeneralAccessoryID (300a,0421) More...

OFCondition	setGeneralAccessoryNumber (const OFString &value, const OFBool check=OFTrue)
	set GeneralAccessoryNumber (300a,0424) More...

OFCondition	setGeneralAccessoryType (const OFString &value, const OFBool check=OFTrue)
	set GeneralAccessoryType (300a,0423) More...

OFCondition	setSourceToGeneralAccessoryDistance (const Float32 value, const unsigned long pos=0)
	set SourceToGeneralAccessoryDistance (300a,0425) 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.

DcmShortText	GeneralAccessoryDescription
	GeneralAccessoryDescription (300a,0422) vr=ST, vm=1, type=3.

DcmShortString	GeneralAccessoryID
	GeneralAccessoryID (300a,0421) vr=SH, vm=1, type=1.

DcmIntegerString	GeneralAccessoryNumber
	GeneralAccessoryNumber (300a,0424) vr=IS, vm=1, type=1.

DcmCodeString	GeneralAccessoryType
	GeneralAccessoryType (300a,0423) vr=CS, vm=1, type=3.

DcmFloatingPointSingle	SourceToGeneralAccessoryDistance
	SourceToGeneralAccessoryDistance (300a,0425) 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

◆ Item() [1/2]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTGeneralAccessorySequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getAccessoryCode()

OFCondition DRTGeneralAccessorySequence::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

◆ getGeneralAccessoryDescription()

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

get GeneralAccessoryDescription (300a,0422)

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

◆ getGeneralAccessoryID()

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

get GeneralAccessoryID (300a,0421)

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

◆ getGeneralAccessoryNumber() [1/2]

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

get GeneralAccessoryNumber (300a,0424)

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

◆ getGeneralAccessoryNumber() [2/2]

OFCondition DRTGeneralAccessorySequence::Item::getGeneralAccessoryNumber	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get GeneralAccessoryNumber (300a,0424)

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

◆ getGeneralAccessoryType()

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

get GeneralAccessoryType (300a,0423)

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

◆ getSourceToGeneralAccessoryDistance()

OFCondition DRTGeneralAccessorySequence::Item::getSourceToGeneralAccessoryDistance	(	Float32 &	value,
		const unsigned long	pos = `0`
	)		const

get SourceToGeneralAccessoryDistance (300a,0425)

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

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTGeneralAccessorySequence::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& DRTGeneralAccessorySequence::Item::operator= ( const Item & copy )

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

OFCondition DRTGeneralAccessorySequence::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

◆ setAccessoryCode()

OFCondition DRTGeneralAccessorySequence::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

◆ setGeneralAccessoryDescription()

OFCondition DRTGeneralAccessorySequence::Item::setGeneralAccessoryDescription	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set GeneralAccessoryDescription (300a,0422)

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

◆ setGeneralAccessoryID()

OFCondition DRTGeneralAccessorySequence::Item::setGeneralAccessoryID	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set GeneralAccessoryID (300a,0421)

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

◆ setGeneralAccessoryNumber()

OFCondition DRTGeneralAccessorySequence::Item::setGeneralAccessoryNumber	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set GeneralAccessoryNumber (300a,0424)

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

◆ setGeneralAccessoryType()

OFCondition DRTGeneralAccessorySequence::Item::setGeneralAccessoryType	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set GeneralAccessoryType (300a,0423)

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

◆ setSourceToGeneralAccessoryDistance()

OFCondition DRTGeneralAccessorySequence::Item::setSourceToGeneralAccessoryDistance	(	const Float32	value,
		const unsigned long	pos = `0`
	)

set SourceToGeneralAccessoryDistance (300a,0425)

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

◆ write()

OFCondition DRTGeneralAccessorySequence::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/drtgas.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getAccessoryCode()

◆ getGeneralAccessoryDescription()

◆ getGeneralAccessoryID()

◆ getGeneralAccessoryNumber() [1/2]

◆ getGeneralAccessoryNumber() [2/2]

◆ getGeneralAccessoryType()

◆ getSourceToGeneralAccessoryDistance()

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setAccessoryCode()

◆ setGeneralAccessoryDescription()

◆ setGeneralAccessoryID()

◆ setGeneralAccessoryNumber()

◆ setGeneralAccessoryType()

◆ setSourceToGeneralAccessoryDistance()

◆ write()