IODAcquisitionContextModule Class Reference

Class representing the Acquisition Context Module. More...

Inheritance diagram for IODAcquisitionContextModule:

Public Member Functions
	IODAcquisitionContextModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
	Constructor. More...
	IODAcquisitionContextModule ()
	Constructor.
virtual	~IODAcquisitionContextModule ()
	Destructor.
virtual void	resetRules ()
	Resets rules to their original values.
virtual OFString	getName () const
	Get name of module ("AcquisitionContextModule") More...
Public Member Functions inherited from IODModule
	IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
	Constructor. More...
	IODModule ()
	Constructor. More...
	IODModule (const IODModule &rhs)
	Copy constructor, creates shallow copy. More...
IODModule &	operator= (const IODModule &rhs)
	Assignment operator, creates shallow copy. More...
	~IODModule ()
	Desctructor.
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...

Static Private Attributes
static const OFString	m_ModuleName
	The name of this module ("AcquisitionContextModule")

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 the Acquisition Context Module.

At the moment only an empty Acquisition Context Sequence is supported, so this class servers more as a placeholder at the moment.

Acquisition Context Sequence: (SQ, 1-n, 2)

Constructor & Destructor Documentation

IODAcquisitionContextModule::IODAcquisitionContextModule	(	OFshared_ptr< DcmItem >	item,
		OFshared_ptr< IODRules >	rules
	)

Constructor.

Parameters

item	The item to be used for data storage. If NULL, the class creates an empty data container.
rules	The rule set where this classes rules are added to. If NULL, the class creates an empty rule set.

Member Function Documentation

virtual OFString IODAcquisitionContextModule::getName ( ) const

virtual

Get name of module ("AcquisitionContextModule")

Returns

Name of the module ("AcquisitionContextModule")

Implements IODComponent.

---

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

• dcmiod/include/dcmtk/dcmiod/modacquisitioncontext.h