VR-Forces 4.0.4 Class Documentation
examples/convertParamDb/extMtlParamDb.h
Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2004 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: extMtlParamDb.h,v $ $Revision: 1.2 $ $State: Exp $
00007 *******************************************************************************/
00008 
00009 #ifndef DtExtMtlParameterDb_H_
00010 #define DtExtMtlParameterDb_H_
00011 
00012 #include "vrfobjparam/mtlParamDb.h"
00013 
00014 //class DtExtMtlParameterDb:
00015 //
00016 //Instances of DtExtMtlParameterDb extend the DtMtlParameterDb class to 
00017 //create derived kinds of DtMtlParamDbReader and DtMtlParamDbWriter classes
00018 //that know how to preserve comments when loading and saving parameter
00019 //database files.
00020 
00021 class DtExtMtlParameterDb : public DtMtlParameterDb
00022 {
00023 public:
00024 
00025    //default constructor
00026    DtExtMtlParameterDb();
00027 
00028    //destructor
00029    virtual ~DtExtMtlParameterDb();
00030 
00031    //Saves contents of parameter database to file.  Filename will be
00032    //given .opd file extension if it does not already exist.  Creates
00033    //subdirectory of the same name minus the .opd extension and places
00034    //individual object parameter entry files (.ope) for each entry in the
00035    //database.  Object parameter database file will contain list of filenames
00036    //referencing individual .ope files.
00037    //Override to register callback to look up and write out any associated
00038    //comments before calling putself.
00039    virtual bool save(const DtFilename& filename);
00040 
00041 protected:
00042 
00043    //Override to create a DtExtMtlParameterDbEntry.
00044    virtual DtVrfParameterDbEntry* createParameterEntry() const;
00045 
00046    //Override to create an instance of DtExtMtlParameterDbReader.
00047    virtual DtMtlParameterDbReader* createParamDbReader();
00048 
00049    //Override to create an instance of DtExtMtlParameterDbWriter.
00050    virtual DtMtlParameterDbWriter* createMtlParamDbWriter();
00051 
00052    //copy constructor - not implemented
00053    DtExtMtlParameterDb(const DtExtMtlParameterDb& orig);
00054 
00055    //assignment operator - not implemented
00056    DtExtMtlParameterDb& operator=(const DtExtMtlParameterDb& orig);
00057 };
00058 
00059 #endif

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)