Inheritance diagram for DSRTypes:
Public Types | |
enum | E_DocumentType { DT_invalid, DT_unknown = DT_invalid, DT_BasicTextSR, DT_EnhancedSR, DT_ComprehensiveSR, DT_KeyObjectDoc, DT_MammographyCadSR, DT_ChestCadSR, DT_ProcedureLog, DT_last = DT_ProcedureLog } |
SR document types. More... | |
enum | E_RelationshipType { RT_invalid, RT_unknown = RT_invalid, RT_isRoot, RT_contains, RT_hasObsContext, RT_hasAcqContext, RT_hasConceptMod, RT_hasProperties, RT_inferredFrom, RT_selectedFrom, RT_last = RT_selectedFrom } |
SR relationship types. More... | |
enum | E_ValueType { VT_invalid, VT_unknown = VT_invalid, VT_Text, VT_Code, VT_Num, VT_DateTime, VT_Date, VT_Time, VT_UIDRef, VT_PName, VT_SCoord, VT_TCoord, VT_Composite, VT_Image, VT_Waveform, VT_Container, VT_byReference, VT_last = VT_byReference } |
SR value types. More... | |
enum | E_GraphicType { GT_invalid, GT_unknown = GT_invalid, GT_Point, GT_Multipoint, GT_Polyline, GT_Circle, GT_Ellipse, GT_last = GT_Ellipse } |
SR graphic types. More... | |
enum | E_TemporalRangeType { TRT_invalid, TRT_unknown = TRT_invalid, TRT_Point, TRT_Multipoint, TRT_Segment, TRT_Multisegment, TRT_Begin, TRT_End, TRT_last = TRT_End } |
SR temporal range types. More... | |
enum | E_ContinuityOfContent { COC_invalid, COC_Separate, COC_Continuous, COC_last = COC_Continuous } |
SR continuity of content flag. More... | |
enum | E_CompletionFlag { CF_invalid, CF_Partial, CF_Complete, CF_last = CF_Complete } |
SR document completion flag. More... | |
enum | E_VerificationFlag { VF_invalid, VF_Unverified, VF_Verified, VF_last = VF_Verified } |
SR document verification flag. More... | |
enum | E_CharacterSet { CS_invalid, CS_unknown = CS_invalid, CS_ASCII, CS_Latin1, CS_Latin2, CS_Latin3, CS_Latin4, CS_Latin5, CS_Cyrillic, CS_Arabic, CS_Greek, CS_Hebrew, CS_Thai, CS_Japanese, CS_last = CS_Japanese } |
Specific character set. More... | |
enum | E_AddMode { AM_afterCurrent, AM_beforeCurrent, AM_belowCurrent } |
Add node mode. More... | |
Static Public Member Functions | |
const char * | documentTypeToSOPClassUID (const E_DocumentType documentType) |
convert SR document type to SOP class UID | |
const char * | documentTypeToModality (const E_DocumentType documentType) |
convert SR document type to modality | |
const char * | documentTypeToReadableName (const E_DocumentType documentType) |
convert SR document type to readable name. | |
const char * | documentTypeToDocumentTitle (const E_DocumentType documentType, OFString &documentTitle) |
convert SR document type to document title. | |
const char * | relationshipTypeToDefinedTerm (const E_RelationshipType relationshipType) |
convert relationship type to DICOM defined term | |
const char * | relationshipTypeToReadableName (const E_RelationshipType relationshipType) |
convert relationship type to readable name. | |
const char * | valueTypeToDefinedTerm (const E_ValueType valueType) |
convert value type to DICOM defined term | |
const char * | valueTypeToXMLTagName (const E_ValueType valueType) |
convert value type to XML tag name | |
const char * | valueTypeToReadableName (const E_ValueType valueType) |
convert value type to readable name. | |
const char * | graphicTypeToEnumeratedValue (const E_GraphicType graphicType) |
convert graphic type to DICOM enumerated value | |
const char * | graphicTypeToReadableName (const E_GraphicType graphicType) |
convert graphic type to readable name. | |
const char * | temporalRangeTypeToEnumeratedValue (const E_TemporalRangeType temporalRangeType) |
convert temporal range type to DICOM enumerated value | |
const char * | temporalRangeTypeToReadableName (const E_TemporalRangeType temporalRangeType) |
convert temporal range type to readable name. | |
const char * | continuityOfContentToEnumeratedValue (const E_ContinuityOfContent continuityOfContent) |
convert continuity of content flag to DICOM enumerated value | |
const char * | completionFlagToEnumeratedValue (const E_CompletionFlag completionFlag) |
convert completion flag to DICOM enumerated value | |
const char * | verificationFlagToEnumeratedValue (const E_VerificationFlag verificationFlag) |
convert verification flag to DICOM enumerated value | |
const char * | characterSetToDefinedTerm (const E_CharacterSet characterSet) |
convert character set to DICOM defined term | |
const char * | characterSetToHTMLName (const E_CharacterSet characterSet) |
convert character set to HTML name. | |
const char * | characterSetToXMLName (const E_CharacterSet characterSet) |
convert character set to XML name. | |
E_DocumentType | sopClassUIDToDocumentType (const OFString &sopClassUID) |
convert SOP class UID to SR document type | |
E_RelationshipType | definedTermToRelationshipType (const OFString &definedTerm) |
convert DICOM defined term to relationship type | |
E_ValueType | definedTermToValueType (const OFString &definedTerm) |
convert DICOM defined term to value type | |
E_ValueType | xmlTagNameToValueType (const OFString &xmlTagName) |
convert XML tag name to value type | |
E_GraphicType | enumeratedValueToGraphicType (const OFString &enumeratedValue) |
convert DICOM enumerated value to graphic type | |
E_TemporalRangeType | enumeratedValueToTemporalRangeType (const OFString &enumeratedValue) |
convert DICOM enumerated value to temporal range type | |
E_ContinuityOfContent | enumeratedValueToContinuityOfContent (const OFString &enumeratedValue) |
convert DICOM enumerated value to continuity of content flag | |
E_CompletionFlag | enumeratedValueToCompletionFlag (const OFString &enumeratedValue) |
convert DICOM enumerated value to completion flag | |
E_VerificationFlag | enumeratedValueToVerificationFlag (const OFString &enumeratedValue) |
convert DICOM enumerated value to verification flag | |
E_CharacterSet | definedTermToCharacterSet (const OFString &definedTerm) |
convert DICOM defined term to character set | |
OFBool | isDocumentTypeSupported (const E_DocumentType documentType) |
check whether specified SR document type is supported by this library. | |
const OFString & | currentDate (OFString &dateString) |
get current date in DICOM 'DA' format. | |
const OFString & | currentTime (OFString &timeString) |
get current time in DICOM 'TM' format. | |
const OFString & | currentDateTime (OFString &dateTimeString) |
get current date and time in DICOM 'DT' format. | |
const OFString & | dicomToReadableDate (const OFString &dicomDate, OFString &readableDate) |
convert DICOM date string to readable format. | |
const OFString & | dicomToReadableTime (const OFString &dicomTime, OFString &readableTime) |
convert DICOM time string to readable format. | |
const OFString & | dicomToReadableDateTime (const OFString &dicomDateTime, OFString &readableDateTime) |
convert DICOM date time string to readable format. | |
const OFString & | dicomToReadablePersonName (const OFString &dicomPersonName, OFString &readablePersonName) |
convert DICOM person name to readable format. | |
const OFString & | dicomToXMLPersonName (const OFString &dicomPersonName, OFString &xmlPersonName, const OFBool writeEmptyValue=OFFalse) |
convert DICOM person name to XML format. | |
const char * | numberToString (const size_t number, char *stringValue) |
convert unsigned integer number to character string | |
size_t | stringToNumber (const char *stringValue) |
convert string to unsigned integer number | |
const OFString & | convertToPrintString (const OFString &sourceString, OFString &printString) |
convert character string to print string. | |
const OFString & | convertToMarkupString (const OFString &sourceString, OFString &markupString, const OFBool convertNonASCII=OFFalse, const OFBool newlineAllowed=OFFalse, const OFBool xmlMode=OFFalse) |
convert character string to HTML/XML mnenonic string. | |
OFBool | checkForValidUIDFormat (const OFString &stringValue) |
check string for valid UID format. | |
DSRIODConstraintChecker * | createIODConstraintChecker (const E_DocumentType documentType) |
create specified SR IOD content relationship contraint checker object. | |
DSRDocumentTreeNode * | createDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType) |
create specified document tree node. | |
OFCondition | addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *delem) |
add given element to the dataset. | |
void | removeAttributeFromSequence (DcmSequenceOfItems &sequence, const DcmTagKey &tagKey) |
remove given attribute from the sequence. | |
OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &delem) |
get element from dataset | |
OFCondition | getSequenceFromDataset (DcmItem &dataset, DcmSequenceOfItems &dseq) |
get sequence from dataset. | |
const char * | getStringValueFromElement (const DcmElement &delem) |
get string value from element | |
const OFString & | getStringValueFromElement (const DcmElement &delem, OFString &stringValue) |
get string value from element | |
const OFString & | getPrintStringFromElement (const DcmElement &delem, OFString &stringValue) |
get string value from element and convert to "print" format | |
const OFString & | getMarkupStringFromElement (const DcmElement &delem, OFString &stringValue, const OFBool convertNonASCII=OFFalse) |
get string value from element and convert to HTML/XML | |
OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue) |
get string value from dataset | |
OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
put string value to dataset | |
OFBool | checkElementValue (DcmElement &delem, const OFString &vm, const OFString &type, OFConsole *stream=NULL, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL) |
check element value for correct value multipicity and type. | |
OFCondition | getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &delem, const OFString &vm, const OFString &type, OFConsole *stream=NULL, const char *moduleName=NULL) |
get element from dataset and check it for correct value multipicity and type. | |
OFCondition | getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, OFConsole *stream=NULL, const char *moduleName=NULL) |
get string value from dataset and check it for correct value multipicity and type. | |
void | printMessage (OFConsole *stream, const char *message) |
print a message | |
void | printWarningMessage (OFConsole *stream, const char *message) |
print a warning message. | |
void | printErrorMessage (OFConsole *stream, const char *message) |
print a error message. | |
void | printInvalidContentItemMessage (OFConsole *stream, const char *action, const DSRDocumentTreeNode *node, const char *location=NULL) |
print the warning message that the current content item is invalid/incomplete. | |
void | printContentItemErrorMessage (OFConsole *stream, const char *action, const OFCondition &result, const DSRDocumentTreeNode *node, const char *location=NULL) |
print an error message for the current content item. | |
void | printUnknownValueWarningMessage (OFConsole *stream, const char *valueName, const char *readValue=NULL, const char *action="Reading") |
print a warning message that an unknown/unsupported value has been determined | |
OFBool | writeStringValueToXML (ostream &stream, const OFString &stringValue, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
write string value to XML output stream. | |
OFBool | writeStringFromElementToXML (ostream &stream, DcmElement &delem, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
write string value from DICOM element to XML output stream. | |
size_t | createHTMLAnnexEntry (ostream &docStream, ostream &annexStream, const OFString &referenceText, size_t &annexNumber) |
create an HTML annex entry with hyperlinks. | |
size_t | createHTMLFootnote (ostream &docStream, ostream &footnoteStream, size_t &footnoteNumber, const size_t nodeID) |
create an HTML footnote with hyperlinks | |
OFCondition | appendStream (ostream &mainStream, OFOStringStream &tempStream, const char *heading=NULL) |
append one output stream to another. | |
Static Public Attributes | |
read() flags. | |
These flags can be combined and passed to the read() methods.
The 'shortcut' flags can be used for common combinations. | |
const size_t | RF_readDigitalSignatures |
read digital signatures from dataset | |
const size_t | RF_ignoreRelationshipConstraints |
ignore relationship constraints for this document class | |
const size_t | RF_ignoreContentItemErrors |
do not abort on content item errors (e.g. missing value type specific attributes) | |
const size_t | RF_skipInvalidContentItems |
do not abort when detecting an invalid content item, skip invalid sub-tree instead | |
const size_t | RF_verboseDebugMode |
print more detailed debug messages (verbose mode) | |
const size_t | RF_showCurrentlyProcessedItem |
show the currently processed content item (e.g. "1.2.3") | |
renderHTML() flags. | |
These flags can be combined and passed to the renderHMTL() methods.
Please note that only the 'external' flags can be used from outside this library. The 'shortcut' flags can be used for common combinations. | |
const size_t | HF_neverExpandChildrenInline |
external: never expand child nodes inline | |
const size_t | HF_renderInlineCodes |
external: render codes even if they appear inline | |
const size_t | HF_renderConceptNameCodes |
external: render concept name codes (default: code meaning only) | |
const size_t | HF_renderNumericUnitCodes |
external: render the code of the numeric measurement unit | |
const size_t | HF_useCodeMeaningAsUnit |
external: use code meaning for the numeric measurement unit (default: code value) | |
const size_t | HF_renderPatientTitle |
external: use patient information as document title (default: document type) | |
const size_t | HF_renderNoDocumentHeader |
external: render no general document information (header) | |
const size_t | HF_renderDcmtkFootnote |
external: render dcmtk/dcmsr comment at the end of the document | |
const size_t | HF_renderFullData |
external: render the full data of all content items | |
const size_t | HF_copyStyleSheetContent |
external: copy Cascading Style Sheet (CSS) content to HTML file | |
const size_t | HF_version32Compatibility |
external: output compatible to HTML version 3.2 (default: 4.0) | |
const size_t | HF_addDocumentTypeReference |
external: add explicit reference to HTML document type (DTD) | |
const size_t | HF_renderItemsSeparately |
internal: render items separately (for container with SEPARATE flag) | |
const size_t | HF_renderItemInline |
internal: expand items inline when they are short and have no child nodes | |
const size_t | HF_currentlyInsideAnnex |
internal: content item is rendered fully inside the annex | |
const size_t | HF_createFootnoteReferences |
internal: create footnote references | |
const size_t | HF_convertNonASCIICharacters |
internal: convert non-ASCII characters (> #127) to &#nnn; | |
const size_t | HF_renderAllCodes |
shortcut: render all codes | |
const size_t | HF_internalUseOnly |
shortcut: filter all flags that are only used internally | |
read/writeXML() flags. | |
These flags can be combined and passed to the read/writeXML() methods.
The 'shortcut' flags can be used for common combinations. | |
const size_t | XF_writeEmptyTags |
write: write all tags even if their value is empty | |
const size_t | XF_writeTemplateIdentification |
write: write template identification information (TID and mapping resource) | |
const size_t | XF_alwaysWriteItemIdentifier |
write: always write item identifier "id", not only when item is referenced | |
const size_t | XF_codeComponentsAsAttribute |
write: encode code value, coding scheme designator and coding scheme version as attribute instead of element text | |
const size_t | XF_relationshipTypeAsAttribute |
write: encode relationship type as attribute instead of element text | |
const size_t | XF_valueTypeAsAttribute |
write: encode value type as attribute instead of element text | |
const size_t | XF_useDcmsrNamespace |
write: add DCMSR namespace declaration to the XML output | |
const size_t | XF_addSchemaReference |
write: add Schema reference to XML document | |
const size_t | XF_validateSchema |
read: validate content of XML document against Schema | |
const size_t | XF_enableLibxmlErrorOutput |
read: output 'libxml' error and warning messages | |
const size_t | XF_encodeEverythingAsAttribute |
shortcut: combines all XF_xxxAsAttribute write flags (see above) | |
print() flags | |
These flags can be combined and passed to the renderHMTL() methods.
The 'shortcut' flags can be used for common combinations. | |
const size_t | PF_printItemPosition |
print item position ("1.2.3") instead of line indentation | |
const size_t | PF_shortenLongItemValues |
shorten long item value (e.g. long texts) | |
const size_t | PF_printSOPInstanceUID |
print SOP instance UID of referenced objects | |
const size_t | PF_printConceptNameCodes |
print coding scheme designator/version and code value of concept names | |
const size_t | PF_printNoDocumentHeader |
print no general document information (header) | |
const size_t | PF_printTemplateIdentification |
print template identification (TID and mapping resource) | |
const size_t | PF_printAllCodes |
shortcut: print all codes |
Some of them might be moved to 'ofstd' later on. All functions and constants are static and can, therefore, be accessed without creating an instance of this class.
Definition at line 144 of file dsrtypes.h.
|
Add node mode.
|
|
Specific character set.
|
|
SR document completion flag.
|
|
SR continuity of content flag. Used for content item CONTAINER.
|
|
SR document types.
|
|
SR graphic types. Used for content item SCOORD.
|
|
SR relationship types.
|
|
SR temporal range types. Used for content item TCOORD.
|
|
SR value types.
|
|
SR document verification flag.
|
|
add given element to the dataset. The element is only added if 'result' is EC_Normal and the 'delem' pointer is not NULL.
|
|
append one output stream to another.
|
|
convert character set to DICOM defined term
|
|
convert character set to HTML name. This HTML (IANA) name is used to specify the character set in an HTML document.
|
|
convert character set to XML name. This XML name is used to specify the character set in an XML document.
|
|
check element value for correct value multipicity and type. If the 'stream' parameter is valid a warning message is printed automatically if something is wrong.
|
|
check string for valid UID format. The string should be non-empty and consist only of interger numbers separated by "." where the first and the last character of the string are always figures (0..9). Example: 1 or 1.2.3. Please note that this test is not as strict as specified for value representation UI in the DICOM standard (e.g. regarding even length padding or leading '0' for the numbers).
|
|
convert completion flag to DICOM enumerated value
|
|
convert continuity of content flag to DICOM enumerated value
|
|
convert character string to HTML/XML mnenonic string. Characters with special meaning for HTML/XML (e.g. '<' and '&') are replace by the corresponding mnenonics (e.g. "<" and "&"). If flag 'convertNonASCII' is OFTrue all characters > #127 are also converted (useful if only HTML 3.2 is supported which does not allow to specify the character set).
|
|
convert character string to print string.
This method is used to convert character strings for text "print" output. Newline characters '
|
|
create specified document tree node. This is a shortcut and the only location where document tree nodes are created. It facilitates the introduction of new relationship/value types and the maintenance.
|
|
create an HTML annex entry with hyperlinks. A reference text is added to the main document and a new annex entry to the document annex with HTML hyperlinks between both. Example for a reference: '[for details see Annex 1]'
|
|
create an HTML footnote with hyperlinks
|
|
create specified SR IOD content relationship contraint checker object. Please note that the created object has to be deleted by the caller.
|
|
get current date in DICOM 'DA' format. (YYYYMMDD)
|
|
get current date and time in DICOM 'DT' format. (YYYYMMDDHHMMSS) The optional UTC notation (e.g. +0100) as well as the optional fractional second part are currently not supported.
|
|
get current time in DICOM 'TM' format. (HHMMSS) The optional UTC notation (e.g. +0100) is currently not supported.
|
|
convert DICOM defined term to character set
|
|
convert DICOM defined term to relationship type
|
|
convert DICOM defined term to value type
|
|
convert DICOM date string to readable format. The ISO format "YYYY-MM-DD" is used for the readable format.
|
|
convert DICOM date time string to readable format. The format "YYYY-MM-DD, HH:MM" or "YYYY-MM-DD, HH:MM:SS" is used for the readable format.
|
|
convert DICOM person name to readable format. The format "<prefix> <first_name> <middle_name> <last_name>, <suffix>" is used for the readable format. Please note that only the first component group (characters before the first '=') of the DICOM person name is used - see DcmPersonName::getNameComponents() for details.
|
|
convert DICOM time string to readable format. The ISO format "HH:MM" or "HH:MM:SS" (if seconds are available) is used for the readable format.
|
|
convert DICOM person name to XML format. The tags <prefix>, <first>, <middle>, <last> and <suffix> are used for the XML format of a person name. The string is automatically converted to the markup notation (see convertToMarkupString()). Two tags are separated by a newline. Please note that only the first component group (characters before the first '=') of the DICOM person name is used - see DcmPersonName::getNameComponents() for details.
|
|
convert SR document type to document title. This document title is used for printing/rendering.
|
|
convert SR document type to modality
|
|
convert SR document type to readable name. Such a readable name is better suited for printing/rendering.
|
|
convert SR document type to SOP class UID
|
|
convert DICOM enumerated value to completion flag
|
|
convert DICOM enumerated value to continuity of content flag
|
|
convert DICOM enumerated value to graphic type
|
|
convert DICOM enumerated value to temporal range type
|
|
convert DICOM enumerated value to verification flag
|
|
get element from dataset and check it for correct value multipicity and type. If the 'stream' parameter is valid a warning message is printed automatically if something is wrong. This functions calls the above one to check the element value.
|
|
get string value from dataset and check it for correct value multipicity and type. If the 'stream' parameter is valid a warning message is printed automatically if something is wrong. This functions calls the above one to check the element value.
|
|
get element from dataset
|
|
get string value from element and convert to HTML/XML
|
|
get string value from element and convert to "print" format
|
|
get sequence from dataset. This method has been introduced in addition to the above one since in this case all items contained in the sequence are also stored in the resulting parameter.
|
|
get string value from dataset
|
|
get string value from element
|
|
get string value from element
|
|
convert graphic type to DICOM enumerated value
|
|
convert graphic type to readable name. Such a readable name is better suited for printing/rendering.
|
|
check whether specified SR document type is supported by this library. Currently all three general SOP classes, the Key Object Selection Document, the Mammography and Chest CAD SR class as defined in the DICOM 2003 standard are supported.
|
|
convert unsigned integer number to character string
|
|
print an error message for the current content item. The value type (for DEBUG mode also the node ID) is added if the 'node' if specified.
|
|
print a error message. The prefix 'DCMSR - Error: ' is automatically added to the message text.
|
|
print the warning message that the current content item is invalid/incomplete. The value type (for DEBUG mode also the node ID) is added if the 'node' if specified.
|
|
print a message
|
|
print a warning message that an unknown/unsupported value has been determined
|
|
print a warning message. The prefix 'DCMSR - Warning: ' is automatically added to the message text.
|
|
put string value to dataset
|
|
convert relationship type to DICOM defined term
|
|
convert relationship type to readable name. Such a readable name is better suited for printing/rendering.
|
|
remove given attribute from the sequence. All occurrences of the attribute in all items of the sequence are removed.
|
|
convert SOP class UID to SR document type
|
|
convert string to unsigned integer number
|
|
convert temporal range type to DICOM enumerated value
|
|
convert temporal range type to readable name. Such a readable name is better suited for printing/rendering.
|
|
convert value type to DICOM defined term
|
|
convert value type to readable name. Such a readable name is better suited for printing/rendering.
|
|
convert value type to XML tag name
|
|
convert verification flag to DICOM enumerated value
|
|
write string value from DICOM element to XML output stream. The output looks like this: "<" tagName ">" stringValue "</" tagName ">" For elements with DICOM VR=PN the function dicomToXMLPersonName() is used internally.
|
|
write string value to XML output stream. The output looks like this: "<" tagName ">" stringValue "</" tagName ">"
|
|
convert XML tag name to value type
|