metafileRecord.h

Go to the documentation of this file.

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

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include "terrainDbFactory/terrainDefines.h"
#include "geometry/color.h"
#include "geometry/point.h"
#include <vlutil/vlFilename.h>
#include <iosfwd>
#include <map>

class DtTerrainInitializer;
class DtSpecificationAttribute;

typedef std::map<DtString, DtString> DtPropertyNamesMap;
typedef DtPropertyNamesMap::iterator DtPropertyNamesIterator;
typedef DtPropertyNamesMap::const_iterator DtPropertyNamesConstIterator;

//
// This is the base class for all metafile records.
class DT_DLL_terrainDbFactory DtMetafileRecord
{

public:

   DtMetafileRecord();

   virtual ~DtMetafileRecord();

   DtMetafileRecord(const DtMetafileRecord& orig);

   DtMetafileRecord& operator=(const DtMetafileRecord& orig);

   virtual bool init();

   virtual DtString recordTypeName() const = 0;

   virtual DtConfigCategoryType recordCategory() const = 0;

   virtual bool canImport();

   virtual bool put(std::ostream& stream) const;

   virtual bool get(std::istream& stream);

   virtual bool processToken(std::istream& stream, DtString& token);

   virtual bool getAttribute(const DtString attrName, DtString& value, DtString& type, unsigned index=0);

   virtual bool setAttribute(DtString attrName, DtString value);

   virtual const DtTerrainInitializer* initializer() const;
   virtual DtTerrainInitializer* initializer();

   virtual void setInitializer(DtTerrainInitializer* init);

   virtual const int recordKey();
   virtual void setRecordKey(const int key);

   virtual const DtPropertyNamesMap properties() const;

   virtual const DtString& recordString() const;

   virtual void resetFileLists();

   virtual void setPath(const DtFilename&);
   virtual const DtFilename& path() const;

protected:

   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);

public:

   bool isInt(const DtString& valueIn);
   bool isDouble(const DtString& valueIn);
   bool isColor(const DtString& valueIn);
   bool isPoint(const DtString& valueIn);
   bool isBool(const DtString& valueIn);

   bool toInt(const DtString& valueIn, int& valueOut);
   bool toDouble(const DtString& valueIn, double& valueOut);
   bool toColor(const DtString& valueIn, DtColor& valueOut);
   bool toPoint(const DtString& valueIn, DtPoint& valueOut);
   bool toBool(const DtString& valueIn, bool& valueOut);

protected:

   DtTerrainInitializer* mypInitializer;
   DtString myRecordString;
   int myRecordKey;                      // Unique int indentifier for the record   
   DtPropertyNamesMap myAttributeNames;  // The attributes that the record has
   bool myCanImport;
   DtFilename myPath;

protected:

   static const DtString theImport;      // Used to determine whether the record is 
                                         // importable or not

};

DT_DLL_terrainDbFactory std::ostream& operator<<(std::ostream& str, const DtMetafileRecord& object);
DT_DLL_terrainDbFactory std::istream& operator>>(std::istream& str, DtMetafileRecord& object);

#endif