GUIParameterTableItem.h

Go to the documentation of this file.

/****************************************************************************/
// A single line in a parameter window
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program is free software; you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation; either version 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef GUIParameterTableItem_h
#define GUIParameterTableItem_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <fx.h>
#include <utils/common/ValueSource.h>
#include <utils/common/ToString.h>
#include <utils/gui/div/GUIParam_PopupMenu.h>
#include <utils/gui/images/GUIIconSubSys.h>
#include <utils/gui/windows/GUIAppEnum.h>


// ===========================================================================
// class definitions
// ===========================================================================
// ---------------------------------------------------------------------------
// GUIParameterTableItemInterface
// ---------------------------------------------------------------------------
class GUIParameterTableItemInterface {
public:
    virtual ~GUIParameterTableItemInterface()  throw() {}



    virtual bool dynamic() const throw() = 0;


    virtual void update() throw() = 0;


    virtual ValueSource<SUMOReal> *getSUMORealSourceCopy() const throw() = 0;


    virtual const std::string& getName() const throw() = 0;

};


// ---------------------------------------------------------------------------
// GUIParameterTableItem
// ---------------------------------------------------------------------------
template<class T>
class GUIParameterTableItem : public GUIParameterTableItemInterface {
public:
    GUIParameterTableItem(FXTable* table, unsigned pos,
                          const std::string& name, bool dynamic,
                          ValueSource<T> *src) throw()
        : myAmDynamic(dynamic), myName(name), myTablePosition((FXint) pos), mySource(src),
          myValue(src->getValue()), myTable(table) {
        init(dynamic, toString<T>(src->getValue()));
    }


    GUIParameterTableItem(FXTable* table, unsigned pos,
                          const std::string& name, bool dynamic,
                          T value) throw()
        : myAmDynamic(dynamic), myName(name), myTablePosition((FXint) pos), mySource(0),
          myValue(value), myTable(table) {
        init(dynamic, toString<T>(value));
    }


    GUIParameterTableItem(FXTable* table, unsigned pos,
                          const std::string& name, bool dynamic,
                          std::string value) throw()
        : myAmDynamic(dynamic), myName(name), myTablePosition((FXint) pos), mySource(0),
          myValue(0), myTable(table) {
        init(dynamic, value);
    }


    ~GUIParameterTableItem() throw() {
        delete mySource;
    }


    void init(bool dynamic, std::string value) throw() {
        myTable->setItemText(myTablePosition, 0, myName.c_str());
        myTable->setItemText(myTablePosition, 1, value.c_str());
        if (dynamic) {
            myTable->setItemIcon(myTablePosition, 2, GUIIconSubSys::getIcon(ICON_YES));
        } else {
            myTable->setItemIcon(myTablePosition, 2, GUIIconSubSys::getIcon(ICON_NO));
        }
        myTable->setItemJustify(myTablePosition, 2, FXTableItem::CENTER_X|FXTableItem::CENTER_Y);
    }



    bool dynamic() const throw() {
        return myAmDynamic;
    }


    const std::string& getName() const throw() {
        return myName;
    }


    void update() throw() {
        if (!dynamic()||mySource==0) {
            return;
        }
        T value = mySource->getValue();
        if (value!=myValue) {
            myValue = value;
            myTable->setItemText(myTablePosition, 1, toString<T>(myValue).c_str());
        }
    }


    ValueSource<T> *getSourceCopy() const throw() {
        if (mySource==0) {
            return 0;
        }
        return mySource->copy();
    }


    ValueSource<SUMOReal> *getSUMORealSourceCopy() const throw() {
        if (mySource==0) {
            return 0;
        }
        return mySource->makeSUMORealReturningCopy();
    }


private:
    bool myAmDynamic;

    std::string myName;

    FXint myTablePosition;

    ValueSource<T> *mySource;

    T myValue;

    FXTable* myTable;

};


#endif

/****************************************************************************/