Visitor.h

Go to the documentation of this file.

/******************************************************************************
*       SOFA, Simulation Open-Framework Architecture, version 1.0 beta 3      *
*                (c) 2006-2008 MGH, INRIA, USTL, UJF, CNRS                    *
*                                                                             *
* 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 Street, Fifth Floor, Boston, MA  02110-1301 USA.          *
*******************************************************************************
*                               SOFA :: Modules                               *
*                                                                             *
* Authors: The SOFA Team and external contributors (see Authors.txt)          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
#ifndef SOFA_SIMULATION_ACTION_H
#define SOFA_SIMULATION_ACTION_H

#include <sofa/simulation/common/Node.h>
#include <sofa/simulation/common/LocalStorage.h>

namespace sofa
{

namespace simulation
{


class LocalStorage;

class Visitor
{
public:
    virtual ~Visitor() {}
    
    enum Result { RESULT_CONTINUE, RESULT_PRUNE };

    virtual Result processNodeTopDown(simulation::Node* /*node*/) { return RESULT_CONTINUE; }

    virtual void processNodeBottomUp(simulation::Node* /*node*/) {}

    virtual const char* getCategoryName() const { return "default"; }

    template < class Act, class Container, class Object >
      void for_each(Act* action, simulation::Node* node, const Container& list, void (Act::*fn)(simulation::Node*, Object*))
    {
    
        if (node->getLogTime())
        {
            const std::string category = getCategoryName();
            ctime_t t0 = node->startTime();
            for (typename Container::iterator it=list.begin(); it != list.end(); ++it)
            {
                (action->*fn)(node, *it);
                t0 = node->endTime(t0, category, *it);
            }
        }
        else
        {
            for (typename Container::iterator it=list.begin(); it != list.end(); ++it)
            {
                (action->*fn)(node, *it);
            }
        }
    
    }

        template < class Act, class Container, class Object >
      Visitor::Result for_each_r(Act* action, simulation::Node* node, const Container& list, Visitor::Result (Act::*fn)(simulation::Node*, Object*))
    {
                
                    Visitor::Result res = Visitor::RESULT_CONTINUE;
                    if (node->getLogTime())
                    {
                        const std::string category = getCategoryName();
                        ctime_t t0 = node->startTime();
                        for (typename Container::iterator it=list.begin(); it != list.end(); ++it)
                        {
                            res = (action->*fn)(node, *it);
                            t0 = node->endTime(t0, category, *it);
                        }
                    }
                    else
                    {
                        for (typename Container::iterator it=list.begin(); it != list.end(); ++it)
                        {
                            res = (action->*fn)(node, *it);
                        }
                    }
                    return res;
                
    }

    //template < class Act, class Container, class Object >
    //void for_each(Act* action, const Container& list, void (Act::*fn)(Object))
    //{
    //  for (typename Container::iterator it=list.begin(); it != list.end(); ++it)
    //  {
    //      (action->*fn)(*it);
    //  }
    //}

    typedef simulation::Node::ctime_t ctime_t;

    ctime_t begin(simulation::Node* node, core::objectmodel::BaseObject* /*obj*/)
    {
        return node->startTime();
    }

    void end(simulation::Node* node, core::objectmodel::BaseObject* obj, ctime_t t0)
    {
        node->endTime(t0, getCategoryName(), obj);
    }

    void execute(core::objectmodel::BaseContext*);


    virtual bool isThreadSafe() const { return false; }

    virtual Result processNodeTopDown(simulation::Node* node, LocalStorage*) { return processNodeTopDown(node); }

    virtual void processNodeBottomUp(simulation::Node* node, LocalStorage*) { processNodeBottomUp(node); }
};

} // namespace simulation

} // namespace sofa

#endif