Represents a reader class that interacts with libXml to read a VR-Forces DtReaderWriter class documentation file.

Public Member Functions
	DtRwClassDocReader ()

virtual	~DtRwClassDocReader ()

virtual bool	read (const DtFilename &filename, DtReaderWriterClassDocumentation &parameterDocDesc) const

Protected Member Functions
virtual xmlNodePtr	xmlFindNode (xmlNodePtr node, const char *nodeName) const

virtual xmlNodePtr	xmlFindNode (xmlNodePtr node, const char nodeName, const char attrName, const char *attrValue) const

virtual DtString	xmlGetAttrValue (xmlNodePtr node, const char *attrname) const

virtual DtString	xmlGetAtomicNodeValue (xmlNodePtr node, const char *nodeName) const

virtual void	xmlNextNode (xmlNodePtr &node) const

virtual DtString	xmlGetAtomicNodeValue (xmlNodePtr node) const

virtual xmlNodePtr	xmlGetChildren (xmlNodePtr node) const

Private Member Functions
	DtRwClassDocReader (const DtRwClassDocReader &node)

DtRwClassDocReader &	operator= (const DtRwClassDocReader &orig)

Constructor & Destructor Documentation

DtRwClassDocReader::DtRwClassDocReader ( )

constructor.

virtual DtRwClassDocReader::~DtRwClassDocReader ( )

virtual

Destructor.

DtRwClassDocReader::DtRwClassDocReader ( const DtRwClassDocReader & node )

private

Copy constructor – not implemented.

Member Function Documentation

virtual bool DtRwClassDocReader::read	(	const DtFilename &	filename,
		DtReaderWriterClassDocumentation &	parameterDocDesc
	)		const

virtual

Reads in contents of DtReaderWriter class doc file to class descriptor object.

virtual xmlNodePtr DtRwClassDocReader::xmlFindNode	(	xmlNodePtr	node,
		const char *	nodeName
	)		const

protectedvirtual

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.

virtual xmlNodePtr DtRwClassDocReader::xmlFindNode	(	xmlNodePtr	node,
		const char *	nodeName,
		const char *	attrName,
		const char *	attrValue
	)		const

protectedvirtual

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.

virtual DtString DtRwClassDocReader::xmlGetAttrValue	(	xmlNodePtr	node,
		const char *	attrname
	)		const

protectedvirtual

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.

virtual DtString DtRwClassDocReader::xmlGetAtomicNodeValue	(	xmlNodePtr	node,
		const char *	nodeName
	)		const

protectedvirtual

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

virtual DtString DtRwClassDocReader::xmlGetAtomicNodeValue ( xmlNodePtr node ) const

protectedvirtual

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>

virtual xmlNodePtr DtRwClassDocReader::xmlGetChildren ( xmlNodePtr node ) const

protectedvirtual

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.

DtRwClassDocReader& DtRwClassDocReader::operator= ( const DtRwClassDocReader & orig )

private

Assignment operator – not implemented.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/rwClassDocReader.h

Public Member Functions

Protected Member Functions

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation