.. index:: pair: class; P1::CameraSdk::NotificationEvent .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event: class P1::CameraSdk::NotificationEvent ====================================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class NotificationEvent: public :ref:`P1::CameraSdk::INotificationEvent` { public: // construction :target:`NotificationEvent`(); :target:`NotificationEvent`(NotificationEvent&& other); // methods virtual bool :target:`operator ==` (const :ref:`INotificationEvent`& other) const; virtual bool :target:`operator !=` (const :ref:`INotificationEvent`& other) const; virtual bool :ref:`HasCamId`() const; virtual bool :ref:`HasImageFilename`() const; virtual uint32_t :ref:`ImageId`() const; virtual :ref:`CameraId` :ref:`CamId`() const; virtual uint32_t :ref:`PropertyId`() const; virtual const :ref:`BaseEventType`& :ref:`Type`() const; virtual bool :ref:`IsCameraEvent`() const; virtual bool :ref:`IsSdkEvent`() const; virtual bool :ref:`IsPropertyEvent`() const; virtual bool :ref:`IsImageEvent`() const; virtual bool :ref:`IsTransferEvent`() const; virtual std::shared_ptr`> :ref:`BasicImageInfo`() const; virtual std::shared_ptr`> :ref:`Preview`() const; virtual std::shared_ptr`> :ref:`Tile`() const; virtual std::shared_ptr`> :ref:`LiveView`() const; virtual std::shared_ptr`> :ref:`FullImage`() const; virtual std::shared_ptr<:ref:`IStoredImageHandle`> :ref:`StoredImageHandle`() const; virtual const :ref:`CameraInfo`& :ref:`CamInfo`() const; virtual uint8_t :ref:`TransferProgressPercent`() const; virtual std::string :ref:`ImageFilename`() const; virtual std::string :ref:`ToString`() const; virtual :ref:`QueueingStrategy` :ref:`QueueMode`() const; static std::shared_ptr :target:`CreateCameraEvent`( const :ref:`EventType`& type, const :ref:`CameraId` camId, const uint32_t optPropertyId = 0 ); static std::shared_ptr :target:`CreateSdkEvent`( const :ref:`SdkEventType`& type, const :ref:`CameraInfo`& info, const :ref:`CameraId` camId = -1 ); static std::shared_ptr :target:`CreatePropertyEvent`( const :ref:`PropertyEventType`& type, const :ref:`CameraId` camId, const uint32_t propertyId ); static std::shared_ptr :target:`CreateTransferEvent`( const :ref:`EventType`& type, const :ref:`CameraId` camId, const uint8_t transferPercent, const std::string filename ); static std::shared_ptr :target:`CreateImageEvent`( const :ref:`EventType`& type, const :ref:`CameraId` camId, const void*const pData ); static std::shared_ptr :target:`CreateFirmwareEvent`( const :ref:`EventType`& type, const :ref:`CameraId` camId, const uint8_t transferPercent ); }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // methods virtual bool :ref:`operator ==` (:ref:`INotificationEvent` const& other) const = 0; virtual bool :ref:`operator !=` (:ref:`INotificationEvent` const& other) const = 0; virtual :ref:`BaseEventType` const& :ref:`Type`() const = 0; virtual bool :ref:`HasImageFilename`() const = 0; virtual uint32_t :ref:`ImageId`() const = 0; virtual bool :ref:`HasCamId`() const = 0; virtual :ref:`CameraId` :ref:`CamId`() const = 0; virtual uint32_t :ref:`PropertyId`() const = 0; virtual bool :ref:`IsCameraEvent`() const = 0; virtual bool :ref:`IsSdkEvent`() const = 0; virtual bool :ref:`IsPropertyEvent`() const = 0; virtual bool :ref:`IsTransferEvent`() const = 0; virtual bool :ref:`IsImageEvent`() const = 0; virtual std::shared_ptr<:ref:`IImageFileBasicInfo` const> :ref:`BasicImageInfo`() const = 0; virtual std::shared_ptr<:ref:`IPreview` const> :ref:`Preview`() const = 0; virtual std::shared_ptr<:ref:`ITile` const> :ref:`Tile`() const = 0; virtual std::shared_ptr<:ref:`ILiveView` const> :ref:`LiveView`() const = 0; virtual std::shared_ptr<:ref:`IFullImage` const> :ref:`FullImage`() const = 0; virtual std::shared_ptr<:ref:`IStoredImageHandle`> :ref:`StoredImageHandle`() const = 0; virtual :ref:`CameraInfo` const& :ref:`CamInfo`() const = 0; virtual uint8_t :ref:`TransferProgressPercent`() const = 0; virtual std::string :ref:`ImageFilename`() const = 0; virtual std::string :ref:`ToString`() const = 0; virtual :ref:`QueueingStrategy` :ref:`QueueMode`() const = 0; .. _details-class_p1_1_1_camera_sdk_1_1_notification_event: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Methods ------- .. index:: pair: function; HasCamId .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a9a85d9567344c9bc1de3a8fbc4d7eb1b: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool HasCamId() const ``true`` if this notification event relates to specific camera .. index:: pair: function; HasImageFilename .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a49fc6c6de2686086d502dc2adb8755a1: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool HasImageFilename() const ``true`` if this notification event has *filename* data attached .. index:: pair: function; ImageId .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1ab9e0ec499c6e21e84e7d6aa309d8522c: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual uint32_t ImageId() const 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; CamId .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1af6c1dcbe5346b27a918c762c1d33dda7: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`CameraId` CamId() const Gets the *id* of the camera that the notification relates to. .. index:: pair: function; PropertyId .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a19f74a61ce742d5699b95dc83960b1d9: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual uint32_t PropertyId() const If this is a property related event (category is 'Property'), then this is the *id* of that property. .. index:: pair: function; Type .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1abf12abbe8667c7fff5eb512a4cce5783: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual const :ref:`BaseEventType`& Type() const Get a reference the :ref:`EventType ` this notification comes from. .. index:: pair: function; IsCameraEvent .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a4681ec91cae31c5df0368322d8849bc3: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool IsCameraEvent() const ``true`` if this notification event is of category :ref:`Camera ` .. index:: pair: function; IsSdkEvent .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1aab938088906d203f6aee22e8fae4606c: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool IsSdkEvent() const ``true`` if this notification event is of category *Sdk* .. index:: pair: function; IsPropertyEvent .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a8b14dc575a7430ba48f634c07d8c4762: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool IsPropertyEvent() const ``true`` if this notification event is of category *Property* .. index:: pair: function; IsImageEvent .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1aa39a322df2f09158cd2b30f294b20394: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool IsImageEvent() const ``true`` if this notification event is of category *Image* .. index:: pair: function; IsTransferEvent .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a90184991fd13f6d17a5b0d74a6f0ad90: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual bool IsTransferEvent() const ``true`` if this notification event is of category *Transfer* .. index:: pair: function; BasicImageInfo .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a3bef350edd7992b7002ee862a0a5f18f: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::shared_ptr`> BasicImageInfo() const 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_notification_event_1ad42eb41d3367adabf4f7f301a0607faa: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::shared_ptr`> Preview() const 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_notification_event_1aeeff52b2ed56504130ad6f59a1fa5caf: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::shared_ptr`> Tile() const 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_notification_event_1a3466c75ede1217dafd341ea0be156b2e: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::shared_ptr`> LiveView() const 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_notification_event_1af478b5f4319362fe1c4988064316b905: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::shared_ptr`> FullImage() const If event type is CameraImageReady, this holds the full image. .. index:: pair: function; StoredImageHandle .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1ad853bc137a55a3b65c98a14d6da4c982: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::shared_ptr<:ref:`IStoredImageHandle`> StoredImageHandle() const 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_notification_event_1a81d46d2b4259f95d81a792d51b5a63db: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual const :ref:`CameraInfo`& CamInfo() const 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_notification_event_1a8824aa1b33e3f912535af8b43ca11787: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual uint8_t TransferProgressPercent() const If event type is ImageTransferProgress, this returns the percent progress. .. index:: pair: function; ImageFilename .. _doxid-class_p1_1_1_camera_sdk_1_1_notification_event_1a2ee1ca56ecb7af0ffda373745d6dbd8a: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::string ImageFilename() const 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_notification_event_1a485b623f8ba6964f28acc730c45076c4: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::string ToString() const 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_notification_event_1af24e045d145b66d4cf468a6d3e6e3153: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`QueueingStrategy` QueueMode() const Returns how this notification is queued in :ref:`Listener `. Each :ref:`NotificationEvent ` implementation defines a strategy of how it is added to notification queues. .. rubric:: See also: :ref:`QueueMode `