rwClassDocDB.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2007 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: rwClassDocDB.h,v $ $Revision: 1.1 $ $State: Exp $
** Created: 4/4/07 MEM
*******************************************************************************/

//
// File:        rwClassDocDB.h 
//
// Class:       DtReaderWriterClassDocDB
//
// Description: This class contains a database of DtReaderWriterClassDocumenation
// objects, keyed by class type (e.g. DtRwBoolean).  You can use it to look up 
// an entry in the database given a class type and DtReaderWriter data member 
// name. 
//

#ifndef rwClassDocDB_H_
#define rwClassDocDB_H_
#include <vrvUtil/signalslib.h>

#include "rwClassDocumenation.h"

typedef std::map<DtString, DtReaderWriterClassDocumentation> DtReaderWriterClassDocumentationMap;

class DtReaderWriterClassDocDB
{
public:
   DtReaderWriterClassDocDB();
   DtReaderWriterClassDocDB(const DtReaderWriterClassDocDB& orig);
   const DtReaderWriterClassDocDB& operator=(
      const DtReaderWriterClassDocDB& orig);
   virtual ~DtReaderWriterClassDocDB();

   // Add a given DtReaderWriter class documenation entry to the database.
   // There will be one entry per DtReaderWriter class.
   virtual void addEntry(const DtReaderWriterClassDocumentation& entry);

   // Look up the entry for a DtReaderWriter data member, give the DtReaderWriter
   // name of the data member, and the DtReaderWriter class it belongs to.  If
   // the item cannot be located in the given class, it will recursively move
   // up the inheritance tree in attempting to locate the item.
   virtual bool lookup(const DtString& rwClassType,
      const DtString& rwDataMemberName, 
      DtReaderWriterClassMemberDataRecord& record) const;

protected:

   // Map of DtReaderWriterClassDocumenation objects, keyed by DtReaderWriter
   // class type.
   DtReaderWriterClassDocumentationMap myRwClassDocumentationMap;
};

#endif