|
| DSRXMLDocument () |
| default constructor
|
|
virtual | ~DSRXMLDocument () |
| destructor
|
|
void | clear () |
| clear all internal member variables
|
|
OFBool | valid () const |
| check whether the current internal state is valid More...
|
|
OFCondition | read (const OFString &filename, const size_t flags=0) |
| read XML document from file. More...
|
|
OFBool | encodingHandlerValid () const |
| check whether the currently set character encoding handler is valid. More...
|
|
OFCondition | setEncodingHandler (const char *charset) |
| set the specified character encoding handler. More...
|
|
DSRXMLCursor | getRootNode () const |
| get root node of the document More...
|
|
DSRXMLCursor | getNamedNode (const DSRXMLCursor &cursor, const char *name, const OFBool required=OFTrue) const |
| get a particular named node of the document. More...
|
|
OFBool | matchNode (const DSRXMLCursor &cursor, const char *name) const |
| check whether particular node matches a given name More...
|
|
OFCondition | checkNode (const DSRXMLCursor &cursor, const char *name) const |
| check whether particular node matches a given name and report an error if not More...
|
|
OFBool | hasAttribute (const DSRXMLCursor &cursor, const char *name) const |
| check whether particular node has a specific attribute More...
|
|
OFString & | getStringFromAttribute (const DSRXMLCursor &cursor, OFString &stringValue, const char *name, const OFBool encoding=OFFalse, const OFBool required=OFTrue) const |
| get string value from particular XML attribute. More...
|
|
OFCondition | getElementFromAttribute (const DSRXMLCursor &cursor, DcmElement &delem, const char *name, const OFBool encoding=OFFalse, const OFBool required=OFTrue) const |
| get element value from particular XML attribute More...
|
|
OFString & | getStringFromNodeContent (const DSRXMLCursor &cursor, OFString &stringValue, const char *name=NULL, const OFBool encoding=OFFalse, const OFBool clearString=OFTrue) const |
| get string value from particular XML element More...
|
|
OFCondition | getElementFromNodeContent (const DSRXMLCursor &cursor, DcmElement &delem, const char *name=NULL, const OFBool encoding=OFFalse) const |
| get element value from particular XML element More...
|
|
E_ValueType | getValueTypeFromNode (const DSRXMLCursor &cursor) const |
| get value type from particular node. More...
|
|
E_RelationshipType | getRelationshipTypeFromNode (const DSRXMLCursor &cursor) const |
| get relationship type from particular node. More...
|
|
void | printUnexpectedNodeWarning (const DSRXMLCursor &cursor) const |
| print warning message for unexpected node More...
|
|
void | printGeneralNodeError (const DSRXMLCursor &cursor, const OFCondition &result) const |
| print general node error message More...
|
|
|
static OFString & | getFullNodePath (const DSRXMLCursor &cursor, OFString &stringValue, const OFBool omitCurrent=OFFalse) |
| get the full path (incl. More...
|
|
static const char * | documentTypeToSOPClassUID (const E_DocumentType documentType) |
| convert SR document type to SOP class UID More...
|
|
static const char * | documentTypeToModality (const E_DocumentType documentType) |
| convert SR document type to modality More...
|
|
static const char * | documentTypeToReadableName (const E_DocumentType documentType) |
| convert SR document type to readable name. More...
|
|
static const char * | documentTypeToDocumentTitle (const E_DocumentType documentType, OFString &documentTitle) |
| convert SR document type to document title. More...
|
|
static OFBool | requiresEnhancedEquipmentModule (const E_DocumentType documentType) |
| check whether SR document type requires Enhanced General Equipment Module More...
|
|
static const char * | relationshipTypeToDefinedTerm (const E_RelationshipType relationshipType) |
| convert relationship type to DICOM defined term More...
|
|
static const char * | relationshipTypeToReadableName (const E_RelationshipType relationshipType) |
| convert relationship type to readable name. More...
|
|
static const char * | valueTypeToDefinedTerm (const E_ValueType valueType) |
| convert value type to DICOM defined term More...
|
|
static const char * | valueTypeToXMLTagName (const E_ValueType valueType) |
| convert value type to XML tag name More...
|
|
static const char * | valueTypeToReadableName (const E_ValueType valueType) |
| convert value type to readable name. More...
|
|
static const char * | presentationStateTypeToShortName (const E_PresentationStateType pstateType) |
| convert presentation state type to short name. More...
|
|
static const char * | graphicTypeToEnumeratedValue (const E_GraphicType graphicType) |
| convert graphic type to DICOM enumerated value More...
|
|
static const char * | graphicTypeToReadableName (const E_GraphicType graphicType) |
| convert graphic type to readable name. More...
|
|
static const char * | graphicType3DToEnumeratedValue (const E_GraphicType3D graphicType) |
| convert graphic type (3D) to DICOM enumerated value More...
|
|
static const char * | graphicType3DToReadableName (const E_GraphicType3D graphicType) |
| convert graphic type (3D) to readable name. More...
|
|
static const char * | temporalRangeTypeToEnumeratedValue (const E_TemporalRangeType temporalRangeType) |
| convert temporal range type to DICOM enumerated value More...
|
|
static const char * | temporalRangeTypeToReadableName (const E_TemporalRangeType temporalRangeType) |
| convert temporal range type to readable name. More...
|
|
static const char * | continuityOfContentToEnumeratedValue (const E_ContinuityOfContent continuityOfContent) |
| convert continuity of content flag to DICOM enumerated value More...
|
|
static const char * | preliminaryFlagToEnumeratedValue (const E_PreliminaryFlag preliminaryFlag) |
| convert preliminary flag to DICOM enumerated value More...
|
|
static const char * | completionFlagToEnumeratedValue (const E_CompletionFlag completionFlag) |
| convert completion flag to DICOM enumerated value More...
|
|
static const char * | verificationFlagToEnumeratedValue (const E_VerificationFlag verificationFlag) |
| convert verification flag to DICOM enumerated value More...
|
|
static const char * | characterSetToDefinedTerm (const E_CharacterSet characterSet) |
| convert character set to DICOM defined term More...
|
|
static const char * | characterSetToHTMLName (const E_CharacterSet characterSet) |
| convert character set to HTML name. More...
|
|
static const char * | characterSetToXMLName (const E_CharacterSet characterSet) |
| convert character set to XML name. More...
|
|
static E_DocumentType | sopClassUIDToDocumentType (const OFString &sopClassUID) |
| convert SOP class UID to SR document type More...
|
|
static E_RelationshipType | definedTermToRelationshipType (const OFString &definedTerm) |
| convert DICOM defined term to relationship type More...
|
|
static E_ValueType | definedTermToValueType (const OFString &definedTerm) |
| convert DICOM defined term to value type More...
|
|
static E_PresentationStateType | sopClassUIDToPresentationStateType (const OFString &sopClassUID) |
| convert SOP class UID to presentation state type More...
|
|
static E_ValueType | xmlTagNameToValueType (const OFString &xmlTagName) |
| convert XML tag name to value type More...
|
|
static E_GraphicType | enumeratedValueToGraphicType (const OFString &enumeratedValue) |
| convert DICOM enumerated value to graphic type More...
|
|
static E_GraphicType3D | enumeratedValueToGraphicType3D (const OFString &enumeratedValue) |
| convert DICOM enumerated value to graphic type (3D) More...
|
|
static E_TemporalRangeType | enumeratedValueToTemporalRangeType (const OFString &enumeratedValue) |
| convert DICOM enumerated value to temporal range type More...
|
|
static E_ContinuityOfContent | enumeratedValueToContinuityOfContent (const OFString &enumeratedValue) |
| convert DICOM enumerated value to continuity of content flag More...
|
|
static E_PreliminaryFlag | enumeratedValueToPreliminaryFlag (const OFString &enumeratedValue) |
| convert DICOM enumerated value to preliminary flag More...
|
|
static E_CompletionFlag | enumeratedValueToCompletionFlag (const OFString &enumeratedValue) |
| convert DICOM enumerated value to completion flag More...
|
|
static E_VerificationFlag | enumeratedValueToVerificationFlag (const OFString &enumeratedValue) |
| convert DICOM enumerated value to verification flag More...
|
|
static E_CharacterSet | definedTermToCharacterSet (const OFString &definedTerm) |
| convert DICOM defined term to character set More...
|
|
static OFBool | isDocumentTypeSupported (const E_DocumentType documentType) |
| check whether specified SR document type is supported by this library More...
|
|
static const OFString & | currentDate (OFString &dateString) |
| get current date in DICOM 'DA' format. More...
|
|
static const OFString & | currentTime (OFString &timeString) |
| get current time in DICOM 'TM' format. More...
|
|
static const OFString & | currentDateTime (OFString &dateTimeString) |
| get current date and time in DICOM 'DT' format. More...
|
|
static const OFString & | dicomToReadableDate (const OFString &dicomDate, OFString &readableDate) |
| convert DICOM date string to readable format. More...
|
|
static const OFString & | dicomToReadableTime (const OFString &dicomTime, OFString &readableTime) |
| convert DICOM time string to readable format. More...
|
|
static const OFString & | dicomToReadableDateTime (const OFString &dicomDateTime, OFString &readableDateTime) |
| convert DICOM date time string to readable format. More...
|
|
static const OFString & | dicomToReadablePersonName (const OFString &dicomPersonName, OFString &readablePersonName) |
| convert DICOM person name to readable format. More...
|
|
static const OFString & | dicomToXMLPersonName (const OFString &dicomPersonName, OFString &xmlPersonName, const OFBool writeEmptyValue=OFFalse) |
| convert DICOM person name to XML format. More...
|
|
static const char * | numberToString (const size_t number, char *stringValue) |
| convert unsigned integer number to character string More...
|
|
static size_t | stringToNumber (const char *stringValue) |
| convert string to unsigned integer number More...
|
|
static const OFString & | convertToPrintString (const OFString &sourceString, OFString &printString) |
| convert character string to print string. More...
|
|
static const OFString & | convertToHTMLString (const OFString &sourceString, OFString &markupString, const size_t flags=0, const OFBool newlineAllowed=OFFalse) |
| convert character string to HTML mnenonic string. More...
|
|
static const OFString & | convertToXMLString (const OFString &sourceString, OFString &markupString) |
| convert character string to XML mnenonic string. More...
|
|
static OFBool | checkForValidReference (const OFString &stringValue) |
| check string for valid reference (as used for by-reference relationships). More...
|
|
static DSRIODConstraintChecker * | createIODConstraintChecker (const E_DocumentType documentType) |
| create specified SR IOD content relationship constraint checker object. More...
|
|
static DSRDocumentTreeNode * | createDocumentTreeNode (const E_RelationshipType relationshipType, const E_ValueType valueType) |
| create specified document tree node. More...
|
|
static OFCondition | addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *delem, const OFString &vm, const OFString &type, const char *moduleName=NULL) |
| add given element to the dataset. More...
|
|
static void | removeAttributeFromSequence (DcmSequenceOfItems &sequence, const DcmTagKey &tagKey) |
| remove given attribute from the sequence. More...
|
|
static OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &delem) |
| get element from dataset More...
|
|
static const char * | getStringValueFromElement (const DcmElement &delem) |
| get string value from element More...
|
|
static const OFString & | getStringValueFromElement (const DcmElement &delem, OFString &stringValue) |
| get string value from element. More...
|
|
static OFCondition | getStringValueFromElement (const DcmElement &delem, OFString &stringValue, const signed long pos) |
| get string value from element More...
|
|
static const OFString & | getPrintStringFromElement (const DcmElement &delem, OFString &stringValue) |
| get string value from element and convert to "print" format. More...
|
|
static const OFString & | getMarkupStringFromElement (const DcmElement &delem, OFString &stringValue, const OFBool convertNonASCII=OFFalse) |
| get string value from element and convert to HTML/XML. More...
|
|
static OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const signed long pos=0) |
| get string value from dataset More...
|
|
static OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
| put string value to dataset More...
|
|
static OFBool | checkElementValue (DcmElement *delem, const DcmTagKey &tagKey, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
| check element value for correct value multiplicity and type. More...
|
|
static OFBool | checkElementValue (DcmElement &delem, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
| check element value for correct value multiplicity and type. More...
|
|
static OFCondition | getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &delem, const OFString &vm, const OFString &type, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
| get element from dataset and check it for correct value multiplicity and type. More...
|
|
static OFCondition | getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL, const OFBool acceptViolation=OFFalse) |
| get string value from dataset and check it for correct value multiplicity and type. More...
|
|
static void | printInvalidContentItemMessage (const char *action, const DSRDocumentTreeNode *node, const char *location=NULL) |
| print the warning message that the current content item is invalid/incomplete. More...
|
|
static void | printContentItemErrorMessage (const char *action, const OFCondition &result, const DSRDocumentTreeNode *node, const char *location=NULL) |
| print an error message for the current content item. More...
|
|
static void | printUnknownValueWarningMessage (const char *valueName, const char *readValue=NULL, const char *action="Reading") |
| print a warning message that an unknown/unsupported value has been determined More...
|
|
static OFBool | writeStringValueToXML (STD_NAMESPACE ostream &stream, const OFString &stringValue, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
| write string value to XML output stream. More...
|
|
static OFBool | writeStringFromElementToXML (STD_NAMESPACE ostream &stream, DcmElement &delem, const OFString &tagName, const OFBool writeEmptyValue=OFFalse) |
| write string value from DICOM element to XML output stream. More...
|
|
static size_t | createHTMLAnnexEntry (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, const OFString &referenceText, size_t &annexNumber, const size_t flags=0) |
| create an HTML annex entry with hyperlinks. More...
|
|
static size_t | createHTMLFootnote (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &footnoteStream, size_t &footnoteNumber, const size_t nodeID, const size_t flags=0) |
| create an HTML footnote with hyperlinks More...
|
|
static OFCondition | appendStream (STD_NAMESPACE ostream &mainStream, OFOStringStream &tempStream, const char *heading=NULL) |
| append one output stream to another. More...
|
|
Class for XML documents.
This class encapsulates the access to the 'libxml' routines. Since the public interface of this class does not use any 'libxml' specific data structures it should be possible to replace the XML library with little effort (if required).