rwClassDocReader.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vrvUtil/signalslib.h>

//
// \file rwClassDocReader.h
// \brief A class that knows how to read a DtReaderWriter documentation file and 
// load it into a DtReaderWriterClassDocumentation object.  DtReaderWriter class
// documenation files are generated from class header files.
//

class DtFilename;
class DtReaderWriterClassDocumentation;

// \brief Represents a reader class that interacts with libXml to read a 
// VR-Forces DtReaderWriter class documentation file

class DtRwClassDocReader
{
public:

   // constructor.
   DtRwClassDocReader();

   // Destructor
   virtual ~DtRwClassDocReader();
   
   // Reads in contents of DtReaderWriter class doc file to class descriptor object
   virtual bool read(const DtFilename& filename, DtReaderWriterClassDocumentation&
      parameterDocDesc) const;

private:

   // Copy constructor -- not implemented
   DtRwClassDocReader(const DtRwClassDocReader& node);
   
   // Assignment operator -- not implemented
   DtRwClassDocReader& operator=(const DtRwClassDocReader& orig);
};