Interface class for 'dcmsr' (DICOM Structured Reporting Documents). More...
Inheritance diagram for DSRDocument:
Public Member Functions | |
| DSRDocument (const E_DocumentType documentType=DT_BasicTextSR) | |
| (default) constructor. | |
| virtual | ~DSRDocument () |
| destructor | |
| virtual void | clear () |
| clear all internal member variables | |
| virtual OFBool | isValid () |
| check whether the current internal state is valid. | |
| virtual OFBool | isFinalized () const |
| check whether the document is finalized. | |
| virtual OFCondition | print (STD_NAMESPACE ostream &stream, const size_t flags=0) |
| print current SR document to specified output stream. | |
| virtual OFCondition | read (DcmItem &dataset, const size_t flags=0) |
| read SR document from DICOM dataset. | |
| virtual OFCondition | write (DcmItem &dataset, DcmStack *markedItems=NULL) |
| write current SR document to DICOM dataset. | |
| virtual OFCondition | readXML (const OFString &filename, const size_t flags=0) |
| read SR document from XML file. | |
| virtual OFCondition | writeXML (STD_NAMESPACE ostream &stream, const size_t flags=0) |
| write current SR document in XML format. | |
| virtual OFCondition | renderHTML (STD_NAMESPACE ostream &stream, const size_t flags=0, const char *styleSheet=NULL) |
| render current SR document in HTML/XHTML format. | |
| virtual E_DocumentType | getDocumentType () const |
| get the current SR document type | |
| DSRDocumentTree & | getTree () |
| get document tree | |
| virtual E_CharacterSet | getSpecificCharacterSetType () const |
| get specific character set type. | |
| virtual OFCondition | setSpecificCharacterSetType (const E_CharacterSet characterSet) |
| set specific character set type. | |
| virtual E_PreliminaryFlag | getPreliminaryFlag () const |
| get document preliminary flag. | |
| virtual OFCondition | setPreliminaryFlag (const E_PreliminaryFlag flag) |
| set document preliminary flag. | |
| virtual E_CompletionFlag | getCompletionFlag () const |
| get document completion flag. | |
| virtual E_VerificationFlag | getVerificationFlag () const |
| get document verification flag. | |
| virtual size_t | getNumberOfVerifyingObservers () |
| get number of verifying observers. | |
| virtual OFCondition | getVerifyingObserver (const size_t idx, OFString &dateTime, OFString &observerName, OFString &organization) |
| get information about a verifying observer. | |
| virtual OFCondition | getVerifyingObserver (const size_t idx, OFString &dateTime, OFString &observerName, DSRCodedEntryValue &observerCode, OFString &organization) |
| get information about a verifying observer. | |
| virtual DSRSOPInstanceReferenceList & | getPredecessorDocuments () |
| get list of predecessor documents. | |
| virtual DSRSOPInstanceReferenceList & | getIdenticalDocuments () |
| get list of identical documents. | |
| virtual DSRSOPInstanceReferenceList & | getCurrentRequestedProcedureEvidence () |
| get list of referenced SOP instances (Current Requested Procedure Evidence). | |
| virtual DSRSOPInstanceReferenceList & | getPertinentOtherEvidence () |
| get list of referenced SOP instances (Pertinent Other Evidence). | |
| virtual DSRReferencedInstanceList & | getReferencedInstances () |
| get list of referenced SOP instances significantly related to the current SOP instance. | |
| virtual DSRCodingSchemeIdentificationList & | getCodingSchemeIdentification () |
| get list of coding schemes used (Coding Scheme Identification). | |
| virtual OFCondition | getSpecificCharacterSet (OFString &value, const signed long pos=0) const |
| get specific character set | |
| virtual OFCondition | getCompletionFlagDescription (OFString &value, const signed long pos=0) const |
| get completion flag description. | |
| virtual OFCondition | getModality (OFString &value, const signed long pos=0) const |
| get modality | |
| virtual OFCondition | getSOPClassUID (OFString &value, const signed long pos=0) const |
| get SOP class UID | |
| virtual OFCondition | getStudyInstanceUID (OFString &value, const signed long pos=0) const |
| get study instance UID | |
| virtual OFCondition | getSeriesInstanceUID (OFString &value, const signed long pos=0) const |
| get series instance UID | |
| virtual OFCondition | getSOPInstanceUID (OFString &value, const signed long pos=0) const |
| get SOP instance UID | |
| virtual OFCondition | getInstanceCreatorUID (OFString &value, const signed long pos=0) const |
| get instance creator UID | |
| virtual OFCondition | getPatientName (OFString &value, const signed long pos=0) const |
| get patient's name | |
| virtual OFCondition | getPatientBirthDate (OFString &value, const signed long pos=0) const |
| get patient's birth date | |
| virtual OFCondition | getPatientSex (OFString &value, const signed long pos=0) const |
| get patient's sex | |
| virtual OFCondition | getReferringPhysicianName (OFString &value, const signed long pos=0) const |
| get referring physician's name | |
| virtual OFCondition | getStudyDescription (OFString &value, const signed long pos=0) const |
| get study description | |
| virtual OFCondition | getSeriesDescription (OFString &value, const signed long pos=0) const |
| get series description | |
| virtual OFCondition | getManufacturer (OFString &value, const signed long pos=0) const |
| get manufacturer | |
| virtual OFCondition | getManufacturerModelName (OFString &value, const signed long pos=0) const |
| get manufacturer's model name | |
| virtual OFCondition | getDeviceSerialNumber (OFString &value, const signed long pos=0) const |
| get device serial number | |
| virtual OFCondition | getSoftwareVersions (OFString &value, const signed long pos=0) const |
| get software version(s). | |
| virtual OFCondition | getStudyDate (OFString &value, const signed long pos=0) const |
| get study date | |
| virtual OFCondition | getStudyTime (OFString &value, const signed long pos=0) const |
| get study time | |
| virtual OFCondition | getSeriesDate (OFString &value, const signed long pos=0) const |
| get series date | |
| virtual OFCondition | getSeriesTime (OFString &value, const signed long pos=0) const |
| get series time | |
| virtual OFCondition | getInstanceCreationDate (OFString &value, const signed long pos=0) const |
| get instance creation date | |
| virtual OFCondition | getInstanceCreationTime (OFString &value, const signed long pos=0) const |
| get instance creation time | |
| virtual OFCondition | getContentDate (OFString &value, const signed long pos=0) const |
| get content date | |
| virtual OFCondition | getContentTime (OFString &value, const signed long pos=0) const |
| get content time | |
| virtual OFCondition | getStudyID (OFString &value, const signed long pos=0) const |
| get study ID | |
| virtual OFCondition | getPatientID (OFString &value, const signed long pos=0) const |
| get patient ID | |
| virtual OFCondition | getSeriesNumber (OFString &value, const signed long pos=0) const |
| get series number | |
| virtual OFCondition | getInstanceNumber (OFString &value, const signed long pos=0) const |
| get instance number | |
| virtual OFCondition | getAccessionNumber (OFString &value, const signed long pos=0) const |
| get accession number | |
| virtual OFCondition | setSpecificCharacterSet (const OFString &value, const OFBool check=OFTrue) |
| set specific character set. | |
| virtual OFCondition | setCompletionFlagDescription (const OFString &value, const OFBool check=OFTrue) |
| set completion flag description. | |
| virtual OFCondition | setPatientName (const OFString &value, const OFBool check=OFTrue) |
| set patient's name | |
| virtual OFCondition | setPatientBirthDate (const OFString &value, const OFBool check=OFTrue) |
| set patient's birth date | |
| virtual OFCondition | setPatientSex (const OFString &value, const OFBool check=OFTrue) |
| set patient's sex | |
| virtual OFCondition | setReferringPhysicianName (const OFString &value, const OFBool check=OFTrue) |
| set referring physician's name | |
| virtual OFCondition | setStudyDescription (const OFString &value, const OFBool check=OFTrue) |
| set study description | |
| virtual OFCondition | setSeriesDescription (const OFString &value, const OFBool check=OFTrue) |
| set series description | |
| virtual OFCondition | setManufacturer (const OFString &value, const OFBool check=OFTrue) |
| set manufacturer | |
| virtual OFCondition | setManufacturerModelName (const OFString &value, const OFBool check=OFTrue) |
| set manufacturer's model name | |
| virtual OFCondition | setDeviceSerialNumber (const OFString &value, const OFBool check=OFTrue) |
| set device serial number | |
| virtual OFCondition | setSoftwareVersions (const OFString &value, const OFBool check=OFTrue) |
| set software version(s) | |
| virtual OFCondition | setContentDate (const OFString &value, const OFBool check=OFTrue) |
| set content date | |
| virtual OFCondition | setContentTime (const OFString &value, const OFBool check=OFTrue) |
| set content time | |
| virtual OFCondition | setStudyDate (const OFString &value, const OFBool check=OFTrue) |
| set study date | |
| virtual OFCondition | setStudyTime (const OFString &value, const OFBool check=OFTrue) |
| set study time | |
| virtual OFCondition | setSeriesDate (const OFString &value, const OFBool check=OFTrue) |
| set series date | |
| virtual OFCondition | setSeriesTime (const OFString &value, const OFBool check=OFTrue) |
| set series time | |
| virtual OFCondition | setStudyID (const OFString &value, const OFBool check=OFTrue) |
| set study ID | |
| virtual OFCondition | setPatientID (const OFString &value, const OFBool check=OFTrue) |
| set patient ID | |
| virtual OFCondition | setSeriesNumber (const OFString &value, const OFBool check=OFTrue) |
| set series number | |
| virtual OFCondition | setInstanceNumber (const OFString &value, const OFBool check=OFTrue) |
| set instance number | |
| virtual OFCondition | setAccessionNumber (const OFString &value, const OFBool check=OFTrue) |
| set accession number | |
| virtual void | createNewStudy () |
| create new study. | |
| virtual void | createNewSeries () |
| create a new series. | |
| virtual OFCondition | createNewSeriesInStudy (const OFString &studyUID, const OFBool check=OFTrue) |
| create a new series within a given study. | |
| virtual void | createNewSOPInstance () |
| create a new SOP instance. | |
| virtual OFCondition | createNewDocument () |
| create a new document. | |
| virtual OFCondition | createNewDocument (const E_DocumentType documentType) |
| create a new document of the specified type. | |
| virtual OFCondition | createRevisedVersion (const OFBool clearList=OFTrue) |
| create a revised version of the current document. | |
| virtual OFCondition | completeDocument () |
| complete the current document. | |
| virtual OFCondition | completeDocument (const OFString &description, const OFBool check=OFTrue) |
| complete the current document and set a completion description. | |
| virtual OFCondition | verifyDocument (const OFString &observerName, const OFString &organization, const OFString &dateTime="", const OFBool check=OFTrue) |
| verify the current document by a specific observer. | |
| virtual OFCondition | verifyDocument (const OFString &observerName, const DSRCodedEntryValue &observerCode, const OFString &organization, const OFString &dateTime="", const OFBool check=OFTrue) |
| verify the current document by a specific observer. | |
| virtual void | removeVerification () |
| remove verification information. | |
| virtual OFCondition | finalizeDocument () |
| finalize the current state of the document. | |
Protected Member Functions | |
| OFCondition | readXMLDocumentHeader (DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags) |
| read XML document header | |
| OFCondition | readXMLPatientData (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags) |
| read XML "patient" data | |
| OFCondition | readXMLStudyData (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags) |
| read XML "study" data | |
| OFCondition | readXMLSeriesData (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags) |
| read XML "series" data | |
| OFCondition | readXMLInstanceData (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags) |
| read XML "instance" data | |
| OFCondition | readXMLDocumentData (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags) |
| read XML "document" data | |
| OFCondition | readXMLVerifyingObserverData (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags) |
| read XML verifying observer data | |
| void | renderHTMLPatientData (STD_NAMESPACE ostream &stream, const size_t flags) |
| render patient name, sex, birthdate and ID in HTML/XHTML format | |
| void | renderHTMLReferenceList (STD_NAMESPACE ostream &stream, DSRSOPInstanceReferenceList &refList, const size_t flags) |
| render list of referenced SOP instances in HTML/XHTML format | |
| void | renderHTMLReferenceList (STD_NAMESPACE ostream &stream, DSRReferencedInstanceList &refList, const size_t flags) |
| render list of referenced SOP instances in HTML/XHTML format | |
| OFCondition | checkDatasetForReading (DcmItem &dataset, E_DocumentType &documentType) |
| check the given dataset before reading. | |
| void | updateAttributes (const OFBool updateAll=OFTrue) |
| update several DICOM attributes. | |
Private Member Functions | |
| DSRDocument (const DSRDocument &) | |
| DSRDocument & | operator= (const DSRDocument &) |
Private Attributes | |
| DSRDocumentTree | DocumentTree |
| SR document tree. | |
| OFBool | FinalizedFlag |
| flag indicating whether is document is finalized or not | |
| E_PreliminaryFlag | PreliminaryFlagEnum |
| enumerated value: preliminary, final | |
| E_CompletionFlag | CompletionFlagEnum |
| enumerated value: partial, complete | |
| E_VerificationFlag | VerificationFlagEnum |
| enumerated value: unverified, verified | |
| E_CharacterSet | SpecificCharacterSetEnum |
| defined term: see class DSRTypes | |
| DcmUniqueIdentifier | SOPClassUID |
| SOP Class UID: (UI, 1, 1) | |
| DcmUniqueIdentifier | SOPInstanceUID |
| SOP Instance UID: (UI, 1, 1) | |
| DcmCodeString | SpecificCharacterSet |
| Specific Character Set: (CS, 1-n, 1C) | |
| DcmDate | InstanceCreationDate |
| Instance Creation Date: (DA, 1, 3) | |
| DcmTime | InstanceCreationTime |
| Instance Creation Time: (TM, 1, 3) | |
| DcmUniqueIdentifier | InstanceCreatorUID |
| Instance Creator UID: (UI, 1, 3) | |
| DSRCodingSchemeIdentificationList | CodingSchemeIdentification |
| Coding Scheme Identification Sequence: (SQ, 1, 3) | |
| DcmUniqueIdentifier | StudyInstanceUID |
| Study Instance UID: (UI, 1, 1) | |
| DcmDate | StudyDate |
| Study Date: (DA, 1, 2) | |
| DcmTime | StudyTime |
| StudyTime: (TM, 1, 2) | |
| DcmPersonName | ReferringPhysicianName |
| ReferringPhysicianName: (PN, 1, 2) | |
| DcmShortString | StudyID |
| Study ID: (SH, 1, 2) | |
| DcmShortString | AccessionNumber |
| Accession Number: (SH, 1, 2) | |
| DcmLongString | StudyDescription |
| Study Description: (LO, 1, 3) | |
| DcmPersonName | PatientName |
| Patient's Name: (PN, 1, 2) | |
| DcmLongString | PatientID |
| Patient ID: (LO, 1, 2) | |
| DcmDate | PatientBirthDate |
| Patient's Birth Date: (DA, 1, 2) | |
| DcmCodeString | PatientSex |
| Patient's Sex: (CS, 1, 2) | |
| DcmLongString | Manufacturer |
| Manufacturer: (LO, 1, 2) | |
| DcmLongString | ManufacturerModelName |
| Manufacturer's Model Name: (LO, 1, 3) | |
| DcmLongString | DeviceSerialNumber |
| Device Serial Number: (LO, 1, 3) | |
| DcmLongString | SoftwareVersions |
| Software Version(s): (LO, 1-n, 3) | |
| DcmCodeString | Modality |
| Manufacturer's Model Name: (LO, 1, 1) | |
| DcmUniqueIdentifier | SeriesInstanceUID |
| Series Instance Number: (UI, 1, 1) | |
| DcmIntegerString | SeriesNumber |
| Series Number: (IS, 1, 1) | |
| DcmDate | SeriesDate |
| Series Date: (DA, 1, 3) | |
| DcmTime | SeriesTime |
| Series Time: (TM, 1, 3) | |
| DcmLongString | SeriesDescription |
| Series Description: (LO, 1, 3) | |
| DcmSequenceOfItems | ReferencedPerformedProcedureStep |
| Referenced Performed Procedure Step Sequence: (SQ, 1, 2) | |
| DcmIntegerString | InstanceNumber |
| Instance Number: (IS, 1, 1) | |
| DcmCodeString | PreliminaryFlag |
| Preliminary Flag: (CS, 1, 3) | |
| DcmCodeString | CompletionFlag |
| Completion Flag: (CS, 1, 1) | |
| DcmLongString | CompletionFlagDescription |
| Completion Flag Description: (LO, 1, 3) | |
| DcmCodeString | VerificationFlag |
| Verification Flag: (CS, 1, 1) | |
| DcmDate | ContentDate |
| Content Date: (DA, 1, 1) | |
| DcmTime | ContentTime |
| Content Time: (TM, 1, 1) | |
| DcmSequenceOfItems | VerifyingObserver |
| Verifying Observer Sequence: (SQ, 1, 1C) | |
| DSRSOPInstanceReferenceList | PredecessorDocuments |
| Predecessor Documents Sequence: (SQ, 1, 1C) | |
| DSRSOPInstanceReferenceList | IdenticalDocuments |
| Identical Documents Sequence: (SQ, 1, 1C) | |
| DcmSequenceOfItems | PerformedProcedureCode |
| Performed Procedure Code Sequence: (SQ, 1, 2) | |
| DSRSOPInstanceReferenceList | CurrentRequestedProcedureEvidence |
| Current Requested Procedure Evidence Sequence: (SQ, 1, 1C) | |
| DSRSOPInstanceReferenceList | PertinentOtherEvidence |
| Pertinent Other Evidence Sequence: (SQ, 1, 1C) | |
| DSRReferencedInstanceList | ReferencedInstances |
| Referenced Instance Sequence: (SQ, 1, 1C) | |
Detailed Description
Interface class for 'dcmsr' (DICOM Structured Reporting Documents).
This class supports reading, writing, creation, printing and rendering of DICOM Structured Reporting (SR) documents. The list of supported SOP classes is available in file "dsrtypes.h".
Constructor & Destructor Documentation
| DSRDocument::DSRDocument | ( | const E_DocumentType | documentType = DT_BasicTextSR | ) |
(default) constructor.
The parameter 'documentType' is optional and has a default value.
- Parameters:
-
documentType type of the SR document (see DSRTypes::E_DocumentType)
Member Function Documentation
| OFCondition DSRDocument::checkDatasetForReading | ( | DcmItem & | dataset, |
| E_DocumentType & | documentType | ||
| ) | [protected] |
check the given dataset before reading.
This methods checks whether the dataset contains at least the DICOM attributes SOP class UID and modality. Any incorrectness regarding these two attributes is reported to the log stream (if valid). Currently unsupported SOP classes are also reported as an error.
- Parameters:
-
dataset DICOM dataset to be checked documentType SR document type retrieved from the SOP class UID
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::completeDocument | ( | ) | [virtual] |
complete the current document.
Sets the completion flag to COMPLETE if not already done (fails otherwise). The completion flag description is set to an empty string (i.e. absent in DICOM dataset). Not applicable to Key Object Selection Documents.
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::completeDocument | ( | const OFString & | description, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
complete the current document and set a completion description.
Sets the completion flag to COMPLETE if not already done (fails otherwise). The completion flag description can be modified independently from the flag by means of the method setCompletionFlagDescription() - see above. Not applicable to Key Object Selection Documents.
- Parameters:
-
description explanation of the value set for completion flag. (optional, see previous method, VR=LO) check check 'description' for conformance with VR and VM if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::createNewDocument | ( | ) | [virtual] |
create a new document.
A new SOP instance is only created if the current document type was valid/supported. Please note that the current document is deleted (cleared).
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::createNewDocument | ( | const E_DocumentType | documentType | ) | [virtual] |
create a new document of the specified type.
A new SOP instance is only created if the current document type was valid/supported. Please note that the current document is deleted by this method.
- Parameters:
-
documentType type of the SR document (see DSRTypes::E_DocumentType)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual void DSRDocument::createNewSeries | ( | ) | [virtual] |
create a new series.
After generating a new series instance UID the method createNewSOPInstance() is called, i.e. also a SOP series-related attributes are cleared.
| virtual OFCondition DSRDocument::createNewSeriesInStudy | ( | const OFString & | studyUID, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
create a new series within a given study.
After generating a new series instance UID within the given study the method createNewSOPInstance() is called, i.e. also a SOP instance UID is generated. This is a requirement of the DICOM standard. NB: There is no mechanism that makes sure that the study-related attributes are consistent for all series of a study. This has to be done manually.
- Parameters:
-
studyUID study instance UID to be set (should be a valid UID) check check 'studyUID' for conformance with VR and VM if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual void DSRDocument::createNewSOPInstance | ( | ) | [virtual] |
create a new SOP instance.
Generate a new SOP instance UID, set the instance creation date/time and reset the finalized flag (OFFalse). This method is used internally for createNewDocument(), createRevisedVersion() and during object initialization. It could also be used explicitly from the calling application if a new UID should be created (this is the case if the study instance UID or series instance UID has changed as well as any other attribute within the SR Document General Module or SR Document Content Module, see DICOM standard for details). This method also updates the other DICOM header attributes (calling updateAttributes()).
| virtual void DSRDocument::createNewStudy | ( | ) | [virtual] |
create new study.
After generating a new study instance UID the method createNewSeries() is called, i.e. also a new series instance UID and SOP instance UID are generated. This is a requirement of the DICOM standard. All other study-related attributes are cleared.
| virtual OFCondition DSRDocument::createRevisedVersion | ( | const OFBool | clearList = OFTrue | ) | [virtual] |
create a revised version of the current document.
A revised version can only be created if the current document is already completed (see completion flag). If so, a reference to the current document is added to the predecessor documents sequence. If all revised versions of a SR document are stored (written to datasets/files) it is possible to trace back the full chain of previous versions. A new SOP instance is created and the content date/time are set automatically. Furthermore, the verifying observer and identical documents sequence are deleted, the verification flag is set to UNVERIFIED, the completion flag is set to PARTIAL (i.e. not complete), the completion flag description is deleted, all digital signatures contained in the document tree are deleted and the finalized flag is reset (OFFalse). The preliminary flag is not modified by this method. Also the various lists of referenced instances remain unchanged, i.e. they have to be adapted manually if needed. Not applicable to Key Object Selection Documents.
- Parameters:
-
clearList clear list of predecessor documents before adding the current document if OFTrue. Append current document to existing list otherwise.
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::finalizeDocument | ( | ) | [virtual] |
finalize the current state of the document.
A new document is originally not finalized but can be finalized using this method. This internal flag is e.g. used to indicate whether the entire document is digitally signed and, therefore, each newly added verifying observer would corrupt all previous signatures. NB: A document needs to be completed first in order to be finalized. Some of the above document management functions do reset the flag (i.e. set the FinalizedFlag to OFFalse), other methods (e.g. setXXX) do not change the flag though the state of the document is not finalized any more after they have been called. Not applicable to Key Object Selection Documents since there's no completion flag in this type of SR document. Please note that this method has nothing to do with the preliminary flag.
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getAccessionNumber | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get accession number
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual DSRCodingSchemeIdentificationList& DSRDocument::getCodingSchemeIdentification | ( | ) | [virtual] |
get list of coding schemes used (Coding Scheme Identification).
The Coding Scheme Identification Sequence maps Coding Scheme Designators to an external coding system registration, or to a private or local coding scheme. See DICOM standard for details.
- Returns:
- reference to list object
| virtual E_CompletionFlag DSRDocument::getCompletionFlag | ( | ) | const [virtual] |
get document completion flag.
Not applicable to Key Object Selection Documents.
- Returns:
- completion flag (might be CF_invalid if read from dataset)
| virtual OFCondition DSRDocument::getCompletionFlagDescription | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get completion flag description.
Not applicable to Key Object Selection Documents.
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getContentDate | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get content date
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getContentTime | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get content time
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual DSRSOPInstanceReferenceList& DSRDocument::getCurrentRequestedProcedureEvidence | ( | ) | [virtual] |
get list of referenced SOP instances (Current Requested Procedure Evidence).
The DICOM standard states: "The intent of the Current Requested Procedure Evidence Sequence is to reference all evidence created in order to satisfy the current Requested Procedure(s) for this SR Document. This shall include, but is not limited to, all current evidence referenced in the content tree." and "For a completed SR Document satisfying (i.e., being the final report for) the current Requested Procedure(s), this sequence shall list the full set of Composite SOP Instances created for the current Requested Procedure(s). For other SOP Instances that include the SR Document General Module, this sequence shall contain at minimum the set of Composite SOP Instances from the current Requested Procedure(s) that are referenced in the content tree." and "In the context of the Key Object Selection, the current evidence is considered to be only the set of instances referenced within the Key Object Selection."
- Returns:
- reference to list object
| virtual OFCondition DSRDocument::getDeviceSerialNumber | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get device serial number
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual E_DocumentType DSRDocument::getDocumentType | ( | ) | const [virtual] |
get the current SR document type
- Returns:
- document type (might be DT_invalid if read from dataset)
| virtual DSRSOPInstanceReferenceList& DSRDocument::getIdenticalDocuments | ( | ) | [virtual] |
get list of identical documents.
Please note that currently the user is responsible for filling and modifying the content of this list. However, the list is automatically cleared when a new instance is created (incl. a revised version of the current document). Possibly, there will be a createDuplicate() method or the like in the future which creates an identical copy of the current document in a new study/series. The DICOM standard states: "If identical copies of an SR Document are to be included in multiple Studies then the entire SR Document shall be duplicated with appropriate changes for inclusion into the different Studies (i.e. Study Instance UID, Series Instance UID, SOP Instance UID, Identical Documents Sequence etc.). The Identical Documents Sequence Attribute in each SOP Instance shall contain references to all other duplicate SOP Instances."
- Returns:
- reference to list object
| virtual OFCondition DSRDocument::getInstanceCreationDate | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get instance creation date
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getInstanceCreationTime | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get instance creation time
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getInstanceCreatorUID | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get instance creator UID
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getInstanceNumber | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get instance number
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getManufacturer | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get manufacturer
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getManufacturerModelName | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get manufacturer's model name
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getModality | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get modality
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual size_t DSRDocument::getNumberOfVerifyingObservers | ( | ) | [virtual] |
get number of verifying observers.
A document can be verified more than once. The verification flag should be VERIFIED if any verifying observer is specified. The details on the observer can be retrieved using the getVerifyingObserver() methods. Not applicable to Key Object Selection Documents.
- Returns:
- number of verifying observers (if any), 0 otherwise
| virtual OFCondition DSRDocument::getPatientBirthDate | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get patient's birth date
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getPatientID | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get patient ID
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getPatientName | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get patient's name
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getPatientSex | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get patient's sex
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual DSRSOPInstanceReferenceList& DSRDocument::getPertinentOtherEvidence | ( | ) | [virtual] |
get list of referenced SOP instances (Pertinent Other Evidence).
The DICOM standard states: "The Pertinent Other Evidence Sequence attribute is used to reference all other evidence considered pertinent for this SR Document that is not listed in the Current Requested Procedure Evidence Sequence. This requires that the same SOP Instance shall not be referenced in both of these Sequences." Not applicable to Key Object Selection Documents.
- Returns:
- reference to list object
| virtual DSRSOPInstanceReferenceList& DSRDocument::getPredecessorDocuments | ( | ) | [virtual] |
get list of predecessor documents.
A document can have more than one (direct) predecessor document. This is e.g. the case when two or more documents have been merged to create it. The corresponding method createRevisedVersion() automatically adds a reference to the current document. The DICOM standard states: "[The Predecessor Documents Sequence] Shall refer to SR SOP Instances (e.g. prior or provisional reports) whose content has been wholly or partially included in this document with or without modification." and "[...] the use of the Predecessor Document Sequence allows tracing back to the input SR Document, which in this case is the previous version." Not applicable to Key Object Selection Documents.
- Returns:
- reference to list object
| virtual E_PreliminaryFlag DSRDocument::getPreliminaryFlag | ( | ) | const [virtual] |
get document preliminary flag.
Not applicable to Key Object Selection Documents.
- Returns:
- preliminary flag (might be PF_invalid if not specified)
| virtual DSRReferencedInstanceList& DSRDocument::getReferencedInstances | ( | ) | [virtual] |
get list of referenced SOP instances significantly related to the current SOP instance.
The DICOM standard states: "Such referenced Instances may include equivalent documents or renderings of this document. [...] Required if the identity of a CDA Document equivalent to the current SOP Instance is known at the time of creation of this SOP instance. May be present otherwise." Note: An equivalent rendering of the document might be provided as an "Encapsulated PDF" DICOM object. Not applicable to Key Object Selection Documents.
- Returns:
- reference to list object
| virtual OFCondition DSRDocument::getReferringPhysicianName | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get referring physician's name
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSeriesDate | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get series date
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSeriesDescription | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get series description
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSeriesInstanceUID | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get series instance UID
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSeriesNumber | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get series number
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSeriesTime | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get series time
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSoftwareVersions | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get software version(s).
Please note that only the first component is returned.
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSOPClassUID | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get SOP class UID
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSOPInstanceUID | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get SOP instance UID
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getSpecificCharacterSet | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get specific character set
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual E_CharacterSet DSRDocument::getSpecificCharacterSetType | ( | ) | const [virtual] |
get specific character set type.
If the type is unknown the original DICOM defined term can be retrieved with the method getSpecificCharacterSet(). Please note that only the first of possibly multiple values is used to determine the type from the given DICOM code string (multiple character sets are not yet supported).
- Returns:
- character set (might be CS_invalid/unknown if not supported)
| virtual OFCondition DSRDocument::getStudyDate | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get study date
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getStudyDescription | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get study description
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getStudyID | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get study ID
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getStudyInstanceUID | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get study instance UID
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getStudyTime | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const [virtual] |
get study time
- Parameters:
-
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
- Returns:
- status, EC_Normal if successful, an error code otherwise
| DSRDocumentTree& DSRDocument::getTree | ( | ) | [inline] |
get document tree
- Returns:
- reference to the document tree
| virtual E_VerificationFlag DSRDocument::getVerificationFlag | ( | ) | const [virtual] |
get document verification flag.
Not applicable to Key Object Selection Documents.
- Returns:
- verification flag (might be VF_invalid if read from dataset)
| virtual OFCondition DSRDocument::getVerifyingObserver | ( | const size_t | idx, |
| OFString & | dateTime, | ||
| OFString & | observerName, | ||
| OFString & | organization | ||
| ) | [virtual] |
get information about a verifying observer.
All reference variables are cleared before the information is retrieved, i.e. if an error occurs (return value != EC_Normal) non-empty variables do contain valid (empty) data. Not applicable to Key Object Selection Documents.
- Parameters:
-
idx index of the verifying observer to be retrieved (starting with 1). Use getNumberOfVerifyingObservers() to get the maximum value. dateTime reference to variable where the date and time when this document has been verified should be stored (required) observerName reference to variable where the name of the person who has verified this document should be stored (required) organization reference to variable where the name of the organization to which the observer belongs should be stored (required)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::getVerifyingObserver | ( | const size_t | idx, |
| OFString & | dateTime, | ||
| OFString & | observerName, | ||
| DSRCodedEntryValue & | observerCode, | ||
| OFString & | organization | ||
| ) | [virtual] |
get information about a verifying observer.
All reference variables are cleared before the information is retrieved, i.e. if an error occurs (return value != EC_Normal) non-empty variables do contain valid (empty) data. Not applicable to Key Object Selection Documents.
- Parameters:
-
idx index of the verifying observer to be retrieved (starting with 1). Use getNumberOfVerifyingObservers() to get the maximum value. dateTime reference to variable where the date and time when this document has been verified should be stored (required) observerName reference to variable where the name of the person who has verified this document should be stored (required) observerCode reference to variable where the observer code should be stored. code identifying the verifying observer (optional, see previous method) organization reference to variable where the name of the organization to which the observer belongs should be stored (required)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFBool DSRDocument::isFinalized | ( | ) | const [virtual] |
check whether the document is finalized.
A new document is originally not finalized but can be finalized using the method finalizeDocument(). This flag is e.g. used to indicate whether the entire document is digitally signed and, therefore, each newly added verifying observer would corrupt all previous signatures.
- Returns:
- OFTrue if finalized, OFFalse otherwise
| virtual OFBool DSRDocument::isValid | ( | ) | [virtual] |
check whether the current internal state is valid.
The SR document is valid if the corresponding document tree is valid and the SOP instance UID as well as the SOP class UID are not "empty".
- Returns:
- OFTrue if valid, OFFalse otherwise
| virtual OFCondition DSRDocument::print | ( | STD_NAMESPACE ostream & | stream, |
| const size_t | flags = 0 |
||
| ) | [virtual] |
print current SR document to specified output stream.
The output format is identical to that of the dsrdump command line tool.
- Parameters:
-
stream output stream (e.g. COUT from "ofconsol.h") flags optional flag used to customize the output (see DSRTypes::PF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::read | ( | DcmItem & | dataset, |
| const size_t | flags = 0 |
||
| ) | [virtual] |
read SR document from DICOM dataset.
Please note that the current document is also deleted if the reading process fails. If the log stream is set and valid the reason for any error might be obtained from the error/warning output.
- Parameters:
-
dataset reference to DICOM dataset from which the document should be read flags optional flag used to customize the reading process (see DSRTypes::RF_xxx). E.g. RF_readDigitalSignatures indicates whether to read the digital signatures from the dataset or not. If set the MACParametersSequence and the DigitalSignaturesSequence are read for the general document header (equivilent to top-level content item) and each content item of the document tree. If not removed manually (with 'DSRDocumentTree::removeSignatures') the signatures are written back to the dataset when the method 'write' is called. Please note that the two signature sequences for any other sequence (e.g. VerifyingObserver or PredecessorDocuments) are never read.
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::readXML | ( | const OFString & | filename, |
| const size_t | flags = 0 |
||
| ) | [virtual] |
read SR document from XML file.
The format (Schema) of the XML document is expected to conform to the output format of the writeXML() method. In addition, the document can be validated against an XML Schema by setting the flag XF_validateSchema. Digital signatures in the XML document are not yet supported. Please note that the current document is also deleted if the parsing process fails.
- Parameters:
-
filename name of the file from which the XML document is read ("-" for stdin) flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DSRDocument::readXMLDocumentData | ( | const DSRXMLDocument & | doc, |
| DSRXMLCursor | cursor, | ||
| const size_t | flags | ||
| ) | [protected] |
read XML "document" data
- Parameters:
-
doc document containing the XML file content cursor cursor pointing to the starting node flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DSRDocument::readXMLDocumentHeader | ( | DSRXMLDocument & | doc, |
| DSRXMLCursor | cursor, | ||
| const size_t | flags | ||
| ) | [protected] |
read XML document header
- Parameters:
-
doc document containing the XML file content cursor cursor pointing to the starting node flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DSRDocument::readXMLInstanceData | ( | const DSRXMLDocument & | doc, |
| DSRXMLCursor | cursor, | ||
| const size_t | flags | ||
| ) | [protected] |
read XML "instance" data
- Parameters:
-
doc document containing the XML file content cursor cursor pointing to the starting node flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DSRDocument::readXMLPatientData | ( | const DSRXMLDocument & | doc, |
| DSRXMLCursor | cursor, | ||
| const size_t | flags | ||
| ) | [protected] |
read XML "patient" data
- Parameters:
-
doc document containing the XML file content cursor cursor pointing to the starting node flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DSRDocument::readXMLSeriesData | ( | const DSRXMLDocument & | doc, |
| DSRXMLCursor | cursor, | ||
| const size_t | flags | ||
| ) | [protected] |
read XML "series" data
- Parameters:
-
doc document containing the XML file content cursor cursor pointing to the starting node flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DSRDocument::readXMLStudyData | ( | const DSRXMLDocument & | doc, |
| DSRXMLCursor | cursor, | ||
| const size_t | flags | ||
| ) | [protected] |
read XML "study" data
- Parameters:
-
doc document containing the XML file content cursor cursor pointing to the starting node flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DSRDocument::readXMLVerifyingObserverData | ( | const DSRXMLDocument & | doc, |
| DSRXMLCursor | cursor, | ||
| const size_t | flags | ||
| ) | [protected] |
read XML verifying observer data
- Parameters:
-
doc document containing the XML file content cursor cursor pointing to the starting node flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual void DSRDocument::removeVerification | ( | ) | [virtual] |
remove verification information.
The list of verifying observers is cleared, the verification flag is set to UNVERIFIED and the finalized flag is reset (set to OFFalse). Normally, there should be no need to call this method. On the other hand, it is useful to guarantee a consistent state when processing documents which have not been created with this module/toolkit.
| virtual OFCondition DSRDocument::renderHTML | ( | STD_NAMESPACE ostream & | stream, |
| const size_t | flags = 0, |
||
| const char * | styleSheet = NULL |
||
| ) | [virtual] |
render current SR document in HTML/XHTML format.
The output format is identical to that of the dsr2html command line tool.
- Parameters:
-
stream output stream to which the HTML/XHTML document is written flags optional flag used to customize the output (see DSRTypes::HF_xxx) styleSheet optional filename/URL of a Cascading Style Sheet (CSS)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| void DSRDocument::renderHTMLPatientData | ( | STD_NAMESPACE ostream & | stream, |
| const size_t | flags | ||
| ) | [protected] |
render patient name, sex, birthdate and ID in HTML/XHTML format
- Parameters:
-
stream output stream to which the HTML/XHTML document is written flags flag used to customize the output (see DSRTypes::HF_xxx)
| void DSRDocument::renderHTMLReferenceList | ( | STD_NAMESPACE ostream & | stream, |
| DSRSOPInstanceReferenceList & | refList, | ||
| const size_t | flags | ||
| ) | [protected] |
render list of referenced SOP instances in HTML/XHTML format
- Parameters:
-
stream output stream to which the HTML/XHTML document is written refList list of referenced SOP instances to be rendered flags flag used to customize the output (see DSRTypes::HF_xxx)
| void DSRDocument::renderHTMLReferenceList | ( | STD_NAMESPACE ostream & | stream, |
| DSRReferencedInstanceList & | refList, | ||
| const size_t | flags | ||
| ) | [protected] |
render list of referenced SOP instances in HTML/XHTML format
- Parameters:
-
stream output stream to which the HTML/XHTML document is written refList list of referenced SOP instances to be rendered flags flag used to customize the output (see DSRTypes::HF_xxx)
| virtual OFCondition DSRDocument::setAccessionNumber | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set accession number
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (SH) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setCompletionFlagDescription | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set completion flag description.
Not applicable to Key Object Selection Documents.
- Parameters:
-
value explanation of the value that is set for completion flag. If an empty string is passed, the description is removed from the dataset (type 3). check check 'value' for conformance with VR (LO) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setContentDate | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set content date
- Parameters:
-
value value to be set (single value only). If an empty string is passed, the current date is set when displaying or writing the document since the corresponding DICOM attribute is mandatory. check check 'value' for conformance with VR (DA) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setContentTime | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set content time
- Parameters:
-
value value to be set (single value only). If an empty string is passed, the current time is set when displaying or writing the document since the corresponding DICOM attribute is mandatory. check check 'value' for conformance with VR (TM) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setDeviceSerialNumber | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set device serial number
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (LO) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setInstanceNumber | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set instance number
- Parameters:
-
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. check check 'value' for conformance with VR (IS) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setManufacturer | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set manufacturer
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (LO) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setManufacturerModelName | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set manufacturer's model name
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (LO) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setPatientBirthDate | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set patient's birth date
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (DA) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setPatientID | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set patient ID
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (LO) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setPatientName | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set patient's name
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (PN) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setPatientSex | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set patient's sex
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (CS) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setPreliminaryFlag | ( | const E_PreliminaryFlag | flag | ) | [virtual] |
set document preliminary flag.
According to the DICOM standard, the concept of "completeness" is independent of the concept of "preliminary" or "final". Therefore, this flag can be specified separately.
- Parameters:
-
flag preliminary flag to be set (use PF_invalid to omit this optional value)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setReferringPhysicianName | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set referring physician's name
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (PN) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setSeriesDate | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set series date
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (DA) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setSeriesDescription | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set series description
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (LO) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setSeriesNumber | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set series number
- Parameters:
-
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. check check 'value' for conformance with VR (IS) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setSeriesTime | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set series time
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (TM) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setSoftwareVersions | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set software version(s)
- Parameters:
-
value value to be set (possibly multi-valued) or "" for no value check check 'value' for conformance with VR (LO) and VM (1-n) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setSpecificCharacterSet | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [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.
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (CS) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setSpecificCharacterSetType | ( | const E_CharacterSet | characterSet | ) | [virtual] |
set specific character set type.
The DICOM defined term (see SpecificCharacterSet) is set accordingly.
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setStudyDate | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set study date
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (DA) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setStudyDescription | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set study description
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (LO) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setStudyID | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set study ID
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (SH) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::setStudyTime | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
set study time
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (TM) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| void DSRDocument::updateAttributes | ( | const OFBool | updateAll = OFTrue | ) | [protected] |
update several DICOM attributes.
(e.g. set the modality attribute, generate a new SOP instance UID if required, set date/time, etc.)
- Parameters:
-
updateAll flag indicating whether all DICOM attributes should be updated or only the completion and verification flag. (set DICOM defined terms from enum values)
| virtual OFCondition DSRDocument::verifyDocument | ( | const OFString & | observerName, |
| const OFString & | organization, | ||
| const OFString & | dateTime = "", |
||
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
verify the current document by a specific observer.
A document can be verified more than once. The observer information is added to a sequence stored in the dataset. The verification flag is automatically set to VERIFIED (if not already done) and the finalized flag is reset (set to OFFalse). Please note that only completed documents (see completion flag) can be verified and that a new SOP instance UID has to be generated (manually) according to the DICOM standard when creating a dataset/file from this document. Not applicable to Key Object Selection Documents.
- Parameters:
-
observerName name of the person who has verified this document (required, VR=PN) organization name of the organization to which the observer belongs (required, VR=LO) dateTime verification date time (optional). If empty/absent the current date and time are used. check check 'observerName', 'organization' and 'dateTime' for conformance with VR and VM if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::verifyDocument | ( | const OFString & | observerName, |
| const DSRCodedEntryValue & | observerCode, | ||
| const OFString & | organization, | ||
| const OFString & | dateTime = "", |
||
| const OFBool | check = OFTrue |
||
| ) | [virtual] |
verify the current document by a specific observer.
A document can be verified more than once. The observer information is added to a sequence stored in the dataset. The verification flag is automatically set to VERIFIED (if not already done) and the finalized flag is reset (set to OFFalse). Please note that only completed documents (see completion flag) can be verified and that a new SOP instance UID has to be generated (manually) according to the DICOM standard when creating a dataset/file from this document. Not applicable to Key Object Selection Documents.
- Parameters:
-
observerName name of the person who has verified this document (required, VR=PN) observerCode code identifying the verifying observer (optional, see previous method) organization name of the organization to which the observer belongs (required, VR=LO) dateTime verification date time (optional). If empty/absent the current date and time are used. check check 'observerName', 'observerCode', 'organization' and 'dateTime' for conformance with VR and VM if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::write | ( | DcmItem & | dataset, |
| DcmStack * | markedItems = NULL |
||
| ) | [virtual] |
write current SR document to DICOM dataset.
Please note that the ContentTemplateSequence for the root content item is not written automatically for particular SOP Classes (e.g. Key Object Selection Document). Instead, the template identification has to be set manually for the root CONTAINER (see DSRDocumentTreeNode::setTemplateIdentification()). This is because the template constraints cannot be checked yet.
- Parameters:
-
dataset reference to DICOM dataset to which the current document should be written. The 'dataset' is not cleared before writing to it! markedItems optional stack where pointers to all 'marked' content items (DICOM datasets/items) are added to during the write process. Can be used to digitally sign parts of the document tree.
- Returns:
- status, EC_Normal if successful, an error code otherwise
| virtual OFCondition DSRDocument::writeXML | ( | STD_NAMESPACE ostream & | stream, |
| const size_t | flags = 0 |
||
| ) | [virtual] |
write current SR document in XML format.
The output format is identical to that of the dsr2xml command line tool. Digital signatures in the XML document are not yet supported.
- Parameters:
-
stream output stream to which the XML document is written flags optional flag used to customize the output (see DSRTypes::XF_xxx)
- Returns:
- status, EC_Normal if successful, an error code otherwise
Member Data Documentation
DcmCodeString DSRDocument::Modality [private] |
Manufacturer's Model Name: (LO, 1, 1)
Device Serial Number: (LO, 1, 1) Software Version(s): (LO, 1-n, 1) Modality: (CS, 1, 1)
The documentation for this class was generated from the following file:
- dcmsr/include/dcmtk/dcmsr/dsrdoc.h