include/mtflt/mtFltGridLevel.h

Go to the documentation of this file.

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

#ifndef mtFltGridLevel_H_
#define mtFltGridLevel_H_

//
// \file mtFltGridLevel.h
// \brief Represents a GridLevel node inside the Metaflight file
//

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

// \brief Grid levels represent different resolution of data inside a metaflight
// Grid levels are each divided into colums and rows of <em>cells</em>. Each cell
// is associated with one flight file.
class DT_DLL_mtflt DtMfGridLevel : public DtMtFltNode 
{    
public:

   // Default constructor.
   DtMfGridLevel( );

   // Destructor
   virtual ~DtMfGridLevel( );

   // Copy constructor
   DtMfGridLevel(const DtMfGridLevel& node);

   // Assignment operator
   DtMfGridLevel& operator=(const DtMfGridLevel& orig);

   // Overrides the \p DtMtFltNode::readNode method to read the
   // node information from a Metaflight GridLevel 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 name of the grid level
   virtual DtString levelName() const;

   // Returns the total of column divisions in the grid level
   virtual unsigned int numColDivisions() const;

   // Returns the total of row divisions in the grid level
   virtual unsigned int numRowDivisions() const;

protected:

   DtString myLevelName;
   int myNumColDivisions;
   int myNumRowDivisions;
    
};

#endif