rwClassDocumenation.h

Go to the documentation of this file.

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

//
// File:        rwClassDocumenation.h 
//
// Class:       DtReaderWriterClassDocumentation
//
// Description: This class holds the documenatation associated with a given
// DtReaderWriter class.
//

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

#include <map>
#include <vector>
#include <vlutil/vlString.h>

// Documenation associated with a single data member in a DtReaderWriter class.
class DtReaderWriterClassMemberDataRecord
{
public:
   DtReaderWriterClassMemberDataRecord();
   DtReaderWriterClassMemberDataRecord(const DtReaderWriterClassMemberDataRecord& orig);
   const DtReaderWriterClassMemberDataRecord& operator=(
      const DtReaderWriterClassMemberDataRecord& orig);
   virtual ~DtReaderWriterClassMemberDataRecord();

   DtString myName;
   DtString myClass;
   DtString myDescription;
   DtString myDefaultValue;
   DtString myUnits;
   DtString myRange;
};

typedef std::map<DtString, DtReaderWriterClassMemberDataRecord> DtClassMemberDataMap;
typedef std::vector<DtString> DtParentClassTypeList;

// Documentation record for a given DtReaderWriter class.
class DtReaderWriterClassDocumentation
{
public:

   DtReaderWriterClassDocumentation();

   DtReaderWriterClassDocumentation(const DtReaderWriterClassDocumentation& orig);

   const DtReaderWriterClassDocumentation& operator=(
      const DtReaderWriterClassDocumentation& orig);

   virtual ~DtReaderWriterClassDocumentation();

   DtString myHeaderFile;
   DtString myClassType;
   DtParentClassTypeList myParentClassTypeList;
   DtClassMemberDataMap myMemberDataMap;
};



#endif