DCMTK  Version 3.6.5
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
DPMParametricMapSeriesModule Class Reference

Class representing the Parametric Map Series Module: More...

+ Inheritance diagram for DPMParametricMapSeriesModule:

Public Member Functions

 DPMParametricMapSeriesModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
 Constructor. More...
 
 DPMParametricMapSeriesModule ()
 Constructor.
 
virtual ~DPMParametricMapSeriesModule ()
 Destructor.
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of module ("DPMParametricMapSeriesModule") 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 getModality (OFString &value, const signed long pos=0) const
 Get Modality. More...
 
virtual OFCondition getSeriesNumber (OFString &value, const signed long pos=0) const
 Get Series Number. More...
 
virtual SOPInstanceReferenceMacrogetReferencedPerformedProcedureStepSequence ()
 Get reference to the Referenced Performed Procedure Step Sequence. More...
 
virtual OFVector< SOPInstanceReferenceMacro > & getEntireReferencedPerformedProcedureStepSequence ()
 Get a reference to the entire Referenced Performed Procedure Step Sequence, including items exceeding the value multiplicity restriction of "1". More...
 
virtual OFCondition setModality (const OFString &value, const OFBool checkValue=OFTrue)
 Set Modality. More...
 
virtual OFCondition setSeriesNumber (const OFString &value, const OFBool checkValue=OFTrue)
 Set Series Number. 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< SOPInstanceReferenceMacrom_ReferencedPerformedProcedureStepSequence
 ReferencedPerformedProcedureStepSequence.
 

Static Private Attributes

static const OFString m_ModuleName
 The name of this module ("DPMParametricMapSeriesModule")
 

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 Parametric Map Series Module:

Modality: (CS, 1, 1) SeriesNumber: (IS, 1, 1) ReferencedPerformedProcedureStepSequence: (SQ, 1, 1C)

Constructor & Destructor Documentation

◆ DPMParametricMapSeriesModule()

DPMParametricMapSeriesModule::DPMParametricMapSeriesModule ( 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

◆ getEntireReferencedPerformedProcedureStepSequence()

virtual OFVector<SOPInstanceReferenceMacro>& DPMParametricMapSeriesModule::getEntireReferencedPerformedProcedureStepSequence ( )
virtual

Get a reference to the entire Referenced Performed Procedure Step Sequence, including items exceeding the value multiplicity restriction of "1".

Returns
a reference to the entire Referenced Performed Procedure Step Sequence

◆ getModality()

virtual OFCondition DPMParametricMapSeriesModule::getModality ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Modality.

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

◆ getName()

virtual OFString DPMParametricMapSeriesModule::getName ( ) const
virtual

Get name of module ("DPMParametricMapSeriesModule")

Returns
Name of the module ("DPMParametricMapSeriesModule")

Implements IODComponent.

◆ getReferencedPerformedProcedureStepSequence()

virtual SOPInstanceReferenceMacro* DPMParametricMapSeriesModule::getReferencedPerformedProcedureStepSequence ( )
virtual

Get reference to the Referenced Performed Procedure Step Sequence.

Returns
a reference to the Referenced Performed Procedure Step Sequence

◆ getSeriesNumber()

virtual OFCondition DPMParametricMapSeriesModule::getSeriesNumber ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Series Number.

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

◆ read()

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

Read attributes from given item into this class.

Parameters
sourceThe source to read from
clearOldDataIf OFTrue, old data is cleared before reading. Otherwise old data is overwritten (or amended)
Returns
EC_Normal if reading was successful, error otherwise

Reimplemented from IODComponent.

◆ setModality()

virtual OFCondition DPMParametricMapSeriesModule::setModality ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Modality.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise

◆ setSeriesNumber()

virtual OFCondition DPMParametricMapSeriesModule::setSeriesNumber ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Series Number.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (IS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise

◆ write()

virtual OFCondition DPMParametricMapSeriesModule::write ( DcmItem destination)
virtual

Write attributes from this class into given item.

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

Reimplemented from IODComponent.


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


Generated on Mon Oct 28 2019 for DCMTK Version 3.6.5 by Doxygen 1.8.15