include/mtflt/mtFltGridStack.h

Go to the documentation of this file.

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

#ifndef mtFltGridStack_H_
#define mtFltGridStack_H_

//
// \file mtFltGridStack.h
// \brief Represents a GridStack node inside the Metaflight file.
//

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

// \brief Represents a GridStack node inside the Metaflight file.
// This class represents a Grid Stack, which is a multi-level indexing scheme
// that spatially divides a Coverage and binds the indices to files on disk that 
// conform to some naming convention described by a FilenamePattern. This is 
// one of the types of information conveyed by MetaFlight.
class DT_DLL_mtflt DtMtFltGridStack : public DtMtFltNode
{
public:
   
   // Default constructor.
   DtMtFltGridStack();
   
   // Copy constructor
   DtMtFltGridStack(const DtMtFltGridStack& node);

   // Destructor
   virtual ~DtMtFltGridStack();
   
   // Assignment operator
   DtMtFltGridStack& operator=(const DtMtFltGridStack& orig);

   // Overrides the \p DtMtFltNode::readNode method to read the
   // node information from a Metaflight GridStack 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 file name pattern associated with the grid stack
   virtual DtString fileNamePattern() const;

   // Returns the grid structure associated with the grid stack
   virtual DtMtFltGridStructure* gridStructureUsed() const;
   
protected:

   DtString myFileNamePattern;
   DtMtFltGridStructure* myGridStructureUsed;

};

#endif