/**
* @file common/Model.hpp
* @author The ARTIS Development Team
* See the AUTHORS or Authors.txt file
*/
/*
* ARTIS - the multimodeling and simulation environment
* This file is a part of the ARTIS environment
*
* Copyright (C) 2013-2019 ULCO http://www.univ-littoral.fr
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
#ifndef COMMON_MODEL
#define COMMON_MODEL
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
namespace artis {
namespace common {
template
class ExternalEvent;
template
class InternalEvent;
template
class Bag;
struct Port
{
unsigned int index;
std::string name;
};
typedef std::vector Ports;
typedef std::map PortMap;
template
class Model
{
public:
Model(const std::string &name)
:
_tl(0), _tn(0), _parent(0), _name(name), _inputs(0)
{}
virtual ~Model()
{
if (_inputs) {
delete _inputs;
}
}
// structure
void add_in_port(const Port &port)
{
assert(not exist_in_port(port.index));
_in_ports.push_back(port.index);
_in_port_map[port.index] = port.name;
}
void add_out_port(const Port &port)
{
assert(not exist_out_port(port.index));
_out_ports.push_back(port.index);
_out_port_map[port.index] = port.name;
}
void delete_in_port(const Port &port)
{
assert(not exist_in_port(port.index));
_in_ports.erase(std::find(_in_ports.begin(), _in_ports.end(),
port.index));
_in_port_map.erase(port.index);
}
void delete_out_port(const Port &port)
{
assert(not exist_out_port(port.index));
_out_ports.erase(std::find(_out_ports.begin(), _out_ports.end(),
port.index));
_out_port_map.erase(port.index);
}
bool exist_in_port(unsigned int port_index) const
{
return _in_port_map.find(port_index) != _in_port_map.end();
}
bool exist_out_port(unsigned int port_index) const
{
return _out_port_map.find(port_index) != _out_port_map.end();
}
std::string get_in_port_name(unsigned int port_index) const
{
assert(exist_in_port(port_index));
return _in_port_map.find(port_index)->second;
}
size_t get_in_port_number() const
{ return _in_port_map.size(); }
std::string get_out_port_name(unsigned int port_index) const
{
assert(exist_out_port(port_index));
return _out_port_map.find(port_index)->second;
}
size_t get_out_port_number() const
{ return _out_port_map.size(); }
const std::string &get_name() const
{ return _name; }
Model *get_parent() const
{ return _parent; }
// TODO: to remove
virtual int get_receiver_number(typename Time::type t)
{
(void) t;
return 0;
}
virtual const Model *get_submodel(unsigned int index) const
{
(void) index;
assert(false);
return nullptr;
}
virtual const Model *get_submodel(unsigned int index,
unsigned int rank) const
{
(void) index;
(void) rank;
assert(false);
return nullptr;
}
virtual unsigned int get_submodel_number(unsigned int index) const
{
(void) index;
assert(false);
return 0;
}
virtual bool is_atomic() const = 0;
virtual bool is_remote() const
{ return false; }
virtual std::string observable_name(unsigned int observable_index) const
{
(void) observable_index;
assert(false);
return std::string();
}
std::string path() const
{
return (_parent != nullptr ? _parent->path() : "") + ":" + get_name();
}
virtual void restore(const common::context::State &state)
{
_tl = state.last_time();
_tn = state.next_time();
}
virtual void save(common::context::State &state) const
{
state.last_time(_tl);
state.next_time(_tn);
}
void set_parent(Model *parent)
{ _parent = parent; }
virtual std::string to_string(int /* level */) const = 0;
// event
void add_event(const common::ExternalEvent &message)
{
if (_inputs == 0) {
_inputs = new Bag;
}
_inputs->push_back(message);
}
void clear_bag()
{
if (_inputs) {
delete _inputs;
_inputs = 0;
}
}
unsigned int event_number() const
{
return _inputs ? _inputs->size() : 0;
}
const common::Bag &get_bag()
{
if (_inputs == 0) {
_inputs = new Bag;
}
return *_inputs;
}
// time
typename Time::type get_tl() const
{ return _tl; }
typename Time::type get_tn() const
{ return _tn; }
// devs methods
virtual void finish(const typename Time::type &t) = 0;
virtual common::Value observe(const typename Time::type &t,
unsigned int index) const = 0;
virtual void output(const typename Time::type &t) = 0;
virtual void post_event(const typename Time::type &t,
const common::ExternalEvent &event) = 0;
virtual typename Time::type start(const typename Time::type &t) = 0;
virtual typename Time::type transition(const typename Time::type &t) = 0;
virtual typename Time::type lookahead(const typename Time::type &t) const
{ return t; }
// scheduler
void handle(SchedulerHandle handle)
{ _handle.handle(handle); }
const SchedulerHandle &handle() const
{ return _handle.handle(); }
protected:
typename Time::type _tl;
typename Time::type _tn;
private :
Model *_parent;
std::string _name;
Ports _in_ports;
PortMap _in_port_map;
Ports _out_ports;
PortMap _out_port_map;
Bag *_inputs;
SchedulerHandle _handle;
};
template
class ModelMap : public std::map *>
{
public:
ModelMap()
{}
virtual ~ModelMap()
{}
std::string to_string() const
{
std::ostringstream ss;
ss << "{ ";
for (typename ModelMap::const_iterator it =
ModelMap::begin();
it != ModelMap::end(); ++it) {
ss << it->second->get_name() << " ";
}
ss << "}";
return ss.str();
}
};
template
class Models : public std::vector *>
{
public:
Models()
{}
virtual ~Models()
{}
std::string to_string() const
{
std::ostringstream ss;
ss << "{ ";
for (typename Models::const_iterator it =
Models::begin();
it != Models::end(); ++it) {
ss << (*it)->get_name() << " ";
}
ss << "}";
return ss.str();
}
};
template
class ModelsMap : public std::map >
{
public:
ModelsMap()
{}
virtual ~ModelsMap()
{}
std::string to_string() const
{
std::ostringstream ss;
ss << "{ ";
for (typename ModelsMap::const_iterator it =
ModelsMap::begin();
it != ModelsMap::end(); ++it) {
ss << it->second.to_string() << " ";
}
ss << "}";
return ss.str();
}
};
}
} // namespace artis common
#endif