Optika_treemodel.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//         Optika: A Tool For Developing Parameter Obtaining GUIs
//                Copyright (2009) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, with Sandia Corporation, the 
// U.S. Government retains certain rights in this software.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Kurtis Nusbaum (klnusbaum@gmail.com) 
// 
// ***********************************************************************
// @HEADER
#ifndef OPTIKA_MODEL_HPP_
#define OPTIKA_MODEL_HPP_
#include <QAbstractItemModel>
#include <QModelIndex>
#include <QVariant>
#include <QDir>
#include "Optika_treeitem.hpp"

class QDomElement;

namespace Optika{

class TreeItem;

class TreeModel : public QAbstractItemModel{
  Q_OBJECT
public:


  TreeModel(
    RCP<ParameterList> validParameters,
    RCP<DependencySheet> dependencySheet=null,
    QString saveFileName=QString(), 
    QObject *parent=0);

  ~TreeModel();


  QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const;
  Qt::ItemFlags flags(const QModelIndex &index) const;
  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const;
  QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
  QModelIndex parent(const QModelIndex &index) const;
  bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
  int rowCount(const QModelIndex &parent = QModelIndex()) const;
  int columnCount(const QModelIndex &parent = QModelIndex()) const;



  void issueInitilizationSignals();



  
  void printOut() const;




  bool writeOutput(QString fileName);

  void readInput(QString fileName);



  
  QString getSaveFileName();

  bool isSaved();

  void setIsSaved() { saved = true; }

  void reset();

  QString itemType(const QModelIndex &index) const;

  bool hasDependencies();

  bool hasValidValue(QModelIndex valueToCheck) const;

  RCP<const ParameterEntryValidator> getValidator(const QModelIndex &index) const;

  template <class S>
  Array<S> getArray(const QModelIndex& index){
    return any_cast<Array<S> >(itemEntry(index)->getAny()); 
  }

  template <class S>
  TwoDArray<S> getTwoDArray(const QModelIndex& index){
    return any_cast<TwoDArray<S> >(itemEntry(index)->getAny()); 
  }

  RCP<const ParameterList> getCurrentParameters();

  QModelIndex findParameterEntryIndex(RCP<const ParameterEntry> parameterEntry);




  static const int getRawDataRole(){
    static const int RawDataRole = Qt::UserRole;
    return RawDataRole;
  }


signals:



  void hideData(int row, const QModelIndex& parent);

  void showData(int row, const QModelIndex& parent);

  void badValue(QModelIndex badItem,  QString message);


private:
  
  bool saved;

  bool dependencies;

  QString saveFileName;

  TreeItem *rootItem;

  RCP<ParameterList> validParameters;

  RCP<const ParameterList> canonicalList;

  RCP<DependencySheet> dependencySheet;



  RCP<const ParameterEntry> 
    itemEntry(const QModelIndex &index) const;

  void readInParameterList(RCP<ParameterList> validParameters, TreeItem *parentItem);

  void insertParameterList(RCP<ParameterList> parameterList, RCP<ParameterEntry> listEntry, std::string plname, TreeItem *parent);

  void insertParameter(RCP<ParameterEntry> parameter, std::string name, TreeItem *parent);

  void basicSetup(QString saveFileName);

  void checkDependentState(const QModelIndex dependee, RCP<Dependency> dependency);

  QModelIndex parameterEntryMatch(const QModelIndex &start,
    const RCP<const ParameterEntry> &parameterEntry) const;


  void processInputElement(const QDomElement& element);

  bool isRealMatch(
    const QDomElement& element, 
    const QModelIndex& potentialMatch) const;

  bool isRootIndex(const QModelIndex& index) const;
  


private slots:



  void currentFileNowModified();

  void dataChangedListener(const QModelIndex& index1, const QModelIndex& index2);

};


} //end namespace 
#endif /* OPTIKA_MODEL_HPP_ */