Inheritance diagram for DRTFrameExtractionSequence::Item:

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor

	Item (const Item &copy)
	copy constructor

virtual	~Item ()
	destructor

Item &	operator= (const Item &copy)
	assignment operator

void	clear ()
	clear all internal member variables

OFBool	isEmpty ()
	check if item is empty

OFBool	isValid () const
	check if item is valid, i.e. not the empty default item

OFCondition	read (DcmItem &item)
	read elements from sequence item

OFCondition	write (DcmItem &item)
	write elements to sequence item

OFCondition	getCalculatedFrameList (Uint32 &value, const unsigned long pos=0) const
	get CalculatedFrameList (0008,1162)

OFCondition	getMultiFrameSourceSOPInstanceUID (OFString &value, const signed long pos=0) const
	get MultiFrameSourceSOPInstanceUID (0008,1167)

OFCondition	getSimpleFrameList (Uint32 &value, const unsigned long pos=0) const
	get SimpleFrameList (0008,1161)

OFCondition	getTimeRange (Float64 &value, const unsigned long pos=0) const
	get TimeRange (0008,1163)

OFCondition	setCalculatedFrameList (const Uint32 value, const unsigned long pos=0)
	set CalculatedFrameList (0008,1162)

OFCondition	setMultiFrameSourceSOPInstanceUID (const OFString &value, const OFBool check=OFTrue)
	set MultiFrameSourceSOPInstanceUID (0008,1167)

OFCondition	setSimpleFrameList (const Uint32 value, const unsigned long pos=0)
	set SimpleFrameList (0008,1161)

OFCondition	setTimeRange (const Float64 value, const unsigned long pos=0)
	set TimeRange (0008,1163)

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

DcmUnsignedLong	CalculatedFrameList
	CalculatedFrameList (0008,1162) vr=UL, vm=3-3n, type=1C.

DcmUniqueIdentifier	MultiFrameSourceSOPInstanceUID
	MultiFrameSourceSOPInstanceUID (0008,1167) vr=UI, vm=1, type=1.

DcmUnsignedLong	SimpleFrameList
	SimpleFrameList (0008,1161) vr=UL, vm=1-n, type=1C.

DcmFloatingPointDouble	TimeRange
	TimeRange (0008,1163) vr=FD, vm=2, type=1C.

Additional Inherited Members
Protected Member Functions inherited from DRTTypes
virtual	~DRTTypes ()
	destructor.

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.

static OFCondition	getElementFromDataset (DcmItem &dataset, DcmElement &element)
	get element from dataset

static OFCondition	getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
	get string value from element

static OFCondition	getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
	get string value from dataset

static OFCondition	putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
	put string value to dataset

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

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.

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.

Detailed Description

Item class.

Constructor & Destructor Documentation

◆ Item() [1/2]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTFrameExtractionSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getCalculatedFrameList()

OFCondition DRTFrameExtractionSequence::Item::getCalculatedFrameList	(	Uint32 &	value,
		const unsigned long	pos = `0`
	)		const

get CalculatedFrameList (0008,1162)

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

◆ getMultiFrameSourceSOPInstanceUID()

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

get MultiFrameSourceSOPInstanceUID (0008,1167)

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

◆ getSimpleFrameList()

OFCondition DRTFrameExtractionSequence::Item::getSimpleFrameList	(	Uint32 &	value,
		const unsigned long	pos = `0`
	)		const

get SimpleFrameList (0008,1161)

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

◆ getTimeRange()

OFCondition DRTFrameExtractionSequence::Item::getTimeRange	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get TimeRange (0008,1163)

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

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

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

assignment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

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

◆ setCalculatedFrameList()

OFCondition DRTFrameExtractionSequence::Item::setCalculatedFrameList	(	const Uint32	value,
		const unsigned long	pos = `0`
	)

set CalculatedFrameList (0008,1162)

Parameters

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

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

◆ setMultiFrameSourceSOPInstanceUID()

OFCondition DRTFrameExtractionSequence::Item::setMultiFrameSourceSOPInstanceUID	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set MultiFrameSourceSOPInstanceUID (0008,1167)

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

◆ setSimpleFrameList()

OFCondition DRTFrameExtractionSequence::Item::setSimpleFrameList	(	const Uint32	value,
		const unsigned long	pos = `0`
	)

set SimpleFrameList (0008,1161)

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

◆ setTimeRange()

OFCondition DRTFrameExtractionSequence::Item::setTimeRange	(	const Float64	value,
		const unsigned long	pos = `0`
	)

set TimeRange (0008,1163)

Parameters

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

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

◆ write()

OFCondition DRTFrameExtractionSequence::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/drtfes.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getCalculatedFrameList()

◆ getMultiFrameSourceSOPInstanceUID()

◆ getSimpleFrameList()

◆ getTimeRange()

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setCalculatedFrameList()

◆ setMultiFrameSourceSOPInstanceUID()

◆ setSimpleFrameList()

◆ setTimeRange()

◆ write()