.. index:: pair: class; CommControllerSingleton
.. _doxid-class_comm_controller_singleton:

class CommControllerSingleton
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Singleton class which stores a pointer to the :ref:`NRPGazeboCommunicationController <doxid-class_n_r_p_gazebo_communication_controller>` being used to manage the simulation. :ref:`More...<details-class_comm_controller_singleton>`


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

	#include <nrp_communication_controller.h>
	
	class CommControllerSingleton {
	public:
		// construction
	
		:ref:`CommControllerSingleton<doxid-class_comm_controller_singleton_1aad749146fa699fd8ae0b0ff83297e09a>`(const CommControllerSingleton& other);
		:ref:`CommControllerSingleton<doxid-class_comm_controller_singleton_1aecff92168ab6b6c73e70ed9700b57b15>`(CommControllerSingleton&& other);

		// methods
	
		CommControllerSingleton& :ref:`operator =<doxid-class_comm_controller_singleton_1a7c855c35eae1981b7efb7612fed5cd38>` (const CommControllerSingleton& other);
		CommControllerSingleton&& :ref:`operator =<doxid-class_comm_controller_singleton_1a601d184870992205dc592f5288aab94c>` (CommControllerSingleton&& other);
		:ref:`NRPGazeboCommunicationController<doxid-class_n_r_p_gazebo_communication_controller>`& :target:`engineCommController<doxid-class_comm_controller_singleton_1aa814c0f90113ad733d3922d47e99e000>`();
		static CommControllerSingleton& :ref:`getInstance<doxid-class_comm_controller_singleton_1a98419243a68f0a7998c5591c2f13171f>`();
		static CommControllerSingleton& :ref:`resetInstance<doxid-class_comm_controller_singleton_1a377266b95cf89a1c6d324e3d8d8cb4ca>`(:ref:`NRPGazeboCommunicationController<doxid-class_n_r_p_gazebo_communication_controller>`* engineController);
	};
.. _details-class_comm_controller_singleton:

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

Singleton class which stores a pointer to the :ref:`NRPGazeboCommunicationController <doxid-class_n_r_p_gazebo_communication_controller>` being used to manage the simulation.

so other gazebo plugins can invoke it to register datapacks

Construction
------------

.. index:: pair: function; CommControllerSingleton
.. _doxid-class_comm_controller_singleton_1aad749146fa699fd8ae0b0ff83297e09a:

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

	CommControllerSingleton(const CommControllerSingleton& other)

Delete for singleton.

.. index:: pair: function; CommControllerSingleton
.. _doxid-class_comm_controller_singleton_1aecff92168ab6b6c73e70ed9700b57b15:

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

	CommControllerSingleton(CommControllerSingleton&& other)

Delete for singleton.

Methods
-------

.. index:: pair: function; operator=
.. _doxid-class_comm_controller_singleton_1a7c855c35eae1981b7efb7612fed5cd38:

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

	CommControllerSingleton& operator = (const CommControllerSingleton& other)

Delete for singleton.

.. index:: pair: function; operator=
.. _doxid-class_comm_controller_singleton_1a601d184870992205dc592f5288aab94c:

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

	CommControllerSingleton&& operator = (CommControllerSingleton&& other)

Delete for singleton.

.. index:: pair: function; getInstance
.. _doxid-class_comm_controller_singleton_1a98419243a68f0a7998c5591c2f13171f:

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

	static CommControllerSingleton& getInstance()

Get singleton instance.



.. rubric:: Returns:

Gets instance of :ref:`CommControllerSingleton <doxid-class_comm_controller_singleton>`

.. index:: pair: function; resetInstance
.. _doxid-class_comm_controller_singleton_1a377266b95cf89a1c6d324e3d8d8cb4ca:

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

	static CommControllerSingleton& resetInstance(:ref:`NRPGazeboCommunicationController<doxid-class_n_r_p_gazebo_communication_controller>`* engineController)

Reset.