include/mtflt/mtFltDatabase.h

Go to the documentation of this file.

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

#ifndef mtFltDatabase_H_
#define mtFltDatabase_H_

//
// \file mtFltDatabase.h
// \brief Represents an abstraction of a Database node inside a Metaflight file.
//

#include "mtflt/mtfltDefines.h"
#include "mtflt/mtFltNode.h"
#include <vlutil/vlFilename.h>
#include <vlutil/vlConfig.h>
#include <vector>
#include <libxml/xmlreader.h>

class DtMtFltGeomGridDs;
class DtMtFltGridStructure;
class DtTerrainDatabase;
class Coordinate_System;

// \brief Represents an abstraction of a Database node inside a Metaflight file.
// This class is the top level container for a MetaFlight file. The database
// object is a root container object that contains the coordinate system and dataset
// information that describe the geometry used to build the run-time scene graph.
class DT_DLL_mtflt DtMtFltDatabase : public DtMtFltNode
{
public:

   // Default constructor.
   DtMtFltDatabase();

   // Destructor
   virtual ~DtMtFltDatabase();
   
   // Copy constructor
   DtMtFltDatabase(const DtMtFltDatabase& node);
   
   // Assignment operator
   DtMtFltDatabase& operator=(const DtMtFltDatabase& orig);

   // Overrides the \p DtMtFltNode::readNode method  to read the
   // node information from a Metaflight Database node.
   // \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);

   // Loads the metaflight file into a terrain database.
   // \param mftFilename Name of the metaflight file to load
   // \param terrain returned terrain
   // \return \b true if success loading the Metaflight file into the
   // terrain object, \b false otherwise.
   virtual bool load(const DtFilename& mftFilename, DtTerrainDatabase*& terrain);

   // Returns only the coordinate system that would define this database.  Should not load
   // any polygonal or vector information
   virtual Coordinate_System* coordinateSystem(const DtFilename& filename);
   
protected:
   
   unsigned int myVersionMajor;
   unsigned int myVersionMinor;

   // Vector of Grid Structures. This is a vector just to be consistent
   // with Vegaprime's definition(s) of its Database class. Right now, it is filled
   // up, but it is not being used since the GeometryGridDataset contains a copy of the
   // grid structure object it uses.
   std::vector<DtMtFltGridStructure* > myGridStructures;

   // Vector of Geometry Grid Datasets. This is a vector just to be consistent
   // with Vegaprime's definition(s) of its Database class. This loader only handles
   // one GeometryGridDataset node per file which means this vector will have only 
   // one entry.
   std::vector<DtMtFltGeomGridDs*> myGeomGridDs; 

private:


};

#endif