extMtlParamDbWriter.h

Go to the documentation of this file.

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

#ifndef DtExtMtlParameterDbWriter_H_
#define DtExtMtlParameterDbWriter_H_

#include "vrfobjparam/mtlParamDbWriter.h"
#include "extMtlParamDbReader.h"
#include <string>

class DtReaderWriter;

//class DtExtMtlParameterDbWriter:
//
//Instances of DtExtMtlParameterDbWriter extend DtMtlParameterDbReader to 
//preserve comments when writing out a parameter database file. 

class DtExtMtlParameterDbWriter : public DtMtlParameterDbWriter
{
public:

   //default constructor
   DtExtMtlParameterDbWriter();

   //destructor
   virtual ~DtExtMtlParameterDbWriter();

   //Set initial comment to be written at start of file
   virtual void setInitialComment(const std::string& comment);

   //Set comment map to be used in prePutSelfCb().  Contains mapping of 
   //DtReaderWriter symbols to comments.
   virtual void setReaderWriterCommentMap(const DtReaderWriterCommentMap* map);

protected:

   //Writes myInitialComment to file.
   virtual void preWrite(const DtMtlParameterDbFileData&, const DtFilename&, FILE*) const;

   //Called by prePutSelfCb.  Overridden to use
   //DtReaderWriterCommentMap to look up comments associated with 
   //DtReaderWriter object.  If one exists, writes out comment to file.
   //(Comment assoicated with symbol will appear immediately before 
   //it in the file.)
   virtual void processPrePutSelfCb(DtReaderWriter* readerWriterObject,
      FILE* fp);

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

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

protected:

   std::string myInitialComment;
   const DtReaderWriterCommentMap* myReaderWriterCommentMap;
};

#endif