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_XRayRadiationDoseSR, DT_last = DT_XRayRadiationDoseSR } |
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_Cyrillic, CS_Arabic, CS_Greek, CS_Hebrew, CS_Latin5, CS_Japanese, CS_Thai, CS_UTF8, CS_last = CS_UTF8 } |
Specific character set. More... | |
enum | E_AddMode { AM_afterCurrent, AM_beforeCurrent, AM_belowCurrent } |
Add node mode. More... | |
Static Public Member Functions | |
static const char * | documentTypeToSOPClassUID (const E_DocumentType documentType) |
convert SR document type to SOP class UID | |
static const char * | documentTypeToModality (const E_DocumentType documentType) |
convert SR document type to modality | |
static const char * | documentTypeToReadableName (const E_DocumentType documentType) |
convert SR document type to readable name. | |
static const char * | documentTypeToDocumentTitle (const E_DocumentType documentType, OFString &documentTitle) |
convert SR document type to document title. | |
static const char * | relationshipTypeToDefinedTerm (const E_RelationshipType relationshipType) |
convert relationship type to DICOM defined term | |
static const char * | relationshipTypeToReadableName (const E_RelationshipType relationshipType) |
convert relationship type to readable name. | |
static const char * | valueTypeToDefinedTerm (const E_ValueType valueType) |
convert value type to DICOM defined term | |
static const char * | valueTypeToXMLTagName (const E_ValueType valueType) |
convert value type to XML tag name | |
static const char * | valueTypeToReadableName (const E_ValueType valueType) |
convert value type to readable name. | |
static const char * | graphicTypeToEnumeratedValue (const E_GraphicType graphicType) |
convert graphic type to DICOM enumerated value | |
static const char * | graphicTypeToReadableName (const E_GraphicType graphicType) |
convert graphic type to readable name. | |
static const char * | temporalRangeTypeToEnumeratedValue (const E_TemporalRangeType temporalRangeType) |
convert temporal range type to DICOM enumerated value | |
static const char * | temporalRangeTypeToReadableName (const E_TemporalRangeType temporalRangeType) |
convert temporal range type to readable name. | |
static const char * | continuityOfContentToEnumeratedValue (const E_ContinuityOfContent continuityOfContent) |
convert continuity of content flag to DICOM enumerated value | |
static const char * | completionFlagToEnumeratedValue (const E_CompletionFlag completionFlag) |
convert completion flag to DICOM enumerated value | |
static const char * | verificationFlagToEnumeratedValue (const E_VerificationFlag verificationFlag) |
convert verification flag to DICOM enumerated value | |
static const char * | characterSetToDefinedTerm (const E_CharacterSet characterSet) |
convert character set to DICOM defined term | |
static const char * | characterSetToHTMLName (const E_CharacterSet characterSet) |
convert character set to HTML name. | |
static const char * | characterSetToXMLName (const E_CharacterSet characterSet) |
convert character set to XML name. | |
static E_DocumentType | sopClassUIDToDocumentType (const OFString &sopClassUID) |
convert SOP class UID to SR document type | |
static E_RelationshipType | definedTermToRelationshipType (const OFString &definedTerm) |
convert DICOM defined term to relationship type | |
static E_ValueType | definedTermToValueType (const OFString &definedTerm) |
convert DICOM defined term to value type | |
static E_ValueType | xmlTagNameToValueType (const OFString &xmlTagName) |
convert XML tag name to value type | |
static E_GraphicType | enumeratedValueToGraphicType (const OFString &enumeratedValue) |
convert DICOM enumerated value to graphic type | |
static E_TemporalRangeType | enumeratedValueToTemporalRangeType (const OFString &enumeratedValue) |
convert DICOM enumerated value to temporal range type | |
static E_ContinuityOfContent | enumeratedValueToContinuityOfContent (const OFString &enumeratedValue) |
convert DICOM enumerated value to continuity of content flag | |
static E_CompletionFlag | enumeratedValueToCompletionFlag (const OFString &enumeratedValue) |
convert DICOM enumerated value to completion flag | |
static E_VerificationFlag | enumeratedValueToVerificationFlag (const OFString &enumeratedValue) |
convert DICOM enumerated value to verification flag | |
static E_CharacterSet | definedTermToCharacterSet (const OFString &definedTerm) |
convert DICOM defined term to character set | |
static OFBool | isDocumentTypeSupported (const E_DocumentType documentType) |
check whether specified SR document type is supported by this library. | |
static const OFString & | currentDate (OFString &dateString) |
get current date in DICOM 'DA' format. | |
static const OFString & | currentTime (OFString &timeString) |
get current time in DICOM 'TM' format. | |
static const OFString & | currentDateTime (OFString &dateTimeString) |
get current date and time in DICOM 'DT' format. | |
static const OFString & | dicomToReadableDate (const OFString &dicomDate, OFString &readableDate) |
convert DICOM date string to readable format. | |
static const OFString & | dicomToReadableTime (const OFString &dicomTime, OFString &readableTime) |
convert DICOM time string to readable format. | |
static const OFString & | dicomToReadableDateTime (const OFString &dicomDateTime, OFString &readableDateTime) |
convert DICOM date time string to readable format. | |
static const OFString & | dicomToReadablePersonName (const OFString &dicomPersonName, OFString &readablePersonName) |
convert DICOM person name to readable format. | |
static const OFString & | dicomToXMLPersonName (const OFString &dicomPersonName, OFString &xmlPersonName, const OFBool writeEmptyValue=OFFalse) |
convert DICOM person name to XML format. | |
static const char * | numberToString (const size_t number, char *stringValue) |
convert unsigned integer number to character string | |
static size_t | stringToNumber (const char *stringValue) |
convert string to unsigned integer number | |
static const OFString & | convertToPrintString (const OFString &sourceString, OFString &printString) |
convert character string to print string. | |
static 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. | |
static OFBool | checkForValidUIDFormat (const OFString &stringValue) |
check string for valid UID format. | |
static DSRIODConstraintChecker * | createIODConstraintChecker (const E_DocumentType documentType) |
create specified SR IOD content relationship contraint checker object. | |
static DSRDocumentTreeNode * | createDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType) |
create specified document tree node. | |
static OFBool | elementContainsExtendedCharacters (DcmElement &elem) |
check if this element contains non-ASCII characters. | |
static OFBool | stringContainsExtendedCharacters (const OFString &s) |
check if this string contains non-ASCII characters. | |
static OFCondition | addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *delem) |
add given element to the dataset. | |
static void | removeAttributeFromSequence (DcmSequenceOfItems &sequence, const DcmTagKey &tagKey) |
remove given attribute from the sequence. | |
static OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &delem) |
get element from dataset | |
static OFCondition | getSequenceFromDataset (DcmItem &dataset, DcmSequenceOfItems &dseq) |
get sequence from dataset. | |
static const char * | getStringValueFromElement (const DcmElement &delem) |
get string value from element | |
static const OFString & | getStringValueFromElement (const DcmElement &delem, OFString &stringValue) |
get string value from element | |
static const OFString & | getPrintStringFromElement (const DcmElement &delem, OFString &stringValue) |
get string value from element and convert to "print" format | |
static const OFString & | getMarkupStringFromElement (const DcmElement &delem, OFString &stringValue, const OFBool convertNonASCII=OFFalse) |
get string value from element and convert to HTML/XML | |
static OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue) |
get string value from dataset | |
static OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
put string value to dataset | |
static 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. | |
static 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. | |
static 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. | |
static void | printMessage (OFConsole *stream, const char *message) |
print a message | |
static void | printWarningMessage (OFConsole *stream, const char *message) |
print a warning message. | |
static void | printErrorMessage (OFConsole *stream, const char *message) |
print a error message. | |
static 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. | |
static 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. | |
static 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 | |
static OFBool | writeStringValueToXML (ostream &stream, const OFString &stringValue, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
write string value to XML output stream. | |
static OFBool | writeStringFromElementToXML (ostream &stream, DcmElement &delem, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
write string value from DICOM element to XML output stream. | |
static size_t | createHTMLAnnexEntry (ostream &docStream, ostream &annexStream, const OFString &referenceText, size_t &annexNumber) |
create an HTML annex entry with hyperlinks. | |
static size_t | createHTMLFootnote (ostream &docStream, ostream &footnoteStream, size_t &footnoteNumber, const size_t nodeID) |
create an HTML footnote with hyperlinks | |
static 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. | |
static const size_t | RF_readDigitalSignatures |
read digital signatures from dataset | |
static const size_t | RF_ignoreRelationshipConstraints |
ignore relationship constraints for this document class | |
static const size_t | RF_ignoreContentItemErrors |
do not abort on content item errors (e.g. missing value type specific attributes) | |
static const size_t | RF_skipInvalidContentItems |
do not abort when detecting an invalid content item, skip invalid sub-tree instead | |
static const size_t | RF_verboseDebugMode |
print more detailed debug messages (verbose mode) | |
static 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. | |
static const size_t | HF_neverExpandChildrenInline |
external: never expand child nodes inline | |
static const size_t | HF_renderInlineCodes |
external: render codes even if they appear inline | |
static const size_t | HF_renderConceptNameCodes |
external: render concept name codes (default: code meaning only) | |
static const size_t | HF_renderNumericUnitCodes |
external: render the code of the numeric measurement unit | |
static const size_t | HF_useCodeMeaningAsUnit |
external: use code meaning for the numeric measurement unit (default: code value) | |
static const size_t | HF_renderPatientTitle |
external: use patient information as document title (default: document type) | |
static const size_t | HF_renderNoDocumentHeader |
external: render no general document information (header) | |
static const size_t | HF_renderDcmtkFootnote |
external: render dcmtk/dcmsr comment at the end of the document | |
static const size_t | HF_renderFullData |
external: render the full data of all content items | |
static const size_t | HF_copyStyleSheetContent |
external: copy Cascading Style Sheet (CSS) content to HTML file | |
static const size_t | HF_version32Compatibility |
external: output compatible to HTML version 3.2 (default: 4.0) | |
static const size_t | HF_addDocumentTypeReference |
external: add explicit reference to HTML document type (DTD) | |
static const size_t | HF_renderItemsSeparately |
internal: render items separately (for container with SEPARATE flag) | |
static const size_t | HF_renderItemInline |
internal: expand items inline when they are short and have no child nodes | |
static const size_t | HF_currentlyInsideAnnex |
internal: content item is rendered fully inside the annex | |
static const size_t | HF_createFootnoteReferences |
internal: create footnote references | |
static const size_t | HF_convertNonASCIICharacters |
internal: convert non-ASCII characters (> #127) to &nnn; | |
static const size_t | HF_renderAllCodes |
shortcut: render all codes | |
static 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. | |
static const size_t | XF_writeEmptyTags |
write: write all tags even if their value is empty | |
static const size_t | XF_writeTemplateIdentification |
write: write template identification information (TID and mapping resource) | |
static const size_t | XF_alwaysWriteItemIdentifier |
write: always write item identifier "id", not only when item is referenced | |
static const size_t | XF_codeComponentsAsAttribute |
write: encode code value, coding scheme designator and coding scheme version as attribute instead of element text | |
static const size_t | XF_relationshipTypeAsAttribute |
write: encode relationship type as attribute instead of element text | |
static const size_t | XF_valueTypeAsAttribute |
write: encode value type as attribute instead of element text | |
static const size_t | XF_templateIdentifierAsAttribute |
write: encode template identifier as attribute instead of element text | |
static const size_t | XF_useDcmsrNamespace |
write: add DCMSR namespace declaration to the XML output | |
static const size_t | XF_addSchemaReference |
write: add Schema reference to XML document | |
static const size_t | XF_validateSchema |
read: validate content of XML document against Schema | |
static const size_t | XF_enableLibxmlErrorOutput |
read: output 'libxml' error and warning messages | |
static const size_t | XF_templateElementEnclosesItems |
read/write: template identification element encloses content items | |
static 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. | |
static const size_t | PF_printItemPosition |
print item position ("1.2.3") instead of line indentation | |
static const size_t | PF_shortenLongItemValues |
shorten long item value (e.g. long texts) | |
static const size_t | PF_printSOPInstanceUID |
print SOP instance UID of referenced objects | |
static const size_t | PF_printConceptNameCodes |
print coding scheme designator/version and code value of concept names | |
static const size_t | PF_printNoDocumentHeader |
print no general document information (header) | |
static const size_t | PF_printTemplateIdentification |
print template identification (TID and mapping resource) | |
static 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.
SR document types.
Definition at line 323 of file dsrtypes.h.
SR relationship types.
Definition at line 351 of file dsrtypes.h.
SR value types.
Definition at line 379 of file dsrtypes.h.
SR graphic types.
Used for content item SCOORD.
Definition at line 421 of file dsrtypes.h.
SR temporal range types.
Used for content item TCOORD.
Definition at line 443 of file dsrtypes.h.
SR continuity of content flag.
Used for content item CONTAINER.
COC_invalid | internal type used to indicate an error |
COC_Separate | DICOM defined term: SEPARATE. |
COC_Continuous | DICOM defined term: CONTINUOUS. |
COC_last | internal type used to mark the last entry |
Definition at line 467 of file dsrtypes.h.
SR document completion flag.
CF_invalid | internal type used to indicate an error |
CF_Partial | DICOM defined term: PARTIAL. |
CF_Complete | DICOM defined term: COMPLETE. |
CF_last | internal type used to mark the last entry |
Definition at line 481 of file dsrtypes.h.
SR document verification flag.
VF_invalid | internal type used to indicate an error |
VF_Unverified | DICOM defined term: UNVERIFIED. |
VF_Verified | DICOM defined term: VERIFIED. |
VF_last | internal type used to mark the last entry |
Definition at line 495 of file dsrtypes.h.
Specific character set.
Definition at line 509 of file dsrtypes.h.
enum DSRTypes::E_AddMode |
Add node mode.
AM_afterCurrent | add new node after current one (sibling) |
AM_beforeCurrent | add new node before current one (sibling) |
AM_belowCurrent | add new node below current one (after last child) |
Definition at line 547 of file dsrtypes.h.
static const char* DSRTypes::documentTypeToSOPClassUID | ( | const E_DocumentType | documentType | ) | [static] |
convert SR document type to SOP class UID
documentType | SR document type to be converted |
static const char* DSRTypes::documentTypeToModality | ( | const E_DocumentType | documentType | ) | [static] |
convert SR document type to modality
documentType | SR document type to be converted |
static const char* DSRTypes::documentTypeToReadableName | ( | const E_DocumentType | documentType | ) | [static] |
convert SR document type to readable name.
Such a readable name is better suited for printing/rendering.
documentType | SR document type to be converted |
static const char* DSRTypes::documentTypeToDocumentTitle | ( | const E_DocumentType | documentType, | |
OFString & | documentTitle | |||
) | [static] |
convert SR document type to document title.
This document title is used for printing/rendering.
documentType | SR document type to be converted | |
documentTitle | reference to variable where the resulting string is stored |
static const char* DSRTypes::relationshipTypeToDefinedTerm | ( | const E_RelationshipType | relationshipType | ) | [static] |
convert relationship type to DICOM defined term
relationshipType | relationship type to be converted |
static const char* DSRTypes::relationshipTypeToReadableName | ( | const E_RelationshipType | relationshipType | ) | [static] |
convert relationship type to readable name.
Such a readable name is better suited for printing/rendering.
relationshipType | relationship type to be converted |
static const char* DSRTypes::valueTypeToDefinedTerm | ( | const E_ValueType | valueType | ) | [static] |
convert value type to DICOM defined term
valueType | value type to be converted |
static const char* DSRTypes::valueTypeToXMLTagName | ( | const E_ValueType | valueType | ) | [static] |
convert value type to XML tag name
valueType | value type to be converted |
static const char* DSRTypes::valueTypeToReadableName | ( | const E_ValueType | valueType | ) | [static] |
convert value type to readable name.
Such a readable name is better suited for printing/rendering.
valueType | value type to be converted |
static const char* DSRTypes::graphicTypeToEnumeratedValue | ( | const E_GraphicType | graphicType | ) | [static] |
convert graphic type to DICOM enumerated value
graphicType | graphic type to be converted |
static const char* DSRTypes::graphicTypeToReadableName | ( | const E_GraphicType | graphicType | ) | [static] |
convert graphic type to readable name.
Such a readable name is better suited for printing/rendering.
graphicType | graphic type to be converted |
static const char* DSRTypes::temporalRangeTypeToEnumeratedValue | ( | const E_TemporalRangeType | temporalRangeType | ) | [static] |
convert temporal range type to DICOM enumerated value
temporalRangeType | temporal range type to be converted |
static const char* DSRTypes::temporalRangeTypeToReadableName | ( | const E_TemporalRangeType | temporalRangeType | ) | [static] |
convert temporal range type to readable name.
Such a readable name is better suited for printing/rendering.
temporalRangeType | temporal range type to be converted |
static const char* DSRTypes::continuityOfContentToEnumeratedValue | ( | const E_ContinuityOfContent | continuityOfContent | ) | [static] |
convert continuity of content flag to DICOM enumerated value
continuityOfContent | continuity of content flag to be converted |
static const char* DSRTypes::completionFlagToEnumeratedValue | ( | const E_CompletionFlag | completionFlag | ) | [static] |
convert completion flag to DICOM enumerated value
completionFlag | completion flag to be converted |
static const char* DSRTypes::verificationFlagToEnumeratedValue | ( | const E_VerificationFlag | verificationFlag | ) | [static] |
convert verification flag to DICOM enumerated value
verificationFlag | verification flag to be converted |
static const char* DSRTypes::characterSetToDefinedTerm | ( | const E_CharacterSet | characterSet | ) | [static] |
convert character set to DICOM defined term
characterSet | character set to be converted |
static const char* DSRTypes::characterSetToHTMLName | ( | const E_CharacterSet | characterSet | ) | [static] |
convert character set to HTML name.
This HTML (IANA) name is used to specify the character set in an HTML document.
characterSet | character set to be converted |
static const char* DSRTypes::characterSetToXMLName | ( | const E_CharacterSet | characterSet | ) | [static] |
convert character set to XML name.
This XML name is used to specify the character set in an XML document.
characterSet | character set to be converted |
static E_DocumentType DSRTypes::sopClassUIDToDocumentType | ( | const OFString & | sopClassUID | ) | [static] |
convert SOP class UID to SR document type
sopClassUID | SOP class UID to be converted |
static E_RelationshipType DSRTypes::definedTermToRelationshipType | ( | const OFString & | definedTerm | ) | [static] |
convert DICOM defined term to relationship type
definedTerm | defined term to be converted |
static E_ValueType DSRTypes::definedTermToValueType | ( | const OFString & | definedTerm | ) | [static] |
convert DICOM defined term to value type
definedTerm | defined term to be converted |
static E_ValueType DSRTypes::xmlTagNameToValueType | ( | const OFString & | xmlTagName | ) | [static] |
convert XML tag name to value type
xmlTagName | XML tag name to be converted |
static E_GraphicType DSRTypes::enumeratedValueToGraphicType | ( | const OFString & | enumeratedValue | ) | [static] |
convert DICOM enumerated value to graphic type
enumeratedValue | enumerated value to be converted |
static E_TemporalRangeType DSRTypes::enumeratedValueToTemporalRangeType | ( | const OFString & | enumeratedValue | ) | [static] |
convert DICOM enumerated value to temporal range type
enumeratedValue | enumerated value to be converted |
static E_ContinuityOfContent DSRTypes::enumeratedValueToContinuityOfContent | ( | const OFString & | enumeratedValue | ) | [static] |
convert DICOM enumerated value to continuity of content flag
enumeratedValue | enumerated value to be converted |
static E_CompletionFlag DSRTypes::enumeratedValueToCompletionFlag | ( | const OFString & | enumeratedValue | ) | [static] |
convert DICOM enumerated value to completion flag
enumeratedValue | enumerated value to be converted |
static E_VerificationFlag DSRTypes::enumeratedValueToVerificationFlag | ( | const OFString & | enumeratedValue | ) | [static] |
convert DICOM enumerated value to verification flag
enumeratedValue | enumerated value to be converted |
static E_CharacterSet DSRTypes::definedTermToCharacterSet | ( | const OFString & | definedTerm | ) | [static] |
convert DICOM defined term to character set
definedTerm | defined term to be converted |
static OFBool DSRTypes::isDocumentTypeSupported | ( | const E_DocumentType | documentType | ) | [static] |
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.
documentType | SR document type to be checked |
get current date in DICOM 'DA' format.
(YYYYMMDD)
dateString | string used to store the current date. ('19000101' if current date could not be retrieved) |
get current time in DICOM 'TM' format.
(HHMMSS) The optional UTC notation (e.g. +0100) is currently not supported.
timeString | string used to store the current time ('000000' if current time could not be retrieved) |
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.
dateTimeString | string used to store the current date and time ('19000101000000' if current date/time could not be retrieved) |
static const OFString& DSRTypes::dicomToReadableDate | ( | const OFString & | dicomDate, | |
OFString & | readableDate | |||
) | [static] |
convert DICOM date string to readable format.
The ISO format "YYYY-MM-DD" is used for the readable format.
dicomDate | date in DICOM DA format (YYYYMMDD) | |
readableDate | reference to variable where the resulting string is stored |
static const OFString& DSRTypes::dicomToReadableTime | ( | const OFString & | dicomTime, | |
OFString & | readableTime | |||
) | [static] |
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.
dicomTime | time in DICOM TM format (HHMM or HHMMSS...) | |
readableTime | reference to variable where the resulting string is stored |
static const OFString& DSRTypes::dicomToReadableDateTime | ( | const OFString & | dicomDateTime, | |
OFString & | readableDateTime | |||
) | [static] |
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.
dicomDateTime | time in DICOM DT format (YYYYMMDDHHMMSS...). Possible suffixes (fractional second or UTC notation) are currently ignored. | |
readableDateTime | reference to variable where the resulting string is stored |
static const OFString& DSRTypes::dicomToReadablePersonName | ( | const OFString & | dicomPersonName, | |
OFString & | readablePersonName | |||
) | [static] |
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.
dicomPersonName | person name in DICOM PN format (ln^fn^mn^p^s) | |
readablePersonName | reference to variable where the resulting string is stored |
static const OFString& DSRTypes::dicomToXMLPersonName | ( | const OFString & | dicomPersonName, | |
OFString & | xmlPersonName, | |||
const OFBool | writeEmptyValue = OFFalse | |||
) | [static] |
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.
dicomPersonName | person name in DICOM PN format (ln^fn^mn^p^s) | |
xmlPersonName | reference to variable where the resulting string is stored | |
writeEmptyValue | optional flag indicating whether an empty value should be written |
static const char* DSRTypes::numberToString | ( | const size_t | number, | |
char * | stringValue | |||
) | [static] |
convert unsigned integer number to character string
number | unsigned integer number to be converted | |
stringValue | character string used to store the result |
static size_t DSRTypes::stringToNumber | ( | const char * | stringValue | ) | [static] |
convert string to unsigned integer number
stringValue | character string to be converted |
static const OFString& DSRTypes::convertToPrintString | ( | const OFString & | sourceString, | |
OFString & | printString | |||
) | [static] |
convert character string to print string.
This method is used to convert character strings for text "print" output. Newline characters '
' are replaced by "\\n", return characters '' by "\\r", etc.
sourceString | source string to be converted | |
printString | reference to character string where the result should be stored |
static const OFString& DSRTypes::convertToMarkupString | ( | const OFString & | sourceString, | |
OFString & | markupString, | |||
const OFBool | convertNonASCII = OFFalse , |
|||
const OFBool | newlineAllowed = OFFalse , |
|||
const OFBool | xmlMode = OFFalse | |||
) | [static] |
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).
sourceString | source string to be converted | |
markupString | reference to character string where the result should be stored | |
convertNonASCII | convert non-ASCII characters (> #127) to numeric value (&nnn;) if OFTrue | |
newlineAllowed | optional flag indicating whether newlines are allowed or not. If they are allowed the text "<br>" is used, "¶" otherwise. The following combinations are accepted: LF, CR, LF CR, CF LF. | |
xmlMode | convert to XML markup string if OFTrue, HTML string otherwise. LF and CR are encoded as " " and " " in XML mode, the flag 'newlineAllowed' has no meaning in this case. |
static OFBool DSRTypes::checkForValidUIDFormat | ( | const OFString & | stringValue | ) | [static] |
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).
stringValue | character string to be checked |
static DSRIODConstraintChecker* DSRTypes::createIODConstraintChecker | ( | const E_DocumentType | documentType | ) | [static] |
create specified SR IOD content relationship contraint checker object.
Please note that the created object has to be deleted by the caller.
documentType | associated SR document type for which the checker object is created |
static DSRDocumentTreeNode* DSRTypes::createDocumentTreeNode | ( | const E_RelationshipType | relationshipType, | |
const E_ValueType | valueType | |||
) | [static] |
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.
relationshipType | relationship type of the node to be created | |
valueType | value type of the node to be created |
static OFBool DSRTypes::elementContainsExtendedCharacters | ( | DcmElement & | elem | ) | [static] |
check if this element contains non-ASCII characters.
static OFBool DSRTypes::stringContainsExtendedCharacters | ( | const OFString & | s | ) | [static] |
check if this string contains non-ASCII characters.
static OFCondition DSRTypes::addElementToDataset | ( | OFCondition & | result, | |
DcmItem & | dataset, | |||
DcmElement * | delem | |||
) | [static] |
add given element to the dataset.
The element is only added if 'result' is EC_Normal and the 'delem' pointer is not NULL.
result | reference to status variable (checked before adding and updated afterwards!) | |
dataset | reference to DICOM dataset to which the element should be added | |
delem | pointer to DICOM element which should be added |
static void DSRTypes::removeAttributeFromSequence | ( | DcmSequenceOfItems & | sequence, | |
const DcmTagKey & | tagKey | |||
) | [static] |
remove given attribute from the sequence.
All occurrences of the attribute in all items of the sequence are removed.
sequence | reference to DICOM sequence from which the attribute should be removed | |
tagKey | DICOM tag specifying the attribute which should be removed |
static OFCondition DSRTypes::getElementFromDataset | ( | DcmItem & | dataset, | |
DcmElement & | delem | |||
) | [static] |
get element from dataset
dataset | reference to DICOM dataset from which the element should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) | |
delem | reference to DICOM element which should be retrieved. The return value is also stored in this parameter. |
static OFCondition DSRTypes::getSequenceFromDataset | ( | DcmItem & | dataset, | |
DcmSequenceOfItems & | dseq | |||
) | [static] |
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.
dataset | reference to DICOM dataset from which the element should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) | |
dseq | reference to DICOM sequence which should be retrieved. The return value is also stored in this parameter. |
static const char* DSRTypes::getStringValueFromElement | ( | const DcmElement & | delem | ) | [static] |
get string value from element
delem | DICOM element from which the string value should be retrieved |
static const OFString& DSRTypes::getStringValueFromElement | ( | const DcmElement & | delem, | |
OFString & | stringValue | |||
) | [static] |
get string value from element
delem | reference to DICOM element from which the string value should be retrieved | |
stringValue | reference to character string where the result should be stored |
static const OFString& DSRTypes::getPrintStringFromElement | ( | const DcmElement & | delem, | |
OFString & | stringValue | |||
) | [static] |
get string value from element and convert to "print" format
delem | reference to DICOM element from which the string value should be retrieved | |
stringValue | reference to character string where the result should be stored |
static const OFString& DSRTypes::getMarkupStringFromElement | ( | const DcmElement & | delem, | |
OFString & | stringValue, | |||
const OFBool | convertNonASCII = OFFalse | |||
) | [static] |
get string value from element and convert to HTML/XML
delem | reference to DICOM element from which the string value should be retrieved | |
stringValue | reference to character string where the result should be stored | |
convertNonASCII | convert non-ASCII characters (> #127) to numeric value (&nnn;) if OFTrue |
static OFCondition DSRTypes::getStringValueFromDataset | ( | DcmItem & | dataset, | |
const DcmTagKey & | tagKey, | |||
OFString & | stringValue | |||
) | [static] |
get string value from dataset
dataset | reference to DICOM dataset from which the string should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) | |
tagKey | DICOM tag specifying the attribute from which the string should be retrieved | |
stringValue | reference to character string in which the result should be stored. (This parameter is automatically cleared if the tag could not be found.) |
static OFCondition DSRTypes::putStringValueToDataset | ( | DcmItem & | dataset, | |
const DcmTag & | tag, | |||
const OFString & | stringValue, | |||
const OFBool | allowEmpty = OFTrue | |||
) | [static] |
put string value to dataset
dataset | reference to DICOM dataset to which the string should be put. | |
tag | DICOM tag specifying the attribute to which the string should be put | |
stringValue | character string specifying the value to be set | |
allowEmpty | allow empty element to be inserted if OFTrue. Do not insert empty element otherwise. |
static OFBool DSRTypes::checkElementValue | ( | DcmElement & | delem, | |
const OFString & | vm, | |||
const OFString & | type, | |||
OFConsole * | stream = NULL , |
|||
const OFCondition & | searchCond = EC_Normal , |
|||
const char * | moduleName = NULL | |||
) | [static] |
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.
delem | DICOM element to be checked | |
vm | value multiplicity (valid value: "1", "1-n", "2", "2-2n"), interpreted as cardinality (number of items) for sequences | |
type | value type (valid value: "1", "2", something else) | |
stream | optional output stream used for warning messages | |
searchCond | optional flag indicating the status of a previous 'search' function call | |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
static OFCondition DSRTypes::getAndCheckElementFromDataset | ( | DcmItem & | dataset, | |
DcmElement & | delem, | |||
const OFString & | vm, | |||
const OFString & | type, | |||
OFConsole * | stream = NULL , |
|||
const char * | moduleName = NULL | |||
) | [static] |
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.
dataset | reference to DICOM dataset from which the element should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) | |
delem | DICOM element used to store the value | |
vm | value multiplicity (valid value: "1", "1-n", "2", "2-2n"), interpreted as cardinality (number of items) for sequences | |
type | value type (valid value: "1", "2", something else which is not checked) | |
stream | optional output stream used for warning messages | |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
static OFCondition DSRTypes::getAndCheckStringValueFromDataset | ( | DcmItem & | dataset, | |
const DcmTagKey & | tagKey, | |||
OFString & | stringValue, | |||
const OFString & | vm, | |||
const OFString & | type, | |||
OFConsole * | stream = NULL , |
|||
const char * | moduleName = NULL | |||
) | [static] |
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.
dataset | reference to DICOM dataset from which the element should be retrieved. (Would be 'const' if the methods from 'dcmdata' would also be 'const'.) | |
tagKey | DICOM tag specifying the attribute from which the string should be retrieved | |
stringValue | reference to character string in which the result should be stored. (This parameter is automatically cleared if the tag could not be found.) | |
vm | value multiplicity (valid value: "1", "1-n", "2", "2-2n"), interpreted as cardinality (number of items) for sequences | |
type | value type (valid value: "1", "2", something else which is not checked) | |
stream | optional output stream used for warning messages | |
moduleName | optional module name to be printed (default: "SR document" if NULL) |
static void DSRTypes::printMessage | ( | OFConsole * | stream, | |
const char * | message | |||
) | [static] |
print a message
stream | output stream to which the warning message is printed | |
message | message to be printed |
static void DSRTypes::printWarningMessage | ( | OFConsole * | stream, | |
const char * | message | |||
) | [static] |
print a warning message.
The prefix 'DCMSR - Warning: ' is automatically added to the message text.
stream | output stream to which the warning message is printed | |
message | warning message to be printed |
static void DSRTypes::printErrorMessage | ( | OFConsole * | stream, | |
const char * | message | |||
) | [static] |
print a error message.
The prefix 'DCMSR - Error: ' is automatically added to the message text.
stream | output stream to which the error message is printed | |
message | error message to be printed |
static void DSRTypes::printInvalidContentItemMessage | ( | OFConsole * | stream, | |
const char * | action, | |||
const DSRDocumentTreeNode * | node, | |||
const char * | location = NULL | |||
) | [static] |
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.
stream | output stream to which the warning message is printed (no message if NULL) | |
action | text describing the current action (e.g. 'Reading'), 'Processing' if NULL | |
node | pointer to document tree node for which the message should be printed | |
location | position of the affected content item (e.g. '1.2.3', not printed if NULL) |
static void DSRTypes::printContentItemErrorMessage | ( | OFConsole * | stream, | |
const char * | action, | |||
const OFCondition & | result, | |||
const DSRDocumentTreeNode * | node, | |||
const char * | location = NULL | |||
) | [static] |
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.
stream | output stream to which the warning message is printed (no message if NULL) | |
action | text describing the current action (e.g. 'Reading'), 'Processing' if NULL | |
result | status used to print more information on the error (no message if EC_Normal) | |
node | pointer to document tree node for which the message should be printed | |
location | position of the affected content item (e.g. '1.2.3', not printed if NULL) |
static void DSRTypes::printUnknownValueWarningMessage | ( | OFConsole * | stream, | |
const char * | valueName, | |||
const char * | readValue = NULL , |
|||
const char * | action = "Reading" | |||
) | [static] |
print a warning message that an unknown/unsupported value has been determined
stream | output stream to which the warning message is printed (no message if NULL) | |
valueName | name of the unknown/unsupported value | |
readValue | value that has been read (optional) | |
action | text describing the current action (default: 'Reading'), 'Processing' if NULL |
static OFBool DSRTypes::writeStringValueToXML | ( | ostream & | stream, | |
const OFString & | stringValue, | |||
const OFString & | tagName, | |||
const OFBool | writeEmptyValue = OFFalse | |||
) | [static] |
write string value to XML output stream.
The output looks like this: "<" tagName ">" stringValue "</" tagName ">"
stream | output stream to which the XML document is written | |
stringValue | string value to be written | |
tagName | name of the XML tag used to surround the string value | |
writeEmptyValue | optional flag indicating whether an empty value should be written |
static OFBool DSRTypes::writeStringFromElementToXML | ( | ostream & | stream, | |
DcmElement & | delem, | |||
const OFString & | tagName, | |||
const OFBool | writeEmptyValue = OFFalse | |||
) | [static] |
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.
stream | output stream to which the XML document is written | |
delem | reference to DICOM element from which the value is retrieved | |
tagName | name of the XML tag used to surround the string value | |
writeEmptyValue | optional flag indicating whether an empty value should be written |
static size_t DSRTypes::createHTMLAnnexEntry | ( | ostream & | docStream, | |
ostream & | annexStream, | |||
const OFString & | referenceText, | |||
size_t & | annexNumber | |||
) | [static] |
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]'
docStream | output stream used for the main document | |
annexStream | output stream used for the document annex | |
referenceText | optional text added to the main document (e.g. 'for details see') | |
annexNumber | reference to the variable where the current annex number is stored. Value is increased automatically by 1 after the new entry has been added. |
static size_t DSRTypes::createHTMLFootnote | ( | ostream & | docStream, | |
ostream & | footnoteStream, | |||
size_t & | footnoteNumber, | |||
const size_t | nodeID | |||
) | [static] |
create an HTML footnote with hyperlinks
docStream | output stream used for the main document | |
footnoteStream | output stream used for the footnote text | |
footnoteNumber | reference to the variable where the current footnote number is stored. Value is increased automatically by 1 after the new entry has been added. | |
nodeID | unique numerical identifier of the current node for which this footnote is created. Used to create a unique name for the hyperlink. |
static OFCondition DSRTypes::appendStream | ( | ostream & | mainStream, | |
OFOStringStream & | tempStream, | |||
const char * | heading = NULL | |||
) | [static] |
append one output stream to another.
mainStream | stream to which the other should be added | |
tempStream | (string) stream to be added to the other | |
heading | (optional) string which is added to the 'mainStream' before the 'tempStream'. This string is only added if 'tempStream' is not empty. |