gmFileReader.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_FILE_READER_H_
#define _GEMA_FILE_READER_H_


#include <QString>
#include <QList>

class GmFileFormat;

class GmLogCategory;
class GmMesh;
class GmCellMesh;
class Unit;


class GmFileReader
{
public:
  GmFileReader();

  GmFileReader(const GmLogCategory& logger)
    : _logger(logger) {}

  virtual ~GmFileReader() { }

  /* \brief Opens files in preperation for later calls to readXxxx() functions.
            After those calls, the opened state will be closed by a call to closeFiles().
            On errors this function should return false.

      \param fileName        The name of the file that will be opened
      \param numNodeValues   The number of node variables (state vars/attributes) that will be read
      \param numElemValues   The number of element variables (attributes/properties) that will be read
      \returns Returns true on success, false on errors
  */
  virtual bool openFiles(QString fileName, int numNodeValues, int numElemValues) = 0;

  virtual bool initializeMesh(GmMesh* mesh, const QStringList& nodeValues, const QList<Unit>& nodeUnits,
                              const QStringList& elementValues, const QList<Unit>& elementUnits) = 0;

  virtual bool readNodeCoordinates(GmMesh* mesh, Unit coordUnit) = 0;

  virtual bool readCellGeometry(GmCellMesh* cellmesh) = 0;

  virtual bool readNodeData(GmMesh* mesh, const QStringList& nodeValues, const QList<Unit>& nodeUnits) = 0;

  virtual bool readCellData(GmCellMesh* cellmesh, const QStringList& elementValues, const QList<Unit>& elementUnits) = 0;

  virtual bool closeFiles() = 0;

  virtual GmFileFormat* fileFormat() = 0;

protected:
  const GmLogCategory& _logger;  
};

#endif