.. index:: pair: class; P1::CameraSdk::INotificationEvent
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event:

class P1::CameraSdk::INotificationEvent
=======================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Notification interface that encapsulate all types of notifications. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_i_notification_event>`


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

	#include <C_P1CameraCommonStructs.h>
	
	class INotificationEvent
	{
	public:
		// methods
	
		virtual bool :target:`operator ==<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a6b8951662b3b050dfd55fd8ecc612966>` (INotificationEvent const& other) const = 0;
		virtual bool :target:`operator !=<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a1f0adbb914dbd0ecb47d734f8fb1a488>` (INotificationEvent const& other) const = 0;
		virtual :ref:`BaseEventType<doxid-class_p1_1_1_camera_sdk_1_1_base_event_type>` const& :ref:`Type<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a5186f890b0283dbdfb047513204c0bd8>`() const = 0;
		virtual bool :ref:`HasImageFilename<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a33b537690c2ce090b63a16b504c13b4e>`() const = 0;
		virtual uint32_t :ref:`ImageId<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a9794b39fbb346bd7303e05ea60e149f4>`() const = 0;
		virtual bool :ref:`HasCamId<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1aa9ad58d903b3c0989433b7a6d4483513>`() const = 0;
		virtual :ref:`CameraId<doxid-namespace_p1_1_1_camera_sdk_1a5469b6ad780854c6fb1c022ff1f13d15>` :ref:`CamId<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1af45c835c94b6fdf5a6e4f7bd1f46fd98>`() const = 0;
		virtual uint32_t :ref:`PropertyId<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a7d6113d646033dd693b3b1283a5980ba>`() const = 0;
		virtual bool :ref:`IsCameraEvent<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a4d729659126d21dcc632c4cd57363588>`() const = 0;
		virtual bool :ref:`IsSdkEvent<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a205600fff670c69b9dbdbd9449f787d4>`() const = 0;
		virtual bool :ref:`IsPropertyEvent<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a6c6a21d17096ab7dd5591f0336ab17d1>`() const = 0;
		virtual bool :ref:`IsTransferEvent<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a6a5c54adc2cd741cb6f6bcf60924ce7a>`() const = 0;
		virtual bool :ref:`IsImageEvent<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a8c7c20f365713c37769d949fd7800cf0>`() const = 0;
		virtual std::shared_ptr<:ref:`IImageFileBasicInfo<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info>` const> :ref:`BasicImageInfo<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a87d0d8ff769e3d4235b004972a17c290>`() const = 0;
		virtual std::shared_ptr<:ref:`IPreview<doxid-class_p1_1_1_camera_sdk_1_1_i_preview>` const> :ref:`Preview<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1ade78066c04aad8964567031c5743ba19>`() const = 0;
		virtual std::shared_ptr<:ref:`ITile<doxid-class_p1_1_1_camera_sdk_1_1_i_tile>` const> :ref:`Tile<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a56278762bc707fa6a7bbd5cba62b2800>`() const = 0;
		virtual std::shared_ptr<:ref:`ILiveView<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view>` const> :ref:`LiveView<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a23a58a4da1b5991be61ed6f413ef72af>`() const = 0;
		virtual std::shared_ptr<:ref:`IFullImage<doxid-class_p1_1_1_camera_sdk_1_1_i_full_image>` const> :ref:`FullImage<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a82259e5be33ac7d189a80821552804a8>`() const = 0;
		virtual std::shared_ptr<:ref:`IStoredImageHandle<doxid-class_p1_1_1_camera_sdk_1_1_i_stored_image_handle>`> :ref:`StoredImageHandle<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a18eafa994cadffdc25c92b346e1ad59c>`() const = 0;
		virtual :ref:`CameraInfo<doxid-struct_p1_1_1_camera_sdk_1_1_camera_info>` const& :ref:`CamInfo<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1af6bf1475ca25569d6f8fd0268e6c8342>`() const = 0;
		virtual uint8_t :ref:`TransferProgressPercent<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1af0af3758a985ff4f781d20724dd8dff6>`() const = 0;
		virtual std::string :ref:`ImageFilename<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a066781ecdc01a5070f588d31dec0170c>`() const = 0;
		virtual std::string :ref:`ToString<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a4cc0c3e6c24c6ca8283d45c31a25ef93>`() const = 0;
		virtual :ref:`QueueingStrategy<doxid-namespace_p1_1_1_camera_sdk_1a2474324f62ba067ae223c46f103bcdc7>` :ref:`QueueMode<doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a3477374697c8f65b4a2c2eda01c5c512>`() const = 0;
	};

	// direct descendants

	class :ref:`NotificationEvent<doxid-class_p1_1_1_camera_sdk_1_1_notification_event>`;
.. _details-class_p1_1_1_camera_sdk_1_1_i_notification_event:

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

Notification interface that encapsulate all types of notifications.

Notifications relate to specific events. These events might come with data attached. This notification interface, handles all types of data events can provide.

Events have a *type* and a *category*. Multiple types shares the same category. Like the types: ``CameraImageReady`` and ``CameraLiveViewStarted`` are both in the ``:ref:`Camera <doxid-class_p1_1_1_camera_sdk_1_1_camera>``` category. The category says something about what auxiliary data is provided with the notification.

You can use the ``Is**Event()`` helper methods to query what kind of category a notification event belongs to.

:ref:`Version <doxid-struct_p1_1_1_camera_sdk_1_1_version>` 3.0

Methods
-------

.. index:: pair: function; Type
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a5186f890b0283dbdfb047513204c0bd8:

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

	virtual :ref:`BaseEventType<doxid-class_p1_1_1_camera_sdk_1_1_base_event_type>` const& Type() const = 0

Get a reference the :ref:`EventType <doxid-class_p1_1_1_camera_sdk_1_1_event_type>` this notification comes from.

.. index:: pair: function; HasImageFilename
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a33b537690c2ce090b63a16b504c13b4e:

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

	virtual bool HasImageFilename() const = 0

``true`` if this notification event has *filename* data attached

.. index:: pair: function; ImageId
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a9794b39fbb346bd7303e05ea60e149f4:

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

	virtual uint32_t ImageId() const = 0

Gets the *image id* of the image this event relates to, or zero (0) if this is not an image related event.

.. index:: pair: function; HasCamId
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1aa9ad58d903b3c0989433b7a6d4483513:

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

	virtual bool HasCamId() const = 0

``true`` if this notification event relates to specific camera

.. index:: pair: function; CamId
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1af45c835c94b6fdf5a6e4f7bd1f46fd98:

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

	virtual :ref:`CameraId<doxid-namespace_p1_1_1_camera_sdk_1a5469b6ad780854c6fb1c022ff1f13d15>` CamId() const = 0

Gets the *id* of the camera that the notification relates to.

.. index:: pair: function; PropertyId
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a7d6113d646033dd693b3b1283a5980ba:

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

	virtual uint32_t PropertyId() const = 0

If this is a property related event (category is 'Property'), then this is the *id* of that property.

.. index:: pair: function; IsCameraEvent
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a4d729659126d21dcc632c4cd57363588:

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

	virtual bool IsCameraEvent() const = 0

``true`` if this notification event is of category :ref:`Camera <doxid-class_p1_1_1_camera_sdk_1_1_camera>`

.. index:: pair: function; IsSdkEvent
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a205600fff670c69b9dbdbd9449f787d4:

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

	virtual bool IsSdkEvent() const = 0

``true`` if this notification event is of category *Sdk*

.. index:: pair: function; IsPropertyEvent
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a6c6a21d17096ab7dd5591f0336ab17d1:

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

	virtual bool IsPropertyEvent() const = 0

``true`` if this notification event is of category *Property*

.. index:: pair: function; IsTransferEvent
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a6a5c54adc2cd741cb6f6bcf60924ce7a:

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

	virtual bool IsTransferEvent() const = 0

``true`` if this notification event is of category *Transfer*

.. index:: pair: function; IsImageEvent
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a8c7c20f365713c37769d949fd7800cf0:

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

	virtual bool IsImageEvent() const = 0

``true`` if this notification event is of category *Image*

.. index:: pair: function; BasicImageInfo
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a87d0d8ff769e3d4235b004972a17c290:

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

	virtual std::shared_ptr<:ref:`IImageFileBasicInfo<doxid-class_p1_1_1_camera_sdk_1_1_i_image_file_basic_info>` const> BasicImageInfo() const = 0

If event type is CameraImageBasicImageInfo, this holds the basic info data object.

.. index:: pair: function; Preview
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1ade78066c04aad8964567031c5743ba19:

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

	virtual std::shared_ptr<:ref:`IPreview<doxid-class_p1_1_1_camera_sdk_1_1_i_preview>` const> Preview() const = 0

If event type is CameraPreviewReady, this holds the image buffer data object.

.. index:: pair: function; Tile
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a56278762bc707fa6a7bbd5cba62b2800:

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

	virtual std::shared_ptr<:ref:`ITile<doxid-class_p1_1_1_camera_sdk_1_1_i_tile>` const> Tile() const = 0

If event type is CameraTileReady, this holds the image buffer data object.

.. index:: pair: function; LiveView
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a23a58a4da1b5991be61ed6f413ef72af:

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

	virtual std::shared_ptr<:ref:`ILiveView<doxid-class_p1_1_1_camera_sdk_1_1_i_live_view>` const> LiveView() const = 0

If event type is CameraNewLiveViewImage, this holds the image buffer data object.

.. index:: pair: function; FullImage
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a82259e5be33ac7d189a80821552804a8:

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

	virtual std::shared_ptr<:ref:`IFullImage<doxid-class_p1_1_1_camera_sdk_1_1_i_full_image>` const> FullImage() const = 0

If event type is CameraImageReady, this holds the full image.

.. index:: pair: function; StoredImageHandle
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a18eafa994cadffdc25c92b346e1ad59c:

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

	virtual std::shared_ptr<:ref:`IStoredImageHandle<doxid-class_p1_1_1_camera_sdk_1_1_i_stored_image_handle>`> StoredImageHandle() const = 0

If event type is CameraImageAdded, CameraImageRemoved or CameraImageEdited this holds the image list item object.

.. index:: pair: function; CamInfo
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1af6bf1475ca25569d6f8fd0268e6c8342:

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

	virtual :ref:`CameraInfo<doxid-struct_p1_1_1_camera_sdk_1_1_camera_info>` const& CamInfo() const = 0

If event type is of *Sdk* category, this holds basic camera info data object.

.. index:: pair: function; TransferProgressPercent
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1af0af3758a985ff4f781d20724dd8dff6:

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

	virtual uint8_t TransferProgressPercent() const = 0

If event type is ImageTransferProgress, this returns the percent progress.

.. index:: pair: function; ImageFilename
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a066781ecdc01a5070f588d31dec0170c:

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

	virtual std::string ImageFilename() const = 0

If event type is of *Transfer* category, this contains the image file's filename.

.. index:: pair: function; ToString
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a4cc0c3e6c24c6ca8283d45c31a25ef93:

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

	virtual std::string ToString() const = 0

Returns a short (human readable) description of the notification event.

This string description include the event type and any auxiliary data

.. index:: pair: function; QueueMode
.. _doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a3477374697c8f65b4a2c2eda01c5c512:

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

	virtual :ref:`QueueingStrategy<doxid-namespace_p1_1_1_camera_sdk_1a2474324f62ba067ae223c46f103bcdc7>` QueueMode() const = 0

Returns how this notification is queued in :ref:`Listener <doxid-class_p1_1_1_camera_sdk_1_1_listener>`.

Each :ref:`NotificationEvent <doxid-class_p1_1_1_camera_sdk_1_1_notification_event>` implementation defines a strategy of how it is added to notification queues.



.. rubric:: See also:

:ref:`QueueMode <doxid-class_p1_1_1_camera_sdk_1_1_i_notification_event_1a3477374697c8f65b4a2c2eda01c5c512>`