include/mtflt/mtFltGridStructure.h

Go to the documentation of this file.

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

#ifndef mtFltGridStructure_H_
#define mtFltGridStructure_H_

//
// \file mtFltGridStructure.h
// \brief Represents a GridStructure node inside the MetaFlight file
//

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

class DtMfGridLevel;

// \brief Represents a GridStructure node inside the MetaFlight file
// This class represents a Grid Structure, which defines a system of spatial
// subdivisions independent of location, coverage, or dataset type. This is 
// one of the types of information conveyed by MetaFlight.
class DT_DLL_mtflt DtMtFltGridStructure : public DtMtFltNode
{
public:
   
   // Default constructor.
   DtMtFltGridStructure();

   // Destructor
   virtual ~DtMtFltGridStructure();

   // Copy constructor
   DtMtFltGridStructure(const DtMtFltGridStructure& node);
   
   // Assignment operator
   DtMtFltGridStructure& operator=(const DtMtFltGridStructure& orig);

   // Overrides the \p DtMtFltNode::readNode method to read the
   // node information from a Metaflight GridStructure 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);
   
   // Returns the number of levels in the grid structure
   virtual unsigned int numLevels() const;

   // Returns the starting level in the grid structure
   virtual unsigned int startingLevel() const;

   // Returns the ith GridLevel of the grid structure. ithLevel must be 
   // between 0 and the total number of levels. Returns 0 if not found or 
   // if it is out of bounds.
   virtual DtMfGridLevel* level(size_t ithLevel) const;

protected:

   int myNumLevels;
   int myStartingLevel;
   std::vector< DtMfGridLevel* > myGridLevels;

};

#endif