fpmas::model::detail::DefaultModel< SyncMode > Class Template Reference

#include <model.h>

Inheritance diagram for fpmas::model::detail::DefaultModel< SyncMode >:

Collaboration diagram for fpmas::model::detail::DefaultModel< SyncMode >:

Public Member Functions
	DefaultModel ()
	DefaultModel (api::graph::LoadBalancing< AgentPtr > &load_balancing)
	DefaultModel (api::scheduler::Scheduler &scheduler, api::runtime::Runtime &runtime, api::graph::LoadBalancing< AgentPtr > &load_balancing)
Public Member Functions inherited from fpmas::model::detail::Model
	Model (api::model::AgentGraph &graph, api::scheduler::Scheduler &scheduler, api::runtime::Runtime &runtime, api::model::LoadBalancing &load_balancing)
	Model (const Model &)=delete
	Model (Model &&)=delete
Model &	operator= (const Model &)=delete
Model &	operator= (Model &&)=delete
api::model::AgentGraph &	graph () override
const api::model::AgentGraph &	graph () const override
api::scheduler::Scheduler &	scheduler () override
const api::scheduler::Scheduler &	scheduler () const override
api::runtime::Runtime &	runtime () override
const api::runtime::Runtime &	runtime () const override
const scheduler::Job &	loadBalancingJob () const override
api::model::AgentGroup &	buildGroup (api::model::GroupId id) override
api::model::AgentGroup &	buildGroup (api::model::GroupId id, const api::model::Behavior &behavior) override
void	removeGroup (api::model::AgentGroup &group) override
api::model::AgentGroup &	getGroup (api::model::GroupId id) const override
const std::unordered_map< GroupId, api::model::AgentGroup * > &	groups () const override
AgentEdge *	link (api::model::Agent *src_agent, api::model::Agent *tgt_agent, api::graph::LayerId layer) override
void	unlink (api::model::AgentEdge *edge) override
api::communication::MpiCommunicator &	getMpiCommunicator () override
const api::communication::MpiCommunicator &	getMpiCommunicator () const override
void	clear () override
virtual AgentGraph &	graph ()=0
virtual const AgentGraph &	graph () const =0
virtual api::scheduler::Scheduler &	scheduler ()=0
virtual const api::scheduler::Scheduler &	scheduler () const =0
virtual api::runtime::Runtime &	runtime ()=0
virtual const api::runtime::Runtime &	runtime () const =0
virtual const api::scheduler::Job &	loadBalancingJob () const =0
virtual AgentGroup &	buildGroup (GroupId id)=0
virtual AgentGroup &	buildGroup (GroupId id, const Behavior &behavior)=0
virtual void	removeGroup (AgentGroup &group)=0
virtual AgentGroup &	getGroup (GroupId id) const =0
virtual const std::unordered_map< GroupId, AgentGroup * > &	groups () const =0
virtual AgentEdge *	link (Agent *src_agent, Agent *tgt_agent, api::graph::LayerId layer)=0
virtual void	unlink (AgentEdge *edge)=0
virtual api::communication::MpiCommunicator &	getMpiCommunicator ()=0
virtual const api::communication::MpiCommunicator &	getMpiCommunicator () const =0
virtual void	clear ()=0

Additional Inherited Members
Protected Member Functions inherited from fpmas::model::detail::Model
void	insert (api::model::GroupId id, api::model::AgentGroup *group) override
virtual void	insert (GroupId id, AgentGroup *group)=0

Detailed Description

template<template< typename > class SyncMode>
class fpmas::model::detail::DefaultModel< SyncMode >

Model extension based on the DefaultModelConfig.

It is recommended to use this helper class to instantiate a Model.

Example

// main.cpp
#include "fpmas.h"
 
using namespace fpmas;
 
class UserAgent1 : public model::AgentBase<UserAgent1> {
    public:
    void act() override {
        FPMAS_LOG_INFO(UserAgent1, "Execute agent %s",
        FPMAS_C_STR(this->node()->getId()))
    }
};
 
class UserAgent2 : public model::AgentBase<UserAgent2> {
    public:
    void act() override {
        FPMAS_LOG_INFO(UserAgent2, "Execute agent %s",
        FPMAS_C_STR(this->node()->getId()))
    }
};
 
#define USER_AGENTS UserAgent1, UserAgent2
 
FPMAS_DEFAULT_JSON(UserAgent1)
FPMAS_DEFAULT_JSON(UserAgent2)
 
FPMAS_JSON_SET_UP(USER_AGENTS)
 
 
int main(int argc, char** argv) {
    fpmas::init(argc, argv);
    FPMAS_REGISTER_AGENT_TYPES(USER_AGENTS);
 
    {
        model::DefaultModel model;
 
        model::AgentGroup& group_1 = model.buildGroup();
        group_1.add(new UserAgent1);
        group_1.add(new UserAgent2);
 
        model.scheduler().schedule(0, 1, group_1.job());
        model.scheduler().schedule(0, 50, model.loadBalancingJob());
 
        model.runtime().run(1000);
    }
    fpmas::finalize();
}

Constructor & Destructor Documentation

DefaultModel() [1/3]

template<template< typename > class SyncMode>

fpmas::model::detail::DefaultModel< SyncMode >::DefaultModel ( )

inline

DefaultModel default constructor.

Default graph, load balancing algorithm, runtime and scheduler defined in DefaultModelConfig are used to initialize the Model.

DefaultModel() [2/3]

template<template< typename > class SyncMode>

fpmas::model::detail::DefaultModel< SyncMode >::DefaultModel ( api::graph::LoadBalancing< AgentPtr > &  load_balancing )

inline

DefaultModel constructor.

Default graph, runtime and scheduler defined in DefaultModelConfig are used to initialize the Model, with the specified load balancing algorithm.

The load_balancing algorithm lifetime must exceed this DefaultModel lifetime.

Parameters

load_balancing

user defined load balancing algorithm

DefaultModel() [3/3]

template<template< typename > class SyncMode>

fpmas::model::detail::DefaultModel< SyncMode >::DefaultModel ( api::scheduler::Scheduler &  scheduler, api::runtime::Runtime &  runtime, api::graph::LoadBalancing< AgentPtr > &  load_balancing  )

inline

DefaultModel constructor.

The default graph is used to initialize the Model, with the specified scheduler, runtime and load balancing algorithm.

The load_balancing algorithm lifetime must exceed this DefaultModel lifetime.

Parameters

scheduler	scheduler
runtime	runtime
load_balancing	user defined load balancing algorithm

---

The documentation for this class was generated from the following file:

• src/fpmas/model/detail/model.h