DCMTK  Version 3.6.4
OFFIS DICOM Toolkit
Public Member Functions | List of all members
IODMultiframeDimensionModule::DimensionOrganizationItem Class Reference

Helper class representing an item within the Dimension Index Sequence, i.e. a single dimension description. More...

+ Inheritance diagram for IODMultiframeDimensionModule::DimensionOrganizationItem:

Public Member Functions

 DimensionOrganizationItem (OFshared_ptr< DcmItem > data, OFshared_ptr< IODRules > rules, IODComponent *parent)
 Constructor. More...
 
 DimensionOrganizationItem (IODComponent *parent=NULL)
 Constructor. More...
 
virtual ~DimensionOrganizationItem ()
 Destructor.
 
virtual OFString getName () const
 Get name of module ("DimensionIndexPointerSequence") More...
 
virtual void resetRules ()
 Resets rules of this module to their original values.
 
virtual OFCondition getDimensionOrganizationUID (OFString &value, const signed long pos=0) const
 Get Dimension Organization UID. More...
 
virtual OFCondition setDimensionOrganizationUID (const OFString &value, const OFBool checkValue=OFTrue)
 Set Dimension Organization 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...
 
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 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< 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

Helper class representing an item within the Dimension Index Sequence, i.e. a single dimension description.

Constructor & Destructor Documentation

◆ DimensionOrganizationItem() [1/2]

IODMultiframeDimensionModule::DimensionOrganizationItem::DimensionOrganizationItem ( OFshared_ptr< DcmItem data,
OFshared_ptr< IODRules rules,
IODComponent parent 
)

Constructor.

Parameters
dataThe 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)

◆ DimensionOrganizationItem() [2/2]

IODMultiframeDimensionModule::DimensionOrganizationItem::DimensionOrganizationItem ( IODComponent parent = NULL)

Constructor.

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

Member Function Documentation

◆ getDimensionOrganizationUID()

virtual OFCondition IODMultiframeDimensionModule::DimensionOrganizationItem::getDimensionOrganizationUID ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Dimension Organization 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

◆ getName()

virtual OFString IODMultiframeDimensionModule::DimensionOrganizationItem::getName ( ) const
virtual

Get name of module ("DimensionIndexPointerSequence")

Returns
Name of the module ("DimensionIndexPointerSequence")

Implements IODComponent.

◆ setDimensionOrganizationUID()

virtual OFCondition IODMultiframeDimensionModule::DimensionOrganizationItem::setDimensionOrganizationUID ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Dimension Organization 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
status EC_Normal if successful, an error code otherwise

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


Generated on Thu Nov 29 2018 for DCMTK Version 3.6.4 by Doxygen 1.8.14