SimEngine.h

Go to the documentation of this file.

#ifndef SIMENGINE_H_
#define SIMENGINE_H_

#include "globaldefinitions.h"
#include "SpikeScheduler.h"
#include "SimObjectPool.h"


#include <string>
using std::string;

#include <boost/format.hpp>

#include <iostream>
using std::cout;
using std::endl;
using std::cerr;


class SimNetwork;

class SimEngine
{
public:

    class ID
    {
    public:
        explicit ID( nodeid_t n ) : node(n), engine(0) { };
        explicit ID( nodeid_t n, engineid_t e ) : node(n), engine(e) { };        
        explicit ID() : node(0), engine(0) { };
        
        nodeid_t node;
        engineid_t engine;
        static const ID Invalid;
        static const ID Zero;
        bool operator==(const ID& other) const
        {
            return ( this->engine == other.engine ) &&
                   ( this->node == other.node ) ;
        }

        bool operator!=(const ID& other) const
        {
            return ( this->engine != other.engine ) ||
                   ( this->node != other.node ) ;
        }

        string toString() const { return str ( boost::format("(n=%1%,e=%2%)") % node % engine ); };
    };

    SimEngine(int id, SpikeScheduler &ss, SimNetwork &net);

    /* Copy constructor
    SimEngine(const SimEngine& src) :
            default_steps_per_cycle(src.default_steps_per_cycle),
            eid(src.eid), spikeScheduler(src.spikeScheduler),
            simParam(src.simParam)
    { };

    SimEngine& operator=(const SimEngine& src)
    {
        *this = src;
        return *this;
    }; */

    virtual ~SimEngine()
    { /* NOOP */ };

    virtual void reset()=0;



    virtual void initialize() = 0;



    virtual void advance(int nSteps=1) = 0;

    virtual void advanceSeveralStepsWithinACycle(int nsteps) = 0;

    virtual void finalizeCycle()  = 0;


    virtual void advanceOneFullCycle() = 0;


    //virtual void addObject( SimObject *obj, SimObject::ID &id) = 0;

    virtual void addObject( SimObjectFactory const& objFactory, SimObject::ID &id ) = 0;

    virtual void mount( const SimObjectFactory &objFactory, const SimObject::ID &mountpoint, SimObject::ID &gid ) = 0;

    virtual void insert( const SimObjectFactory &objFactory, const SimObject::ID &container, SimObject::ID &gid ) = 0;

    virtual SimObject *getObject(const SimObject::ID &id) = 0;

    inline engineid_t getLocalEid() const { return eid; };

    inline SpikeScheduler *getSpikeScheduler() const { return &spikeScheduler; };

    virtual void seed( vector<uint32> const& noiseSeed )=0;
    virtual void seed( uint32 noiseSeed )=0;
    virtual void noiseRandEngineOutput( vector<uint32> & r ){};
    
protected:

    int default_steps_per_cycle;

    engineid_t eid;

    SpikeScheduler &spikeScheduler;

    friend class SimObject;
    SimNetwork &network;

};

ostream& operator<<(ostream &s, const SimEngine::ID &id);

#endif /* SIMENGINE_H_ */

---