DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
IODCommonInstanceReferenceModule Class Reference

Class representing the Common Instance Reference Module: More...

+ Inheritance diagram for IODCommonInstanceReferenceModule:

Public Member Functions

 IODCommonInstanceReferenceModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
 Constructor. More...
 
 IODCommonInstanceReferenceModule ()
 Constructor.
 
virtual void clearData ()
 Clears all data belonging to this module (rules are kept)
 
virtual ~IODCommonInstanceReferenceModule ()
 Destructor.
 
virtual size_t addReferences (const IODReferences &references, const OFString &studyInstanceUID, const OFBool clearOldData=OFTrue)
 Add references. More...
 
virtual OFCondition read (DcmItem &source, const OFBool clearOldData=OFTrue)
 Read data of this module from given source item. More...
 
virtual OFCondition write (DcmItem &destination)
 Write data of this module into given destination item. More...
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of module ("CommonInstanceReferenceModule") More...
 
OFVector
< IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem * > & 
getReferencedSeriesItems ()
 Return reference to list of Referenced Series items. More...
 
OFVector
< StudiesOtherInstancesItem * > & 
getStudiesContainingOtherReferences ()
 Return reference to content of Studies Containing Other Referenced Instances Sequence. More...
 
 StudiesOtherInstancesItem (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
 Constructor. More...
 
 StudiesOtherInstancesItem (IODComponent *parent=NULL)
 Constructor. More...
 
virtual ~StudiesOtherInstancesItem ()
 Destructor.
 
virtual void clearData ()
 Clear (removes) all attributes handled by the modules of this component. More...
 
virtual OFCondition read (DcmItem &source, const OFBool clearOldData=OFTrue)
 Read data from source item into this module. More...
 
virtual OFCondition write (DcmItem &destination)
 Write this module's data into given destination item. More...
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of module ("StudiesContainingOtherReferencedInstancesSequence") More...
 
virtual OFCondition getStudyInstanceUID (OFString &value, const signed long pos=0) const
 Get Study Instance UID. More...
 
virtual OFCondition setStudyInstanceUID (const OFString &value, const OFBool checkValue=OFTrue)
 Set Study Instance UID. More...
 
virtual
IODSeriesAndInstanceReferenceMacro
getReferencedSeriesAndInstanceReferences ()
 Get Series And Instance Reference Macro. 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...
 
IODModuleoperator= (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...
 
IODComponentoperator= (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< IODRulesgetRules ()
 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...
 
DcmItemgetData ()
 Get the data handled by this module. 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...
 

Private Attributes

OFVector
< IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem * > 
m_ReferenceSeriesItems
 Vector with all items of the Referenced Series Sequence.
 
OFVector
< StudiesOtherInstancesItem * > 
m_StudiesContainingOtherReferencedInstancesSequence
 Items of Studies Containing Other Referenced Instances Sequence.
 
IODSeriesAndInstanceReferenceMacro m_ReferencedSeriesAndInstance
 The Series and Instance Reference Macro used in this item.
 

Static Private Attributes

static const OFString m_ComponentName
 Name of this component ("CommonInstanceReferenceModule") 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< DcmItemm_Item
 Shared pointer to the data handled by this class. More...
 
OFshared_ptr< IODRulesm_Rules
 Rules describing the attributes governed by this class.
 
IODComponentm_Parent
 The parent component (may be NULL) of this class.
 

Detailed Description

Class representing the Common Instance Reference Module:

Class representing items from the Studies Containing Other Referenced Instances Sequence, as used within the Common Instance Reference Module.

Referenced Series Sequence: (SQ, VM 1-n, Type 1C)

Series Instance UID: (UI, 1, 1) Referenced Instance Sequence: (SQ, 1-n, 1)

SOP Instance Reference Macro

Studies Containing Other Referenced Instances Sequence: (SQ, 1-n, 1C)

Study Instance UID (UI, 1, 1) Series and Instance Reference Macro

Studies Containing Other Referenced Instances Sequence: (SQ, 1-n, 1C)

Study Instance UID (UI, 1, 1) Series and Instance Reference Macro

Constructor & Destructor Documentation

IODCommonInstanceReferenceModule::IODCommonInstanceReferenceModule ( OFshared_ptr< DcmItem item,
OFshared_ptr< IODRules rules 
)

Constructor.

Parameters
itemThe item to be used for data storage. If NULL, the class creates an empty data container.
rulesThe rule set for this class. If NULL, the class creates one from scratch and adds its values.

Member Function Documentation

virtual size_t IODCommonInstanceReferenceModule::addReferences ( const IODReferences references,
const OFString studyInstanceUID,
const OFBool  clearOldData = OFTrue 
)
virtual

Add references.

Parameters
referencesThe references to be added
studyInstanceUIDThe Study Instance UID the references belong to
clearOldDataDelete any old referneces if OFTrue, otherwise keep them
Returns
EC_Normal if successful, error otherwise
virtual void IODCommonInstanceReferenceModule::clearData ( )
virtual

Clear (removes) all attributes handled by the modules of this component.

Rules are not reset.

virtual OFString IODCommonInstanceReferenceModule::getName ( ) const
virtual

Get name of module ("CommonInstanceReferenceModule")

Returns
Name of the module ("CommonInstanceReferenceModule")

Implements IODComponent.

virtual OFString IODCommonInstanceReferenceModule::getName ( ) const
virtual

Get name of module ("StudiesContainingOtherReferencedInstancesSequence")

Returns
Name of the module ("StudiesContainingOtherReferencedInstancesSequence")

Implements IODComponent.

virtual IODSeriesAndInstanceReferenceMacro& IODCommonInstanceReferenceModule::getReferencedSeriesAndInstanceReferences ( )
virtual

Get Series And Instance Reference Macro.

Returns
Reference to the Series And Instance Reference Macro structure
OFVector<IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem*>& IODCommonInstanceReferenceModule::getReferencedSeriesItems ( )

Return reference to list of Referenced Series items.

Returns
Reference to list of Reference Series Items
OFVector<StudiesOtherInstancesItem*>& IODCommonInstanceReferenceModule::getStudiesContainingOtherReferences ( )

Return reference to content of Studies Containing Other Referenced Instances Sequence.

Returns
Reference to content of Studies Containing Other Referenced Instances Sequence
virtual OFCondition IODCommonInstanceReferenceModule::getStudyInstanceUID ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Study Instance UID.

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1), -1 for all components
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition IODCommonInstanceReferenceModule::read ( DcmItem source,
const OFBool  clearOldData = OFTrue 
)
virtual

Read data of this module from given source item.

Parameters
sourceThe item to read from
clearOldDataIf OFTrue, old data is cleared before reading, otherwise it is overwriten/amended.
Returns
EC_Normal if successful, error otherwise

Reimplemented from IODComponent.

virtual OFCondition IODCommonInstanceReferenceModule::read ( DcmItem source,
const OFBool  clearOldData = OFTrue 
)
virtual

Read data from source item into this module.

Parameters
sourceThe item to read from
clearOldDataIf OFTrue, old data is cleared first, otherwise it is overwritten/amended
Returns
EC_Normal if successful, error otherwise

Reimplemented from IODComponent.

virtual OFCondition IODCommonInstanceReferenceModule::setStudyInstanceUID ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Study Instance UID.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (PN) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
IODCommonInstanceReferenceModule::StudiesOtherInstancesItem ( OFshared_ptr< DcmItem item,
OFshared_ptr< IODRules rules,
IODComponent parent = NULL 
)

Constructor.

Parameters
itemThe item to be used for data storage. If NULL, the class creates an empty data container.
rulesThe rule set for this class. If NULL, the class creates one from scratch and adds its values.
parentThe parent of the IOD component (NULL if none or unknown)
IODCommonInstanceReferenceModule::StudiesOtherInstancesItem ( IODComponent parent = NULL)

Constructor.

Parameters
parentThe parent component of this module, might be NULL
virtual OFCondition IODCommonInstanceReferenceModule::write ( DcmItem destination)
virtual

Write data of this module into given destination item.

Parameters
destinationThe item to write to
Returns
EC_Normal if successful, error otherwise

Reimplemented from IODComponent.

virtual OFCondition IODCommonInstanceReferenceModule::write ( DcmItem destination)
virtual

Write this module's data into given destination item.

Parameters
destinationItem to write to
Returns
EC_Normal if successful, error otherwise

Reimplemented from IODComponent.

Member Data Documentation

static const OFString IODCommonInstanceReferenceModule::m_ComponentName
staticprivate

Name of this component ("CommonInstanceReferenceModule")

The name of this component ("StudiesContainingOtherReferencedInstancesSequence")


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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8