.. index:: pair: class; DataPackInterface
.. _doxid-class_data_pack_interface:

class DataPackInterface
=======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Interface to datapacks. :ref:`More...<details-class_data_pack_interface>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <datapack_interface.h>
	
	class DataPackInterface: public :ref:`PtrTemplates<doxid-class_ptr_templates>` {
	public:
		// construction
	
		:target:`DataPackInterface<doxid-class_data_pack_interface_1a7e7e5afe30c32e7ab1080aa9470c1554>`();
		:target:`DataPackInterface<doxid-class_data_pack_interface_1aef2933539ae80a1be7a292aaca8b5aef>`(const DataPackInterface&);
		:target:`DataPackInterface<doxid-class_data_pack_interface_1ae841ae69b9bcc5a924aa92b54a39260a>`(DataPackInterface&& obj);
	
		template <class DEV_ID_T>
		:target:`DataPackInterface<doxid-class_data_pack_interface_1a30491f12e0073686ccd2f719dc96ca30>`(DEV_ID_T&& id);
	
		:target:`DataPackInterface<doxid-class_data_pack_interface_1a6c84cdf091ba49a21cfa2658fc13fd93>`(
			const std::string& name,
			const std::string& engineName,
			const std::string& type
		);

		// methods
	
		DataPackInterface& :target:`operator =<doxid-class_data_pack_interface_1a252b38146a05a630708c524970d5d2a6>` (const DataPackInterface&);
		DataPackInterface& :target:`operator =<doxid-class_data_pack_interface_1ab6d8b01c08ca8f1bc74ba79bc49fb16b>` (DataPackInterface&&);
		const std::string& :target:`name<doxid-class_data_pack_interface_1aeb28f4ade551550a6371585dd8014225>`() const;
		void :target:`setName<doxid-class_data_pack_interface_1ad213cfe70ff5e2e17feed278f46ae01d>`(const std::string& name);
		const std::string& :target:`type<doxid-class_data_pack_interface_1afa907c903c09daa0ec4ab84af037ef57>`() const;
		void :target:`setType<doxid-class_data_pack_interface_1aa268ef7e5d1abc7953c39681269bad53>`(const std::string& type);
		const std::string& :target:`engineName<doxid-class_data_pack_interface_1ade2caf78751f319aabacd46d2633157e>`() const;
		void :target:`setEngineName<doxid-class_data_pack_interface_1a87b6065c95b44207ee29bf0273ca16b6>`(const std::string& engineName);
		const :ref:`DataPackIdentifier<doxid-struct_data_pack_identifier>`& :target:`id<doxid-class_data_pack_interface_1a6734398f7fd597ed8624c4d4b1c83fc4>`() const;
		void :target:`setID<doxid-class_data_pack_interface_1ad7e2d46c439a928a426042cdd9f715a8>`(const :ref:`DataPackIdentifier<doxid-struct_data_pack_identifier>`& id);
		virtual DataPackInterface* :ref:`clone<doxid-class_data_pack_interface_1a02a9996b2349806d5c7514ad5130d0d0>`() const;
		bool :ref:`isEmpty<doxid-class_data_pack_interface_1ae29518b89988c7e7639765ff8d91977e>`() const;
		bool :ref:`isUpdated<doxid-class_data_pack_interface_1a34968375fb20ea8ccde8a339d0c24c21>`() const;
		void :ref:`resetIsUpdated<doxid-class_data_pack_interface_1a7f0d12553d4cc6fc1a85374b0f4e91b1>`() const;
	};

	// direct descendants

	template <class DATA_TYPE>
	class :ref:`DataPack<doxid-class_data_pack>`;

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// typedefs
	
		typedef std::shared_ptr<T> :ref:`shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>`;
		typedef std::shared_ptr<const T> :ref:`const_shared_ptr<doxid-class_ptr_templates_1ac36bfa374f3b63c85ba97d8cf953ce3b>`;
		typedef std::unique_ptr<T> :ref:`unique_ptr<doxid-class_ptr_templates_1a6d24e150817ba36df80ce3b603b7c665>`;
		typedef std::unique_ptr<const T> :ref:`const_unique_ptr<doxid-class_ptr_templates_1aef0eb44f9c386dbf0de54d0f5afac667>`;

.. _details-class_data_pack_interface:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Interface to datapacks.

Methods
-------

.. index:: pair: function; clone
.. _doxid-class_data_pack_interface_1a02a9996b2349806d5c7514ad5130d0d0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual DataPackInterface* clone() const

Virtual clone method to support polymorphic copy.

.. index:: pair: function; isEmpty
.. _doxid-class_data_pack_interface_1ae29518b89988c7e7639765ff8d91977e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool isEmpty() const

Indicates if the datapack contains any data aside from datapack ID.

The function will return true, if the datapack is of :ref:`DataPackInterface <doxid-class_data_pack_interface>` type, which contains only datapack ID. For any concrete implementation of :ref:`DataPack <doxid-class_data_pack>` class, it should return false.

.. index:: pair: function; isUpdated
.. _doxid-class_data_pack_interface_1a34968375fb20ea8ccde8a339d0c24c21:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool isUpdated() const

Indicates if the :ref:`DataPack <doxid-class_data_pack>` was created or received on the current simulation iteration.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- true

		- When the :ref:`DataPack <doxid-class_data_pack>` was created or received on the current simulation iteration

	*
		- false

		- When the :ref:`DataPack <doxid-class_data_pack>` is 'stale' - it was created or received on one of the earlier simulation iterations

.. index:: pair: function; resetIsUpdated
.. _doxid-class_data_pack_interface_1a7f0d12553d4cc6fc1a85374b0f4e91b1:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void resetIsUpdated() const

Sets the isUpdated flag to false TODO This method is obviously non-const, it will be changed in NRRPLT-8589.