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

Class representing the Patient Study Module: More...

+ Inheritance diagram for IODPatientStudyModule:

Public Member Functions

 IODPatientStudyModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules)
 Constructor. More...
 
 IODPatientStudyModule ()
 Constructor.
 
virtual ~IODPatientStudyModule ()
 Destructor.
 
virtual void resetRules ()
 Resets rules to their original values.
 
virtual OFString getName () const
 Get name of module ("PatientStudyModule") More...
 
virtual OFCondition getAdmittingDiagnosesDescription (OFString &value, const signed long pos=0) const
 Get Admitting Diagnoses Description. More...
 
virtual OFCondition getPatientAge (OFString &value, const signed long pos=0) const
 Get Patient's Age (string as defined by VR "AS", see DICOM part 5) More...
 
virtual OFCondition getPatientWeight (Float64 &value, const unsigned long pos=0) const
 Get Patient's Weight (in kilograms) More...
 
virtual OFCondition getPatientSize (Float64 &value, const unsigned long pos=0) const
 Get Patient's Size (in meters) More...
 
virtual OFCondition setAdmittingDiagnosesDescription (const OFString &value, const OFBool checkValue=OFTrue)
 Set Admitting Diagnoses Description. More...
 
virtual OFCondition setPatientAge (const OFString &value, const OFBool checkValue=OFTrue)
 Set Patient's Age (formatted as defined by VR "AS", see part 5 of the standard) More...
 
virtual OFCondition setPatientSize (const OFString &value, const OFBool checkValue=OFTrue)
 Set Patient's Size (in meters) More...
 
virtual OFCondition setPatientWeight (const OFString &value, const OFBool checkValue=OFTrue)
 Set Patient's Weight (in kilograms) 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 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 ("PatientStudyModule")
 

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 Patient Study Module:

Admitting Diagnoses Description: (LO, 1-n, 3) Patient's Age: (AS, 1, 3) Patient's Size: (DS, 1, 3) Patient's Weight: (DS,1, 3)

Constructor & Destructor Documentation

IODPatientStudyModule::IODPatientStudyModule ( 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 OFCondition IODPatientStudyModule::getAdmittingDiagnosesDescription ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Admitting Diagnoses Description.

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 OFString IODPatientStudyModule::getName ( ) const
virtual

Get name of module ("PatientStudyModule")

Returns
Name of the module ("PatientStudyModule")

Implements IODComponent.

virtual OFCondition IODPatientStudyModule::getPatientAge ( OFString value,
const signed long  pos = 0 
) const
virtual

Get Patient's Age (string as defined by VR "AS", see DICOM part 5)

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 IODPatientStudyModule::getPatientSize ( Float64 &  value,
const unsigned long  pos = 0 
) const
virtual

Get Patient's Size (in meters)

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1)
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition IODPatientStudyModule::getPatientWeight ( Float64 &  value,
const unsigned long  pos = 0 
) const
virtual

Get Patient's Weight (in kilograms)

Parameters
valueReference to variable in which the value should be stored
posIndex of the value to get (0..vm-1)
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition IODPatientStudyModule::setAdmittingDiagnosesDescription ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Admitting Diagnoses Description.

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (LO) and VM (1-n) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition IODPatientStudyModule::setPatientAge ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Patient's Age (formatted as defined by VR "AS", see part 5 of the standard)

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (AS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition IODPatientStudyModule::setPatientSize ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Patient's Size (in meters)

Parameters
valueValue to be set (single value only) or "" for no value
checkValueCheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns
EC_Normal if successful, an error code otherwise
virtual OFCondition IODPatientStudyModule::setPatientWeight ( const OFString value,
const OFBool  checkValue = OFTrue 
)
virtual

Set Patient's Weight (in kilograms)

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

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