include/mtflt/mtFltDs.h

Go to the documentation of this file.

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

#ifndef mtFltDs_H_
#define mtFltDs_H_

//
// \file mtFltDs.h
// \brief Represents an abstraction of a DataSet node inside a Metaflight file.
//

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

// \brief Represents an abstraction of a DataSet node inside a Metaflight file.
// Datasets desribe the geometry used to build into the runtime scene graph. A
// Dataset is a collection of files that share a geographic Coverage area, a 
// Gridstack definition, and a filename pattern. The Dataset is an abstract 
// class that represents a collection of files that share a common root 
// directory path.
class DT_DLL_mtflt DtMtFltDataset : public DtMtFltNode
{
public:
   
   // Default constructor.
   DtMtFltDataset();
   
   // Destructor
   virtual ~DtMtFltDataset();
   
   // Copy constructor
   DtMtFltDataset(const DtMtFltDataset& node);
   
   // Assignment operator
   DtMtFltDataset& operator=(const DtMtFltDataset& orig);
  
   // Overrides the \p DtMtFltNode::readNode method to read the
   // common information to all DataSet nodes in the Metaflight file.
   // \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 Dataset's name
   virtual DtString dsName() const;

   // Returns the Dataset's title
   virtual DtString dsTitle() const;

   // Returns the Dataset's volume information. This is typically a drive letter
   virtual DtString volume() const;

   // Returns the Root path associated with the Dataset
   virtual DtString rootPath() const;

   // Returns the filename extension associated with the Dataset
   virtual DtString fileFormat() const;

   // Returns a vector with the filenames that conform this dataset
   // \param root mftFilename name of the metaflight file
   // \param files vector of strings in which the filelames are returned
   // \return \b true if there is at least one filename in the returning vector, 
   // \b false otherwise.
   virtual bool files(const DtFilename& mftFilename, std::vector<std::string>& files)=0;

protected:

   DtString myDsName;
   DtString myDsTitle;
   DtString myDsDescription; 
   DtString myVolume;
   DtString myRootPath;
   DtString myFileFormat;

};

#endif