include/mtflt/mtFltNode.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: mtFltNode.h,v $ $Revision: 1.10 $ $State: Exp $
*******************************************************************************/

#ifndef mtFltNode_H_
#define mtFltNode_H_

//
// \file mtFltNode.h
// \brief Represents an XML node of the Metaflight file.
//

#include "mtflt/mtfltDefines.h"
#include <vlutil/vlString.h>
#include <libxml/xmlreader.h>

// \brief Abstract class that represents an XML node of the Metaflight file.
// An XML Metaflight node has a "name" attribute plus extra properties which 
// can be nodes themselves.
// \par
// \code
// <node name="aname"> 
//   ... properties ... 
// </node> 
// \endcode
class DT_DLL_mtflt DtMtFltNode
{
public:
   
   // Default constructor.
   DtMtFltNode();
   
   // Destructor
   virtual ~DtMtFltNode();
   
   // Copy constructor
   DtMtFltNode(const DtMtFltNode& node);
   
   // Assignment operator
   DtMtFltNode& operator=(const DtMtFltNode& orig);

   // Reads the information from the xml node into this object. xmlNodePtr 
   // is the type handed back by libXml which is the library being used to 
   // read xml documents.   
   // \param root pointer to the root node of the document
   // \param node pointer to the xml node that will be read
   // \return \b true if success reading the node. \b false otherwise.
   virtual bool readNode(const xmlNodePtr root, xmlNodePtr node) = 0;
   
   // Name of the node   
   virtual DtString name() const;

protected:

   // This is the attribute stored in the name attribute of the xml node
   // <tt> <node <b>name="myname" </b>>...</node> </tt>
   DtString myName;

};

#endif