DCMTK Version 3.6.9
OFFIS DICOM Toolkit
Loading...
Searching...
No Matches
IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem Class Reference

Class representing Items from the Referenced Series Sequence: More...

+ Inheritance diagram for IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem:

Public Member Functions

 ReferencedSeriesItem (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
 Constructor.
 
 ReferencedSeriesItem (IODComponent *parent=NULL)
 Constructor.
 
virtual ~ReferencedSeriesItem ()
 Destructor.
 
virtual void clearData ()
 Clear (removes) all attributes handled by the modules of this component.
 
virtual OFCondition read (DcmItem &source, const OFBool clearOldData=OFTrue)
 Read Referenced Series Sequence item data from given item.
 
virtual OFCondition write (DcmItem &destination)
 Write this Referenced Series Sequence item data to given item.
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of module ("SeriesAndInstanceReferenceMacro")
 
virtual OFCondition getSeriesInstanceUID (OFString &value, const signed long pos=0) const
 Get Series Instance UID.
 
virtual OFCondition setSeriesInstanceUID (const OFString &value, const OFBool checkValue=OFTrue)
 Set Series Instance UID.
 
virtual OFVector< SOPInstanceReferenceMacro * > & getReferencedInstanceItems ()
 Get content of the Referenced Instance Sequence.
 
- Public Member Functions inherited from IODComponent
 IODComponent (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules, IODComponent *parent=NULL)
 Constructor.
 
 IODComponent (IODComponent *parent=NULL)
 Constructor, creates rules and item from scratch.
 
IODComponentoperator= (const IODComponent &rhs)
 Assignment operator, copies contained item and rule set from rhs to "this" attribute set.
 
 IODComponent (const IODComponent &rhs)
 Copy constructor, copies reference to contained item and rule set to "this" attribute set.
 
virtual ~IODComponent ()
 Virtual Destructor.
 
void clearData ()
 Clear all attributes from the data that are handled by this module.
 
virtual void inventMissing ()
 Set missing values by inventing "default values".
 
OFshared_ptr< IODRulesgetRules ()
 Get rules handled by this module.
 
virtual void makeOptional ()
 Make component optional by turning all attributes requirement types of it to type 3.
 
DcmItemgetData ()
 Get the data handled by this module.
 
virtual OFCondition check (const OFBool quiet=OFFalse)
 Check whether this component's data satisfies the underlying rules.
 
virtual int compare (const IODComponent &rhs) const
 Comparison operator for IOD Components.
 
virtual bool getValueCheckOnWrite () const
 Get whether attribute value errors will be handled as errors on writing.
 
virtual void setValueCheckOnWrite (const OFBool checkValue)
 Set whether attribute values should be checked on writing, i.e.
 

Private Attributes

OFVector< SOPInstanceReferenceMacro * > m_ReferencedInstanceSequence
 Vector containing the data of all items of the Referenced Instance Sequence.
 

Static Private Attributes

static const OFString m_ComponentName
 The name of this component ("SeriesAndInstanceReferenceMacro")
 

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.
 
static OFCondition write (DcmItem &source, IODRules &rules, DcmItem &destination, const OFString &componentName, const OFBool checkValue)
 Static helper function that writes attributes from given item into destination item, as determined by the provided rules and component name.
 
- Protected Attributes inherited from IODComponent
OFshared_ptr< DcmItemm_Item
 Shared pointer to the data handled by this class.
 
OFshared_ptr< IODRulesm_Rules
 Rules describing the attributes governed by this class.
 
IODComponentm_Parent
 The parent component (may be NULL) of this class.
 
OFBool m_CheckValueOnWrite
 Denotes whether attribute values should be checked on writing, i.e.
 

Detailed Description

Class representing Items from the Referenced Series Sequence:

[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

Constructor & Destructor Documentation

◆ ReferencedSeriesItem() [1/2]

IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::ReferencedSeriesItem ( 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)

References IODComponent::IODComponent().

◆ ReferencedSeriesItem() [2/2]

IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::ReferencedSeriesItem ( IODComponent * parent = NULL)

Constructor.

Parameters
parentThe parent component of this class (if applicable, might be NULL)

References IODComponent::IODComponent().

Member Function Documentation

◆ clearData()

virtual void IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::clearData ( )
virtual

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

Rules are not reset.

◆ getName()

virtual OFString IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::getName ( ) const
virtual

Get name of module ("SeriesAndInstanceReferenceMacro")

Returns
Name of the module ("SeriesAndInstanceReferenceMacro")

Implements IODComponent.

◆ getReferencedInstanceItems()

virtual OFVector< SOPInstanceReferenceMacro * > & IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::getReferencedInstanceItems ( )
virtual

Get content of the Referenced Instance Sequence.

Returns
Reference to the Referenced Instance Sequence content

◆ getSeriesInstanceUID()

virtual OFCondition IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::getSeriesInstanceUID ( OFString & value,
const signed long pos = 0 ) const
virtual

Get Series 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

◆ read()

virtual OFCondition IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::read ( DcmItem & source,
const OFBool clearOldData = OFTrue )
virtual

Read Referenced Series Sequence item data from given item.

Parameters
sourceThe item to read from
clearOldDataIf OFTrue, old data is cleared before reading
Returns
EC_Normal if data could be read successfully, error otherwise

Reimplemented from IODComponent.

◆ setSeriesInstanceUID()

virtual OFCondition IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::setSeriesInstanceUID ( const OFString & value,
const OFBool checkValue = OFTrue )
virtual

Set Series Instance UID.

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

◆ write()

virtual OFCondition IODSeriesAndInstanceReferenceMacro::ReferencedSeriesItem::write ( DcmItem & destination)
virtual

Write this Referenced Series Sequence item data to given item.

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

Reimplemented from IODComponent.


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


Generated on Sat Mar 1 2025 for DCMTK Version 3.6.9 by Doxygen 1.13.2