gdbProcessingMetafileRecord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: gdbProcessingMetafileRecord.h,v $ $Revision: 1.13 $ $State: Exp $
*******************************************************************************/
#ifndef gdbProcessingMetafileRecord_H_
#define gdbProcessingMetafileRecord_H_

// 
// \file gdbProcessingMfRecord.h 
// \brief Contains the DtGdbProcessingMetafileRecord class description.
//

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include "terrainDbFactory/metafileRecord.h"
#include <iosfwd>
#include "gdb/terrainDatabaseToolConfiguration.h"

// The DtGdbProcessingMetafileRecord is a metafile record that allows users
// to specify in a .map file what post-processing to perform, and how, after 
// loading a gdb file or importing data into gdb format.  This is different from
// the other metafile records in that it does not deal with loading/importing at
// all, but rather specifies post-processing options, performed after load/import
// are complete.
class DT_DLL_terrainDbFactory DtGdbProcessingMetafileRecord : public DtMetafileRecord
{

public:

   // default constructor.
   DtGdbProcessingMetafileRecord();

   // destructor
   virtual ~DtGdbProcessingMetafileRecord() override;

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

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

   // Returns DtConfigTerrainProcessType
   virtual DtConfigCategoryType recordCategory() const override;

   // Returns the type name for the particular record.  
   // In this case, "gdbProcessing"
   virtual DtString recordTypeName() const override;

   virtual DtTerrainDatabaseToolConfiguration terrainDbConfig() const;
   virtual void setTerrainDbConfig(
      const DtTerrainDatabaseToolConfiguration& newTerrainDbConfig);

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

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

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

protected:

   static const DtString theEnableSpatialSubdivision;
   static const DtString theSsXresolution;
   static const DtString theSsYresolution;
   static const DtString theSsZresolution;
   static const DtString theBalanceTerrain;
   static const DtString theLeafingFactor;
   static const DtString theBranchingFactor;
   static const DtString theReduceTerrain;
   static const DtString theReductionTolerance;
   static const DtString theCollapseCoordinateSystemNodes;
   static const DtString theConvertToGeocentric;
   static const DtString theClipVectorData;
   static const DtString thePlanarizeVectorData;
   static const DtString thePlanarizeTolerance;
   static const DtString thePlanarizeExcessiveEdgeCount;

   DtTerrainDatabaseToolConfiguration myTerrainDbToolConfiguration;
};

#endif