Class representing a Dimension Index Pointer Sequence Item managed by the Multi-frame Dimension Module. More...

Inheritance diagram for IODMultiframeDimensionModule::DimensionIndexItem:

Public Member Functions
	DimensionIndexItem (OFshared_ptr< DcmItem > data, OFshared_ptr< IODRules > rules, IODComponent *parent)
	Constructor. More...

	DimensionIndexItem (IODComponent *parent=NULL)
	Constructor. More...

virtual	~DimensionIndexItem ()
	Destructor.

virtual OFString	getName () const
	Get name of module ("DimensionIndexSequence") More...

virtual void	resetRules ()
	Resets rules to their original values.

virtual OFCondition	getDimensionIndexPointer (DcmTagKey &value, const signed long pos=0) const
	Get Dimension Index Pointer. More...

virtual OFCondition	getDimensionIndexPrivateCreator (OFString &value, const signed long pos=0) const
	Get Dimension Index Private Creator. More...

virtual OFCondition	getFunctionalGroupPointer (DcmTagKey &value, const signed long pos=0) const
	Get Functional Group Pointer. More...

virtual OFCondition	getFunctionalGroupPrivateCreator (OFString &value, const signed long pos=0) const
	Get Functional Group Private Creator. More...

virtual OFCondition	getDimensionOrganizationUID (OFString &value, const signed long pos=0) const
	Get Dimension Organization UID. More...

virtual OFCondition	getDimensionDescriptionLabel (OFString &value, const signed long pos=0) const
	Get Dimension Description Label. More...

virtual OFCondition	setDimensionIndexPointer (const DcmTagKey &value, const OFBool checkValue=OFTrue)
	Set Dimension Index Pointer. More...

virtual OFCondition	setDimensionIndexPrivateCreator (const OFString &value, const OFBool checkValue=OFTrue)
	Set Dimension Index Private Creator. More...

virtual OFCondition	setFunctionalGroupPointer (const DcmTagKey &value, const OFBool checkValue=OFTrue)
	Set Dimension Index Functional Group Pointer. More...

virtual OFCondition	setFunctionalGroupPrivateCreator (const OFString &value, const OFBool checkValue=OFTrue)
	Set Dimension Index Functional Group Private Creator. More...

virtual OFCondition	setDimensionOrganizationUID (const OFString &value, const OFBool checkValue=OFTrue)
	Set Dimension Organization UID. More...

virtual OFCondition	setDimensionDescriptionLabel (const OFString &value, const OFBool checkValue=OFTrue)
	Set Dimension Description Label. More...

Public Member Functions inherited from IODComponent
	IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
	Constructor. More...

	IODComponent (IODComponent *parent=NULL)
	Constructor, creates rules and item from scratch. More...

IODComponent &	operator= (const IODComponent &rhs)
	Assignment operator, copies contained item and rule set from rhs to "this" attribute set. More...

	IODComponent (const IODComponent &rhs)
	Copy constructor, copies reference to contained item and rule set to "this" attribute set. More...

virtual	~IODComponent ()
	Virtual Destructor.

void	clearData ()
	Clear all attributes from the data that are handled by this module. More...

virtual void	inventMissing ()
	Set missing values by inventing "default values". More...

OFshared_ptr< IODRules >	getRules ()
	Get rules handled by this module. More...

virtual void	makeOptional ()
	Make component optional by turning all attributes requirement types of it to type 3. More...

DcmItem &	getData ()
	Get the data handled by this module. More...

virtual OFCondition	read (DcmItem &source, const OFBool clearOldData=OFTrue)
	Read attributes from given item into this class. More...

virtual OFCondition	write (DcmItem &destination)
	Write attributes from this class into given item. More...

virtual OFCondition	check (const OFBool quiet=OFFalse)
	Check whether this component's data satisfies the underlying rules. More...

virtual int	compare (const IODComponent &rhs) const
	Comparison operator for IOD Components. More...

Additional Inherited Members
Static Public Member Functions inherited from IODComponent
static OFCondition	read (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
	Static helper function that reads attributes from given item into destination item, as determined by the provided rules and component name. More...

static OFCondition	write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName)
	Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name. More...

Protected Attributes inherited from IODComponent
OFshared_ptr< DcmItem >	m_Item
	Shared pointer to the data handled by this class. More...

OFshared_ptr< IODRules >	m_Rules
	Rules describing the attributes governed by this class.

IODComponent *	m_Parent
	The parent component (may be NULL) of this class.

Detailed Description

Class representing a Dimension Index Pointer Sequence Item managed by the Multi-frame Dimension Module.

Constructor & Destructor Documentation

◆ DimensionIndexItem() [1/2]

IODMultiframeDimensionModule::DimensionIndexItem::DimensionIndexItem	(	OFshared_ptr< DcmItem >	data,
		OFshared_ptr< IODRules >	rules,
		IODComponent *	parent
	)

Constructor.

Parameters

data	The item to be used for data storage. If NULL, the class creates an empty data container.
rules	The rule set for this class. If NULL, the class creates one from scratch and adds its values.
parent	The parent of the IOD component (NULL if none or unknown)

◆ DimensionIndexItem() [2/2]

IODMultiframeDimensionModule::DimensionIndexItem::DimensionIndexItem ( IODComponent * parent = NULL )

Constructor.

Parameters

parent The parent of the IOD component (NULL if none or unknown)

Member Function Documentation

◆ getDimensionDescriptionLabel()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::getDimensionDescriptionLabel	(	OFString &	value,
		const signed long	pos = `0`
	)		const

virtual

Get Dimension Description Label.

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: EC_Normal if successful, an error code otherwise

◆ getDimensionIndexPointer()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::getDimensionIndexPointer	(	DcmTagKey &	value,
		const signed long	pos = `0`
	)		const

virtual

Get Dimension Index Pointer.

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: EC_Normal if successful, an error code otherwise

◆ getDimensionIndexPrivateCreator()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::getDimensionIndexPrivateCreator	(	OFString &	value,
		const signed long	pos = `0`
	)		const

virtual

Get Dimension Index Private Creator.

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: EC_Normal if successful, an error code otherwise

◆ getDimensionOrganizationUID()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::getDimensionOrganizationUID	(	OFString &	value,
		const signed long	pos = `0`
	)		const

virtual

Get Dimension Organization UID.

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: EC_Normal if successful, an error code otherwise

◆ getFunctionalGroupPointer()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::getFunctionalGroupPointer	(	DcmTagKey &	value,
		const signed long	pos = `0`
	)		const

virtual

Get Functional Group Pointer.

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: EC_Normal if successful, an error code otherwise

◆ getFunctionalGroupPrivateCreator()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::getFunctionalGroupPrivateCreator	(	OFString &	value,
		const signed long	pos = `0`
	)		const

virtual

Get Functional Group Private Creator.

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: EC_Normal if successful, an error code otherwise

◆ getName()

virtual OFString IODMultiframeDimensionModule::DimensionIndexItem::getName ( ) const

virtual

Get name of module ("DimensionIndexSequence")

Returns: Name of the module ("[parent.]DimensionIndexSequence")

Implements IODComponent.

◆ setDimensionDescriptionLabel()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::setDimensionDescriptionLabel	(	const OFString &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Dimension Description Label.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR and VM if enabled

Returns: status EC_Normal if successful, an error code otherwise

◆ setDimensionIndexPointer()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::setDimensionIndexPointer	(	const DcmTagKey &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Dimension Index Pointer.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value'. Not evaluated (here for consistency with other setter functions).

Returns: status EC_Normal if successful, an error code otherwise

◆ setDimensionIndexPrivateCreator()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::setDimensionIndexPrivateCreator	(	const OFString &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Dimension Index Private Creator.

Parameters

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

Returns: status EC_Normal if successful, an error code otherwise

◆ setDimensionOrganizationUID()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::setDimensionOrganizationUID	(	const OFString &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Dimension Organization UID.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value' for conformance with VR and VM if enabled

Returns: status EC_Normal if successful, an error code otherwise

◆ setFunctionalGroupPointer()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::setFunctionalGroupPointer	(	const DcmTagKey &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Dimension Index Functional Group Pointer.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value'. Not evaluated (here for consistency with other setter functions).

Returns: status EC_Normal if successful, an error code otherwise

◆ setFunctionalGroupPrivateCreator()

virtual OFCondition IODMultiframeDimensionModule::DimensionIndexItem::setFunctionalGroupPrivateCreator	(	const OFString &	value,
		const OFBool	checkValue = `OFTrue`
	)

virtual

Set Dimension Index Functional Group Private Creator.

Parameters

value	Value to be set (single value only) or "" for no value
checkValue	Check 'value. Not evaluated (here for consistency with other setter functions).

Returns: status EC_Normal if successful, an error code otherwise

The documentation for this class was generated from the following file:

dcmiod/include/dcmtk/dcmiod/modmultiframedimension.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DimensionIndexItem() [1/2]

◆ DimensionIndexItem() [2/2]

Member Function Documentation

◆ getDimensionDescriptionLabel()

◆ getDimensionIndexPointer()

◆ getDimensionIndexPrivateCreator()

◆ getDimensionOrganizationUID()

◆ getFunctionalGroupPointer()

◆ getFunctionalGroupPrivateCreator()

◆ getName()

◆ setDimensionDescriptionLabel()

◆ setDimensionIndexPointer()

◆ setDimensionIndexPrivateCreator()

◆ setDimensionOrganizationUID()

◆ setFunctionalGroupPointer()

◆ setFunctionalGroupPrivateCreator()