lifecycleevent.h

Go to the documentation of this file.

 
#ifndef LIFECYCLEEVENT_H
#define LIFECYCLEEVENT_H
 
#include <string>
#include <list>
#include <map>
#include "param.h"
#include "simcomponent.h"
#include "metapop.h"
 
class LifeCycleEvent :  public virtual SimComponent
{
protected:  
  
  std::string _event_name;
  
  
  Metapop* _popPtr;
  
  
  std::string _LCELinkedTraitType;
  
  
  int _LCELinkedTraitIndex;
  
 
public: 
  LifeCycleEvent (const char* name, const char* trait_link) 
  : _popPtr(0), _LCELinkedTraitType(trait_link), _LCELinkedTraitIndex(-1)
  {
//    cout << "calling LifeCycleEvent("<<name<<","<<trait_link<<")\n";
    set_event_name(name);
  }
 
 
  virtual ~LifeCycleEvent ( ) { }
 
  
  virtual void init(Metapop* popPtr)
  { 
    _popPtr = popPtr;
    if(!attach_trait(_LCELinkedTraitType)) fatal("bailing out\n");
    if(!setParameters()) fatal("bailing out\n");
  }
  
  
  
  virtual bool attach_trait (string trait)
  {
    _LCELinkedTraitType = trait;
    
    if(_LCELinkedTraitType.size() != 0) {
      
      _LCELinkedTraitIndex = _popPtr->getTraitIndex(_LCELinkedTraitType.c_str());
  
      if(_LCELinkedTraitIndex == -1) {
        return error("cannot attach trait \"%s\" to life cycle event \"%s\", trait has not been initiated.\n",
              _LCELinkedTraitType.c_str(), _event_name.c_str()); 
      }
    
    }
    
    return true;
  }
  
  virtual void set_paramset (std::string name, bool required, SimComponent* owner )
  {
    SimComponent::set_paramset(name, required, owner);
    add_parameter(name.c_str(),INT,1,0,0,0,0);
  }
  
  virtual void set_event_name (std::string& name)
  {
    _event_name = name;
    set_paramset(name, 0, this);
  }
  
  virtual void set_event_name (const char* name)
  {
    _event_name = name;
    set_paramset(name, 0, this); 
  }
  
  virtual string& get_event_name ( ) 
  { return _event_name; }
  
  virtual int get_rank ( )
  { return (int)get_parameter_value(_event_name.c_str()); }
  
  virtual void set_pop_ptr (Metapop* popPtr)
  {_popPtr = popPtr;}
  
  virtual Metapop*   get_pop_ptr ( ) 
  { return _popPtr; }
  
  
  
  
  
  virtual void  execute () = 0;
  
  virtual LifeCycleEvent*  clone () = 0;
  
  virtual age_t removeAgeClass () = 0;
  
  virtual age_t addAgeClass () = 0;
  
  virtual age_t requiredAgeClass () = 0;
  
  
  
  
};
 
#endif //LIFECYCLEEVENT_H