DCMTK
Version 3.6.2
OFFIS DICOM Toolkit
|
Class representing the SOP Common Module. More...
Public Member Functions | |
IODSOPCommonModule (OFshared_ptr< DcmItem > item, OFshared_ptr< IODRules > rules) | |
Constructor. More... | |
IODSOPCommonModule () | |
Constructor. | |
virtual | ~IODSOPCommonModule () |
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 SOP Instance UID, i.e. a new one is created if empty. More... | |
virtual OFCondition | getSOPClassUID (OFString &value, const signed long pos=0) const |
Get SOP Class UID. More... | |
virtual OFCondition | getSOPInstanceUID (OFString &value, const signed long pos=0) const |
Get SOP Instance UID. More... | |
virtual OFCondition | getInstanceCreatorUID (OFString &value, const signed long pos=0) const |
Get Instance Creator UID. More... | |
virtual OFCondition | getTimezoneOffsetFromUTC (OFString &value, const signed long pos=0) const |
Get Timeho e Offset from UTC. More... | |
virtual OFCondition | getSpecificCharacterSet (OFString &value, const signed long pos=0) const |
Get Specific Character Set. More... | |
virtual OFCondition | getInstanceCreationDate (OFString &value, const signed long pos=0) const |
Get Instance Creation Date. More... | |
virtual OFCondition | getInstanceCreationTime (OFString &value, const signed long pos=0) const |
Get Instance Creation Time. More... | |
virtual OFCondition | setSOPInstanceUID (const OFString &value, const OFBool checkValue=OFTrue) |
Set SOP Instance UID. More... | |
virtual OFCondition | setSOPClassUID (const OFString &value, const OFBool checkValue=OFTrue) |
Set SOP Class UID. More... | |
virtual OFCondition | setSpecificCharacterSet (const OFString &value, const OFBool checkValue=OFTrue) |
Set Specific Character Set. More... | |
virtual OFCondition | setInstanceCreationDate (const OFString &value, const OFBool checkValue=OFTrue) |
Set Instance Creation Date. More... | |
virtual OFCondition | setInstanceCreationTime (const OFString &value, const OFBool checkValue=OFTrue) |
Set Instance Creation Date. More... | |
virtual OFCondition | setInstanceCreatorUID (const OFString &value, const OFBool checkValue=OFTrue) |
Set Instance Creator UID. More... | |
virtual OFCondition | setTimeZoneOffsetFromUTC (const OFString &value, const OFBool checkValue=OFTrue) const |
Set Timezone Offset From UTC. 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 | 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 |
Name of this module ("SOPCommonModule") | |
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 SOP Common Module.
Supported Attributes:
SOP Class UID: (UI, 1, 1) SOP Instance UID: (UI, 1, 1) Specific Character Set: (CS, 1-n, 1C) Instance Creation Date: (DA, 1, 3) Instance Creation Time: (TM, 1, 3) Instance Creator UID: (UI, 1, 3) Timezone Offset from UTC: (SH, 1, 3)
IODSOPCommonModule::IODSOPCommonModule | ( | 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 SOP 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 Instance Creation 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 Instance Creation 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 |
Get Instance Creator 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 |
|
virtual |
Get SOP Class 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 SOP 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 Specific Character Set.
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 Timeho e Offset from UTC.
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 |
Set Instance Creation Date.
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 |
Set Instance Creation Date.
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 |
Set Instance Creator UID.
value | Value to be set (single value only) or "" for no value |
checkValue | Check 'value' for conformance with VR (UID) and VM (1) if enabled |
|
virtual |
Set SOP Class 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 SOP 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 Specific Character Set.
The internal enumerated value is set accordingly. Please note that code extensions techniques are not supported. Therefore, only a single value can be passed.
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 Timezone Offset From UTC.
value | Value to be set (single value only) or "" for no value. Encoded as an ASCII string in the format â&ZZXXâ. The components of this string, from left to right, are & = â+â or â-â, and ZZ = Hours and XX = Minutes of offset. |
checkValue | Check 'value' for conformance with VR (SH) and VM (1) if enabled |