XFormulaAutomaton.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Math Library
 * Module     : XFormulaAutomaton
 * Package    : Zeus.ZeusMath.System
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef XFormulaAutomatonH
#define XFormulaAutomatonH

#include <zeusmath/System/Interfaces/IXFormulaAutomaton.hpp>
#include <zeusmath/System/Interfaces/IAngle.hpp>
#include <zeusbase/System/SingleLinkedList.hpp>
#include <zeusbase/System/XObject.h>
#include <zeusbase/System/VariableResolver.h>
#include <zeusbase/System/StringMap.hpp>
#include <zeusbase/System/Set.hpp>
#include <zeusbase/System/XObjectFactory.h>

BEGIN_NAMESPACE_Zeus

class TFormulaParser;
class IXFormulaAutomatonObserver;

/*****************************************************************************/
/*****************************************************************************/
zeusmath_class TXFormulaAutomaton : public TXObject, public IXFormulaAutomaton
{
  public:
    TXFormulaAutomaton(IXMLNode& rNode);

    //Methods of IXFormulaAutomaton
    virtual Retval MQUALIFIER getValue(const IString& rName, Float& rfValue);
    virtual bool MQUALIFIER isLocked() const;
    virtual bool MQUALIFIER isValid() const;
    virtual void MQUALIFIER lockEvaluation();
    virtual void MQUALIFIER unlockEvaluation();
    virtual Retval MQUALIFIER setInputValue(const IString& rName, const Float& rfValue);

    //Methods of IXObject
    virtual bool MQUALIFIER freeze();
    virtual bool MQUALIFIER unfreeze();

    //Methods of ISubject
    virtual Retval MQUALIFIER attach(IObserver& rObserver);
    virtual Retval MQUALIFIER detach(IObserver& rObserver);

    //Methods of IZUnknown
    MEMORY_MANAGER_DECL

    REG_SUB_BEGIN(TXFormulaAutomaton)
    REG_SUB_ADD(TXFormulaAutomaton, L"TXFormulaAutomaton");
    REG_SUB_END

  protected:
    virtual ~TXFormulaAutomaton();

    Retval evaluate_internal(bool bAll);

  private:
    /************************************************************************/
    /************************************************************************/
    class TPredicate : public TVariableResolver
    {
      public:
        TPredicate(IXMLNode& rNode, IAngle::ESystem eAngleSystem);

        void attachObserver(IXFormulaAutomatonObserver& rObserver);
        void detachObserver(IXFormulaAutomatonObserver& rObserver);
        Retval calculateValue(TSet<TPredicate*>& rSetOfUnCalculatedPredicates);

        inline Float getCalculationValue() const { return m_fValue; }
        inline TString getCondition() const { return m_strCondition; }
        inline TString getFormula() const { return m_mapFormula.getItemConst(TString(L"")); }
        inline TString getFormula(const TString& rConditionValue) const { return m_mapFormula.getItemConst(rConditionValue); }
        inline TString getName() const { return m_strName; }
        inline bool isCalculated() const { return m_bCalculated; }
        inline bool isValid() const { return m_bValid; }

        void resetCalculationValue();
        inline void setCalculationValue(const Float& rValue) { m_fValue = rValue; }

        void resolveDependancies(TStringMap<TPredicate*>& rMap);
        void releaseDependancies();
        void releaseObservers();

      protected:
        virtual ~TPredicate();
        void addPredecessor(TPredicate& rPredicate);
        void addSuccessor(TPredicate& rPredicate);
        void notifyObservers();

        //Method of TVariableResolver
        virtual Retval resolveVariable(const TString& rName, TString& rValue);

      private:
        IXMLNode& m_rNode;
        TString m_strName;
        TString m_strCondition;
        TStringMap<TString> m_mapFormula;
        bool m_bCalculated;
        bool m_bValid;
        Float m_fValue;
        TStringMap<TPredicate*> m_mapPredecessors;
        TStringMap<TPredicate*> m_mapSuccessors;
        IAngle::ESystem m_eAngleSystem;
        TSingleLinkedList<IXFormulaAutomatonObserver*> m_lstObservers;
    };

    Int m_iLock;
    TStringMap<TPredicate*> m_mapInputVariables;
    TStringMap<TPredicate*> m_mapPredicates;
    TStringMap<TPredicate*> m_mapOutputVariables;

    void releaseInstances();
};

/*****************************************************************************/
/*****************************************************************************/
inline bool MQUALIFIER TXFormulaAutomaton::isLocked() const
{
  return (m_iLock > 0);
}

/*****************************************************************************/
/*****************************************************************************/
inline void MQUALIFIER TXFormulaAutomaton::lockEvaluation()
{
  ++m_iLock;
}

/*****************************************************************************/
/*****************************************************************************/
inline void MQUALIFIER TXFormulaAutomaton::unlockEvaluation()
{
  m_iLock--;
  if (m_iLock <= 0)
  {
    m_iLock = 0;
    evaluate_internal(true);
  }
}

END_NAMESPACE_Zeus

#endif