CopyMeBare.hh

Go to the documentation of this file.

#ifndef UTOPIA_MODELS_COPYMEBARE_HH
#define UTOPIA_MODELS_COPYMEBARE_HH
// TODO Adjust above include guard (and at bottom of file)
 
// standard library includes
#include <random>
 
// third-party library includes
 
// Utopia-related includes
#include <utopia/core/model.hh>
#include <utopia/core/types.hh>
 
 
namespace Utopia {
namespace Models {
namespace CopyMeBare {
 
// ++ Type definitions ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
using ModelTypes = Utopia::ModelTypes<>;
 
 
// ++ Model definition ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
class CopyMeBare:
    public Model<CopyMeBare, ModelTypes>
{
public:
    using Base = Model<CopyMeBare, ModelTypes>;
 
    using DataGroup = typename Base::DataGroup;
 
    using DataSet = typename Base::DataSet;
 
 
private:
    // Base members: _time, _name, _cfg, _hdfgrp, _rng, _monitor, _space
    // ... but you should definitely check out the documentation ;)
 
    // -- Members -------------------------------------------------------------
 
 
    // .. Temporary objects ...................................................
 
 
    // .. Datasets ............................................................
    // NOTE They should be named '_dset_<name>', where <name> is the
    //      dataset's actual name as set in its constructor. Ideally, do not
    //      hide them inside a struct ...
    // std::shared_ptr<DataSet> _dset_my_var;
 
 
public:
    // -- Model Setup ---------------------------------------------------------
 
 
    template<class ParentModel>
    CopyMeBare (
        const std::string& name,
        ParentModel& parent_model,
        const DataIO::Config& custom_cfg = {}
    )
    :
        Base(name, parent_model, custom_cfg)
    {}
 
 
private:
    // .. Setup functions .....................................................
 
    // .. Helper functions ....................................................
 
public:
    // -- Public Interface ----------------------------------------------------
    // .. Simulation Control ..................................................
 
 
    void perform_step () {
 
    }
 
 
 
    void monitor () {
        // Can supply information to the monitor here in two ways:
        // this->_monitor.set_entry("key", value);
        // this->_monitor.set_entry("key", [this](){return 42.;});
    }
 
 
 
    void write_data () {
        // Example:
        // _dset_foo->write(it.begin(), it.end(),
        //     [](const auto& element) {
        //         return element.get_value();
        // });
    }
 
 
    // Getters and setters ....................................................
    // Add getters and setters here to interface with other model
 
};
 
} // namespace CopyMeBare
} // namespace Models
} // namespace Utopia
 
#endif // UTOPIA_MODELS_COPYMEBARE_HH