System.hpp
No OneTemporary
Actions

Size

4 KB

Referenced Files

None

Subscribers

None

System.hpp
View Options

	/*******************************************************************************
	*
	* File: System.hpp
	*
	* Contents: Declaration of System interface.
	*
	* Copyright 2017
	*
	* Author: David Juhasz (david.juhasz@tuwien.ac.at)
	*
	******************************************************************************/

	#ifndef ROSA_CORE_SYSTEM_HPP
	#define ROSA_CORE_SYSTEM_HPP

	#include "rosa/config/config.h"

	#include "rosa/support/debug.hpp"
	#include "rosa/support/log.h"

	#include <memory>
	#include <string>

	namespace rosa {

	// Forward declarations.
	class Unit;

	// Base interface for actual agent-systems, the class provides facilities to
	// keep track of Units of the system.
	// NOTE: Any subclasses are supposed to provide thread-safe implementation.
	// NOTE: The class declares only an interface to avoid trouble with multiple
	// inheritance in various subclasses as in derived interfaces and derived
	// implementations.
	// NOTE: Actual implementations are supposed to derive from SystemBase
	// implenenting a base feature-set.
	class System {
	public:
	// Type alias for Ids used by the System to identify Units.
	using id_t = size_t;

	// Signature of creator functions for Units.
	template <typename T>
	using UnitCreator = std::function<T *(const size_t, System &)noexcept>;

	// Returns an object implementing the interface defined by the class.
	static std::unique_ptr<System> createSystem(const std::string &Name) noexcept;

	protected:
	// Protected ctor, only subclasses can instantiate.
	System(void) noexcept = default;

	// No copy and move.
	System(const System&) = delete;
	System(System&&) = delete;
	System &operator=(const System&) = delete;
	System &operator=(System&&) = delete;

	public:
	// Dtor.
	// NOTE: Any implementation makes sure that only a cleaned System can be
	// destroyed.
	virtual ~System(void) = default;

	protected:
	// Tells the next Id to be used for a newly created Unit.
	// NOTE: Never returs nthe same value twice.
	virtual id_t nextId(void) noexcept = 0;

	// Tells if the System has been marked clean and ready for destruction.
	virtual bool isSystemCleaned(void) const noexcept = 0;

	// Marks the System cleaned. Can be called only once when the System does not
	// have any live Units.
	// PRE: !isSystemCleaned() && empty()
	// POST: isSystemCleaned()
	virtual void markCleaned(void) noexcept = 0;

	// Registers the given Unit instance to the System.
	// PRE: !isUnitRegistered(U)
	// POST: isUnitRegistered(U)
	virtual void registerUnit(Unit &U) noexcept = 0;

	// Unregisters and destroys the given Unit.
	// PRE: isUnitRegistered(U)
	// POST: !isUnitRegistered(U) && 'U is destroyed'
	virtual void destroyUnit(Unit &U) noexcept = 0;

	// Returns if the given Unit is registered in the System.
	virtual bool isUnitRegistered(const Unit &U) const noexcept = 0;

	// Creates a Unit instance with the given UnitCreator, using the given Name
	// if any, then registers the new Unit instance by calling the virtual
	// member function registerUnit.
	// STATIC PRE: std::is_base_of<Unit, T>::value
	// PRE: !isSystemCleaned()
	template <typename T>
	T &createUnit(UnitCreator<T> C) noexcept;

	public:
	// Tells the textual name of the System.
	// NOTE: The returned reference remains valid as long as the originating
	// System is not destroyed.
	virtual const std::string &name(void) const noexcept = 0;

	// Returns the number of Units constructed in the System so far,
	// including those being already destroyed.
	virtual size_t numberOfConstructedUnits(void) const noexcept = 0;

	// Returns the number of live Units, that have been constructed and not
	// destroyed yet.
	virtual size_t numberOfLiveUnits(void) const noexcept = 0;

	// Returns if the System has no live Units.
	virtual bool empty(void) const noexcept = 0;
	};

	template <typename T>
	T &System::createUnit(UnitCreator<T> C) noexcept {
	STATIC_ASSERT((std::is_base_of<Unit, T>::value), "not a Unit");
	if (isSystemCleaned()) {
	ROSA_CRITICAL("Trying to create a Unit in a cleaned System (" + name() +
	")");
	}
	const id_t Id = nextId();
	T U = C(Id, this);
	registerUnit(*U);
	LOG_TRACE("Unit created and registered (" + U->FullName + ")");
	return *U;
	}

	} // End namespace rosa

	#endif // ROSA_CORE_SYSTEM_HPP

File Metadata

Mime Type: text/x-c++
Expires: Sat, Aug 29, 5:06 PM (10 h, 30 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 375515
Default Alt Text: System.hpp (4 KB)

System.hppNo OneTemporaryActions

System.hppView Options

File Metadata

Event Timeline

System.hpp
No OneTemporary
Actions

System.hpp
View Options