Represents a reader class that interacts with libXml to read a VR-Forces DtReaderWriter class documentation file.
More...
Detailed Description
Represents a reader class that interacts with libXml to read a VR-Forces DtReaderWriter class documentation file.
Constructor & Destructor Documentation
| DtRwClassDocReader::DtRwClassDocReader |
( |
| ) |
|
| virtual DtRwClassDocReader::~DtRwClassDocReader |
( |
| ) |
|
|
virtual |
Copy constructor – not implemented.
Member Function Documentation
Reads in contents of DtReaderWriter class doc file to class descriptor object.
Finds the first node whose tag matches the one given by nodeName.
- Parameters
-
| node | Starting node for the search inside the xml document |
| nodeName | Name of the node to be searched (e.g. "GridStructure") |
- Returns
- 0 if no matches are found.
Finds the node named as nodeName and that also has an attribute named attrName with a value of attrValue.
For example, findNode(nodeptr, "GridStructure", "name", "abc") searches for a node that looks like
<GridStructure name="abc">
...
</GridStructure>
- Returns
- 0 if no matches are found.
Returns the value of the attribute attrname inside the node.
Attributes are specified inside the node like this
<node attrname=value ...>
...
</node>
- Parameters
-
| node | Node to access |
| attrname | Name of the attribute to be searched (e.g. "name") |
- Returns
- The attribute's value if present or an empty DtSring otherwise.
Returns the value of an "atomic" node.
Atomic nodes are the ones that have the following structure <tag>value</tag>.
- Parameters
-
| node | Node to start the search of the atomic node |
| nodeName | Name of the atomic node to be searched |
- Returns
- It returns an empty DtString if the node has the form or <tag></tag>
| virtual void DtRwClassDocReader::xmlNextNode |
( |
xmlNodePtr & |
node | ) |
const |
|
protectedvirtual |
- Returns
- the next node which is not a blank text node
Returns the value of an "atomic" node.
Atomic nodes are the ones that have the following structure <tag>value</tag>. It returns the empty string if the node has the form or <tag></tag>
Returns a pointer to the first child of the node or NULL if not defined The reason for this method is because libXml also includes blank text nodes sometimes, so they need to be filtered out.
This function guarantees you get an actual child node as the first node
Assignment operator – not implemented.
The documentation for this class was generated from the following file:
- /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/rwClassDocReader.h
