SOPInstanceReferenceMacro Class Reference

Class implementing the SOP Instance Reference Macro. More...

Inheritance diagram for SOPInstanceReferenceMacro:

Public Member Functions
	SOPInstanceReferenceMacro (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
	Constructor. More...
	SOPInstanceReferenceMacro (IODComponent *parent=NULL)
	Constructor. More...
virtual	~SOPInstanceReferenceMacro ()
	Virtual Destructor.
virtual void	resetRules ()
	Resets rules to their original values.
virtual OFString	getName () const
	Get name of macro. More...
virtual OFCondition	getReferencedSOPClassUID (OFString &value, const signed long pos=0)
	Get Referenced SOP Class UID. More...
virtual OFCondition	getReferencedSOPInstanceUID (OFString &value, const signed long pos=0)
	Get Referenced SOP Instance UID. More...
virtual OFCondition	setReferencedSOPClassUID (const OFString &value, const OFBool checkValue=OFTrue)
	Set Referenced SOP Class UID. More...
virtual OFCondition	setReferencedSOPInstanceUID (const OFString &value, const OFBool checkValue=OFTrue)
	Set Referenced SOP Instance UID. 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...
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 implementing the SOP Instance Reference Macro.

Constructor & Destructor Documentation

SOPInstanceReferenceMacro::SOPInstanceReferenceMacro	(	OFshared_ptr< DcmItem >	item,
		OFshared_ptr< IODRules >	rules,
		IODComponent *	parent = NULL
	)

Constructor.

Parameters

item	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)

SOPInstanceReferenceMacro::SOPInstanceReferenceMacro

(

IODComponent *

parent = NULL

)

Constructor.

Parameters

parent

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

Member Function Documentation

virtual OFString SOPInstanceReferenceMacro::getName ( ) const

virtual

Get name of macro.

Returns

Name of the module ("SOPInstanceReferenceMacro")

Implements IODComponent.

virtual OFCondition SOPInstanceReferenceMacro::getReferencedSOPClassUID ( OFString &  value, const signed long  pos = 0  )

virtual

Get Referenced SOP Class 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

virtual OFCondition SOPInstanceReferenceMacro::getReferencedSOPInstanceUID ( OFString &  value, const signed long  pos = 0  )

virtual

Get Referenced SOP Instance 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

virtual OFCondition SOPInstanceReferenceMacro::setReferencedSOPClassUID ( const OFString &  value, const OFBool  checkValue = OFTrue  )

virtual

Set Referenced SOP Class UID.

Parameters

value	The value to set
checkValue	If OFTrue, the value is checked regarding VM and VR

Returns

EC_Normal, if successful, error otherwise

virtual OFCondition SOPInstanceReferenceMacro::setReferencedSOPInstanceUID ( const OFString &  value, const OFBool  checkValue = OFTrue  )

virtual

Set Referenced SOP Instance UID.

Parameters

value	The value to set
checkValue	If OFTrue, the value is checked regarding VM and VR

Returns

EC_Normal, if successful, error otherwise

---

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

• dcmiod/include/dcmtk/dcmiod/iodmacro.h