include/terrainDbFactory/terrainDescriptorRec.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: terrainDescriptorRec.h,v $ $Revision: 1.1 $ $State: Exp $
** Created: 3/24/06 MEM, Updated: 4/24/06
*******************************************************************************/
#ifndef terrainDescriptorRec_H_
#define terrainDescriptorRec_H_

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include "terrainDbFactory/mfRec.h"


// The DtTerrainDescriptor record specifies the gdb file to load and whether the
// gdb has been altered since it was created.
class DT_DLL_terrainDbFactory DtTerrainDescriptorRecord : public DtMetafileRecord
{

public:

   // default constructor.
   DtTerrainDescriptorRecord();

   // destructor
   virtual ~DtTerrainDescriptorRecord();

   // copy constructor
   DtTerrainDescriptorRecord(const DtTerrainDescriptorRecord& orig);

   // assignment operator
   DtTerrainDescriptorRecord& operator=(const DtTerrainDescriptorRecord& orig);

   // Returns "mtd".
   virtual DtString recordTypeName() const;

   // Returns DtConfigTerrainDescriptorType
   virtual DtConfigCategoryType recordCategory() const;

   // Returns filename of database
   virtual const DtFilename& filename() const;
   virtual void setFilename(const DtFilename & name);

   // If true the terrain has been altered--soil types changed, color changed....
   // from the configuration used to initially build it.
   virtual bool terrainAltered() const;
   virtual void setTerrainAltered(bool altered);

   virtual bool loadMtdFile(const DtFilename& name);

   // Read self from stream.
   virtual bool get(std::istream& stream);

   // identifies a token or passes it to the parent class.
   virtual bool processToken(std::istream& stream, DtString& token);

   static DtMetafileRecord* create();

protected:
   // Write self to stream
   virtual bool writeAttributes(std::ostream& stream) const;
   virtual bool getAttribute(const DtString attrName, DtString& value, unsigned index=0);
   virtual bool setToken(const DtString& token, const DtString value);
protected:

   static const DtString theParameterFile;
   static const DtString theTerrainHasBeenAltered;

   bool myTerrainHasBeenAltered;
   DtFilename myFile;

};

#endif