DCMTK
Version 3.6.3
OFFIS DICOM Toolkit
|
Class representing the General Series Module: More...
Public Member Functions | |
IODGeneralSeriesModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODGeneralSeriesModule () | |
Constructor. | |
virtual | ~IODGeneralSeriesModule () |
Destructor. | |
virtual void | resetRules () |
Resets rules to their original values. | |
virtual void | inventMissing () |
Set missing values by inventing "default values". More... | |
virtual OFString | getName () const |
Get name of module. More... | |
virtual void | ensureInstanceUID (const OFBool correctInvalid=OFFalse) |
Make sure that the module contains a Series Instance UID, i.e. a new one is created if empty. 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 | getSeriesInstanceUID (OFString &value, const signed long pos=0) const |
Get series instance UID. More... | |
virtual OFCondition | getSeriesNumber (OFString &value, const signed long pos=0) const |
Get Series Number. More... | |
virtual OFCondition | getLaterality (OFString &value, const signed long pos=0) const |
Get Laterality. More... | |
virtual OFCondition | getSeriesDate (OFString &value, const signed long pos=0) const |
Get Series Date. More... | |
virtual OFCondition | getSeriesTime (OFString &value, const signed long pos=0) const |
Get Series Time. More... | |
virtual OFCondition | getPerformingPhysicianName (OFString &value, const signed long pos=0) const |
Get Performing Physician's Name. More... | |
virtual OFCondition | getProtocolName (OFString &value, const signed long pos=0) const |
Get Protocol Name. More... | |
virtual OFCondition | getSeriesDescription (OFString &value, const signed long pos=0) const |
Get Series Description. More... | |
virtual OFCondition | getOperatorsName (OFString &value, const signed long pos=0) const |
Get Operators' Name. More... | |
virtual OFCondition | getBodyPartExamined (OFString &value, const signed long pos=0) const |
Get Body Part Examined. More... | |
virtual OFCondition | getPatientPosition (OFString &value, const signed long pos=0) const |
Get Patient Position. More... | |
virtual SOPInstanceReferenceMacro & | getReferencedPPS () |
Get reference to Referenced Performed Procedure Step. More... | |
virtual OFCondition | setModality (const OFString &value, const OFBool checkValue=OFTrue) |
Set Modality. More... | |
virtual OFCondition | setSeriesInstanceUID (const OFString &value, const OFBool checkValue=OFTrue) |
Set Series Instance UID. More... | |
virtual OFCondition | setSeriesNumber (const OFString &value, const OFBool checkValue=OFTrue) |
Set Series Number. More... | |
virtual OFCondition | setLaterality (const DcmIODTypes::IOD_LATERALITY value, const OFBool checkValue=OFTrue) |
Set Laterality. More... | |
virtual OFCondition | setSeriesDate (const OFString &value, const OFBool checkValue=OFTrue) |
Set Series Date. More... | |
virtual OFCondition | setSeriesTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Series Time. More... | |
virtual OFCondition | setPerformingPhysicianName (const OFString &value, const OFBool checkValue=OFTrue) |
Set Performing Physician Name. More... | |
virtual OFCondition | setProtocolName (const OFString &value, const OFBool checkValue=OFTrue) |
Set Protocol Name. More... | |
virtual OFCondition | setSeriesDescription (const OFString &value, const OFBool checkValue=OFTrue) |
Set Series Description. More... | |
virtual OFCondition | setOperatorsName (const OFString &value, const OFBool checkValue=OFTrue) |
Set Operators' Name. More... | |
virtual OFCondition | setBodyPartExamined (const OFString &value, const OFBool checkValue=OFTrue) |
Set Body Part Examined. More... | |
virtual OFCondition | setPatientPosition (const OFString &value, const OFBool checkValue=OFTrue) |
Set Patient Position. More... | |
![]() | |
IODModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODModule () | |
Constructor. More... | |
IODModule (const IODModule &rhs) | |
Copy constructor, creates shallow copy. More... | |
IODModule & | operator= (const IODModule &rhs) |
Assignment operator, creates shallow copy. More... | |
~IODModule () | |
Desctructor. | |
![]() | |
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... | |
IODComponent & | operator= (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... | |
OFshared_ptr< IODRules > | getRules () |
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... | |
DcmItem & | getData () |
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 | |
SOPInstanceReferenceMacro | m_ReferencedPPS |
Referenced Performed Procedure Step Sequence. | |
Static Private Attributes | |
static const OFString | m_ModuleName |
The name of this module ("GeneralSeriesModule") | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
OFshared_ptr< DcmItem > | m_Item |
Shared pointer to the data handled by this class. More... | |
OFshared_ptr< IODRules > | m_Rules |
Rules describing the attributes governed by this class. | |
IODComponent * | m_Parent |
The parent component (may be NULL) of this class. | |
Class representing the General Series Module:
Modality: (CS, 1, 1) Series Instance Number: (UI, 1, 1) Series Number: (IS, 1, 2) Laterality: (CS, 1, 2C) Series Date: (DA, 1, 3) Series Time: (TM, 1, 3) Performing Physician's Name: (PN, 1, 3) Protocol Name: (LO, 1, 3) Series Description: (LO, 1, 3) Operators' Name: (PN, 1-n, 3) Body Part Examined: (CS, 1, 3) Patient Position: (CS, 1, 2C)
IODGeneralSeriesModule::IODGeneralSeriesModule | ( | OFshared_ptr< DcmItem > | item, |
OFshared_ptr< IODRules > | rules | ||
) |
Constructor.
item | The item to be used for data storage. If NULL, the class creates an empty data container. |
rules | The rule set for this class. If NULL, the class creates one from scratch and adds its values. |
|
virtual |
Make sure that the module contains a Series Instance UID, i.e. a new one is created if empty.
An invalid UID is corrected if desired.
correctInvalid | Correct invalid UID if OFTrue, otherwise do nothing |
|
virtual |
Get Body Part Examined.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Laterality.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Modality.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
|
virtual |
Get Operators' Name.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Patient Position.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Performing Physician's Name.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Protocol Name.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get reference to Referenced Performed Procedure Step.
|
virtual |
Get Series Date.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Series Description.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get series instance UID.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Series Number.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Get Series Time.
value | Reference to variable in which the value should be stored |
pos | Index of the value to get (0..vm-1), -1 for all components |
|
virtual |
Set missing values by inventing "default values".
Automatically called during write() by IODComponent.
Reimplemented from IODComponent.
|
virtual |
Read attributes from given item into this class.
source | The source to read from |
clearOldData | If OFTrue, old data is cleared before reading. Otherwise old data is overwritten (or amended) |
Reimplemented from IODComponent.
|
virtual |
Set Body Part Examined.
value | Value to be set |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |
|
virtual |
Set Laterality.
value | Value to be set |
checkValue | Check 'value'. Not evaluated (here for consistency with other setter functions). |
|
virtual |
Set Modality.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |
|
virtual |
Set Operators' Name.
value | Value to be set |
checkValue | Check 'value' for conformance with VR (PN) and VM (1-n) if enabled |
|
virtual |
Set Patient Position.
value | Value to be set |
checkValue | Check 'value' for conformance with VR (CS) and VM (1) if enabled |
|
virtual |
Set Performing Physician Name.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (PN) and VM (1) if enabled |
|
virtual |
Set Protocol Name.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (LO) and VM (1) if enabled |
|
virtual |
Set Series Date.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (DA) and VM (1) if enabled |
|
virtual |
Set Series Description.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (LO) and VM (1) if enabled |
|
virtual |
Set Series Instance UID.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (UI) and VM (1) if enabled |
|
virtual |
Set Series Number.
value | Value to be set (single value only). If an empty string is, passed, the value "1" is set when displaying or writing the document since the corresponding DICOM attribute is mandatory. |
checkValue | Check 'value' for conformance with VR (IS) and VM (1) if enabled |
|
virtual |
Set Series Time.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (TM) and VM (1) if enabled |
|
virtual |
Write attributes from this class into given item.
destination | The item to write to |
Reimplemented from IODComponent.