extMtlParamDbReader.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: extMtlParamDbReader.h,v $ $Revision: 1.3 $ $State: Exp $
*******************************************************************************/

#ifndef DtExtMtlParameterDbReader_H_
#define DtExtMtlParameterDbReader_H_

#include "vrfobjparam/mtlParamDbReader.h"
#include "extMtl/extDtcRead.h"
#include "vrfutil/rdrWritr.h"

#include <map>
#include <string>

typedef std::map<DtlObj*, std::string> DtlObjStringMap;
typedef std::map<DtReaderWriter*, std::string> DtReaderWriterCommentMap;

class DtReaderWriter;

//class DtExtMtlParameterDbReader:
//
//Instances of DtExtMtlParameterDbReader extend DtMtlParameterDbReader to 
//preserve comments when reading in a parameter database file. 

class DtExtMtlParameterDbReader : public DtMtlParameterDbReader
{
public:

   //default constructor
   DtExtMtlParameterDbReader();

   //destructor
   virtual ~DtExtMtlParameterDbReader();

   //Returns object comment map (populated with entries from the most recent
   //call to load().
   virtual const DtReaderWriterCommentMap& readerWriterCommentMap() const;

   //Returns object comment map.  Not const because it may need to be modified
   //by the DtExtMtlParameterEntry (it has to be able to load itself on demand).
   virtual DtlObjStringMap& objectCommentMap();

   //Returns initial comment in the parameter database file.  This comment
   //is not part of the object comment map.
   virtual std::string initialComment() const;

public:

   static void postGetSelfCb(DtReaderWriter* readerWriterObject, DtlObjPtr args, 
      void* userData);

protected:

   //Load contents of legacy format parameter database file (pre-VR-Forces
   //version 3.7 *.opd file) into DtVrfObjectParametersList object.
   //Clears contents of object comment map  before loading.
   //The object comment map gets populated with DtlObj*/string pairs during
   //the load.
   virtual bool load(const DtFilename& parameterDbFile,
      DtVrfObjectParametersList* objectParamList);

   //copy constructor - not implemented
   DtExtMtlParameterDbReader(const DtExtMtlParameterDbReader& orig);

   //assignment operator - not implemented
   DtExtMtlParameterDbReader& operator=(const DtExtMtlParameterDbReader& orig);

protected:

   std::string myInitialComment;
   DtlObjStringMap myObjectCommentMap;
   DtReaderWriterCommentMap myReaderWriterCommentMap;
};

#endif