DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
XMLNode Struct Reference

Main Class representing a XML node. More...

Classes

struct  XMLNodeDataTag
 

Public Types

enum  XMLCharEncoding
 Enumeration for XML character encoding.
 
typedef enum
XMLNode::XMLCharEncoding 
XMLCharEncoding
 Enumeration for XML character encoding.
 

Public Member Functions

XMLSTR createXMLString (int nFormat=1, int *pnSize=NULL) const
 Create an XML string starting from the current XMLNode. More...
 
XMLError writeToFile (XMLCSTR filename, const char *encoding=NULL, char nFormat=1) const
 Save the content of an xmlNode inside a file. More...
 
XMLCSTR getName () const
 name of the node
 
XMLCSTR getText (int i=0) const
 return ith text field
 
int nText () const
 nbr of text field
 
XMLNode getParentNode () const
 return the parent node
 
XMLNode getChildNode (int i=0) const
 return ith child node
 
XMLNode getChildNode (XMLCSTR name, int i) const
 return ith child node with specific name (return an empty node if failing). If i==-1, this returns the last XMLNode with the given name.
 
XMLNode getChildNode (XMLCSTR name, int *i=NULL) const
 return next child node with specific name (return an empty node if failing)
 
XMLNode getChildNodeWithAttribute (XMLCSTR tagName, XMLCSTR attributeName, XMLCSTR attributeValue=NULL, int *i=NULL) const
 return child node with specific name/attribute (return an empty node if failing)
 
XMLNode getChildNodeByPath (XMLCSTR path, char createNodeIfMissing=0, XMLCHAR sep='/')
 return the first child node with specific path
 
XMLNode getChildNodeByPathNonConst (XMLSTR path, char createNodeIfMissing=0, XMLCHAR sep='/')
 return the first child node with specific path.
 
int nChildNode (XMLCSTR name) const
 return the number of child node with specific name
 
int nChildNode () const
 nbr of child node
 
XMLAttribute getAttribute (int i=0) const
 return ith attribute
 
XMLCSTR getAttributeName (int i=0) const
 return ith attribute name
 
XMLCSTR getAttributeValue (int i=0) const
 return ith attribute value
 
char isAttributeSet (XMLCSTR name) const
 test if an attribute with a specific name is given
 
XMLCSTR getAttribute (XMLCSTR name, int i) const
 return ith attribute content with specific name (return a NULL if failing)
 
XMLCSTR getAttribute (XMLCSTR name, int *i=NULL) const
 return next attribute content with specific name (return a NULL if failing)
 
int nAttribute () const
 nbr of attribute
 
XMLClear getClear (int i=0) const
 return ith clear field (comments)
 
int nClear () const
 nbr of clear field
 
XMLNodeContents enumContents (XMLElementPosition i) const
 enumerate all the different contents (attribute,child,text, clear) of the current XMLNode. The order is reflecting the order of the original file/string. NOTE: 0 <= i < nElement();
 
int nElement () const
 nbr of different contents for current node
 
char isEmpty () const
 is this node Empty?
 
char isDeclaration () const
 is this node a declaration <? .... ?>
 
XMLNode deepCopy () const
 deep copy (duplicate/clone) a XMLNode
 
 XMLNode (const XMLNode &A)
 to allow shallow/fast copy:
 
XMLNodeoperator= (const XMLNode &A)
 to allow shallow/fast copy:
 
XMLNode addChild (XMLCSTR lpszName, char isDecl=FALSE, XMLElementPosition pos=-1)
 Add a new child node.
 
XMLNode addChild (XMLNode nodeToAdd, XMLElementPosition pos=-1)
 If the "nodeToAdd" has some parents, it will be detached from it's parents before being attached to the current XMLNode.
 
XMLAttributeaddAttribute (XMLCSTR lpszName, XMLCSTR lpszValuev)
 Add a new attribute.
 
XMLCSTR addText (XMLCSTR lpszValue, XMLElementPosition pos=-1)
 Add a new text content.
 
XMLClearaddClear (XMLCSTR lpszValue, XMLCSTR lpszOpen=NULL, XMLCSTR lpszClose=NULL, XMLElementPosition pos=-1)
 Add a new clear tag. More...
 
XMLCSTR updateName (XMLCSTR lpszName)
 change node's name
 
XMLAttributeupdateAttribute (XMLAttribute *newAttribute, XMLAttribute *oldAttribute)
 if the attribute to update is missing, a new one will be added
 
XMLAttributeupdateAttribute (XMLCSTR lpszNewValue, XMLCSTR lpszNewName=NULL, int i=0)
 if the attribute to update is missing, a new one will be added
 
XMLAttributeupdateAttribute (XMLCSTR lpszNewValue, XMLCSTR lpszNewName, XMLCSTR lpszOldName)
 set lpszNewName=NULL if you don't want to change the name of the attribute if the attribute to update is missing, a new one will be added
 
XMLCSTR updateText (XMLCSTR lpszNewValue, int i=0)
 if the text to update is missing, a new one will be added
 
XMLCSTR updateText (XMLCSTR lpszNewValue, XMLCSTR lpszOldValue)
 if the text to update is missing, a new one will be added
 
XMLClearupdateClear (XMLCSTR lpszNewContent, int i=0)
 if the clearTag to update is missing, a new one will be added
 
XMLClearupdateClear (XMLClear *newP, XMLClear *oldP)
 if the clearTag to update is missing, a new one will be added
 
XMLClearupdateClear (XMLCSTR lpszNewValue, XMLCSTR lpszOldValue)
 if the clearTag to update is missing, a new one will be added
 
void deleteNodeContent ()
 The "deleteNodeContent" function forces the deletion of the content of this XMLNode and the subtree. More...
 
void deleteAttribute (int i=0)
 Delete the ith attribute of the current XMLNode.
 
void deleteAttribute (XMLCSTR lpszName)
 Delete the attribute with the given name (the "strcmp" function is used to find the right attribute)
 
void deleteAttribute (XMLAttribute *anAttribute)
 Delete the attribute with the name "anAttribute->lpszName" (the "strcmp" function is used to find the right attribute)
 
void deleteText (int i=0)
 Delete the Ith text content of the current XMLNode.
 
void deleteText (XMLCSTR lpszValue)
 Delete the text content "lpszValue" inside the current XMLNode (direct "pointer-to-pointer" comparison is used to find the right text)
 
void deleteClear (int i=0)
 Delete the Ith clear tag inside the current XMLNode.
 
void deleteClear (XMLCSTR lpszValue)
 Delete the clear tag "lpszValue" inside the current XMLNode (direct "pointer-to-pointer" comparison is used to find the clear tag)
 
void deleteClear (XMLClear *p)
 Delete the clear tag "p" inside the current XMLNode (direct "pointer-to-pointer" comparison on the lpszName of the clear tag is used to find the clear tag)
 
XMLNode addChild_WOSD (XMLSTR lpszName, char isDeclaration=FALSE, XMLElementPosition pos=-1)
 Add a new child node.
 
XMLAttributeaddAttribute_WOSD (XMLSTR lpszName, XMLSTR lpszValue)
 Add a new attribute.
 
XMLCSTR addText_WOSD (XMLSTR lpszValue, XMLElementPosition pos=-1)
 Add a new text content.
 
XMLClearaddClear_WOSD (XMLSTR lpszValue, XMLCSTR lpszOpen=NULL, XMLCSTR lpszClose=NULL, XMLElementPosition pos=-1)
 Add a new clear Tag.
 
XMLCSTR updateName_WOSD (XMLSTR lpszName)
 change node's name
 
XMLAttributeupdateAttribute_WOSD (XMLAttribute *newAttribute, XMLAttribute *oldAttribute)
 if the attribute to update is missing, a new one will be added
 
XMLAttributeupdateAttribute_WOSD (XMLSTR lpszNewValue, XMLSTR lpszNewName=NULL, int i=0)
 if the attribute to update is missing, a new one will be added
 
XMLAttributeupdateAttribute_WOSD (XMLSTR lpszNewValue, XMLSTR lpszNewName, XMLCSTR lpszOldName)
 set lpszNewName=NULL if you don't want to change the name of the attribute if the attribute to update is missing, a new one will be added
 
XMLCSTR updateText_WOSD (XMLSTR lpszNewValue, int i=0)
 if the text to update is missing, a new one will be added
 
XMLCSTR updateText_WOSD (XMLSTR lpszNewValue, XMLCSTR lpszOldValue)
 if the text to update is missing, a new one will be added
 
XMLClearupdateClear_WOSD (XMLSTR lpszNewContent, int i=0)
 if the clearTag to update is missing, a new one will be added
 
XMLClearupdateClear_WOSD (XMLClear *newP, XMLClear *oldP)
 if the clearTag to update is missing, a new one will be added
 
XMLClearupdateClear_WOSD (XMLSTR lpszNewValue, XMLCSTR lpszOldValue)
 if the clearTag to update is missing, a new one will be added
 
XMLElementPosition positionOfChildNode (XMLCSTR name, int i=0) const
 return the position of the ith childNode with the specified name if (name==NULL) return the position of the ith childNode
 

Static Public Member Functions

static XMLCSTR getVersion ()
 Return the XMLParser library version number.
 
static XMLNode parseString (XMLCSTR lpXMLString, XMLCSTR tag=NULL, XMLResults *pResults=NULL)
 Parse an XML string and return the root of a XMLNode tree representing the string. More...
 
static XMLNode parseFile (XMLCSTR filename, XMLCSTR tag=NULL, XMLResults *pResults=NULL)
 Parse an XML file and return the root of a XMLNode tree representing the file. More...
 
static XMLNode openFileHelper (XMLCSTR filename, XMLCSTR tag=NULL)
 This function is currently disabled but might be enabled in the future in a modified version.
 
static XMLCSTR getError (XMLError error)
 This gives you a user-friendly explanation of the parsing error.
 
static XMLNode emptyNode ()
 return XMLNode::emptyXMLNode;
 
static XMLNode createXMLTopNode (XMLCSTR lpszName, char isDecl=FALSE)
 Create the top node of an XMLNode structure.
 
static XMLNode createXMLTopNode_WOSD (XMLSTR lpszName, char isDeclaration=FALSE)
 Create the top node of an XMLNode structure.
 
static char setGlobalOptions (XMLCharEncoding characterEncoding=XMLNode::char_encoding_UTF8, char guessWideCharChars=1, char dropWhiteSpace=1, char removeCommentsInMiddleOfText=1)
 Sets the global options for the conversions. More...
 
static XMLCharEncoding guessCharEncoding (void *buffer, int bufLen, char useXMLEncodingAttribute=1)
 Guess the character encoding of the string (ascii, utf8 or shift-JIS) More...
 

Private Member Functions

 XMLNode (struct XMLNodeDataTag *pParent, XMLSTR lpszName, char isDecl)
 Constructors are protected, so use instead one of: XMLNode::parseString, XMLNode::parseFile, XMLNode::openFileHelper, XMLNode::createXMLTopNode.
 
 XMLNode (struct XMLNodeDataTag *p)
 Constructors are protected, so use instead one of: XMLNode::parseString, XMLNode::parseFile, XMLNode::openFileHelper, XMLNode::createXMLTopNode.
 

Detailed Description

Main Class representing a XML node.

All operations are performed using this class.

Note
The constructors of the XMLNode class are protected, so use instead one of these four methods to get your first instance of XMLNode:

Class Documentation

struct XMLNode::XMLNodeDataTag

The documentation for this struct was generated from the following file:


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8