.. index:: pair: class; P1::CameraSdk::FullImageImpl .. _doxid-class_p1_1_1_camera_sdk_1_1_full_image_impl: class P1::CameraSdk::FullImageImpl ================================== .. toctree:: :hidden: Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class FullImageImpl: public :ref:`P1::CameraSdk::IFullImage` { public: // typedefs typedef P1::IQP::ImageReceivePackage const :target:`PrivStructType`; // construction :target:`FullImageImpl`(:ref:`PrivStructType`*const dataStruct); // methods virtual std::string :target:`FileName`() const; virtual std::shared_ptr :ref:`Data`() const; virtual size_t :ref:`DataSizeBytes`() const; virtual :ref:`ImageFormat` :ref:`Format`() const; virtual :ref:`Type` :ref:`BufferType`() const; virtual char const* :ref:`BufferTypeStr`() const; virtual char const* :ref:`FormatStr`() const; }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // enums enum :ref:`Type`; // methods virtual std::shared_ptr :ref:`Data`() const = 0; virtual size_t :ref:`DataSizeBytes`() const = 0; virtual :ref:`ImageFormat` :ref:`Format`() const = 0; virtual :ref:`Type` :ref:`BufferType`() const = 0; virtual char const* :ref:`BufferTypeStr`() const = 0; virtual char const* :ref:`FormatStr`() const = 0; virtual std::string :ref:`FileName`() const = 0; .. _details-class_p1_1_1_camera_sdk_1_1_full_image_impl: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Methods ------- .. index:: pair: function; Data .. _doxid-class_p1_1_1_camera_sdk_1_1_full_image_impl_1a88187240074c088f474af06aaf0cd699: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual std::shared_ptr Data() const Returns a pointer to the pixel buffer data. .. index:: pair: function; DataSizeBytes .. _doxid-class_p1_1_1_camera_sdk_1_1_full_image_impl_1ac7e9f432ea1bce3a915d552c126b3e51: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual size_t DataSizeBytes() const Returns the size of the pixel buffer in bytes. .. index:: pair: function; Format .. _doxid-class_p1_1_1_camera_sdk_1_1_full_image_impl_1ab285a6c70f37a6c050cbeece590065c6: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`ImageFormat` Format() const Returns the image encoding type of this buffer (bitmap, jpeg) .. index:: pair: function; BufferType .. _doxid-class_p1_1_1_camera_sdk_1_1_full_image_impl_1a870ff8820b1f02fa7a7480d6ffe30c75: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual :ref:`Type` BufferType() const Returns the type of this buffer. .. index:: pair: function; BufferTypeStr .. _doxid-class_p1_1_1_camera_sdk_1_1_full_image_impl_1ac0a2535a7074bcdefbadfa4a83dd0dd1: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual char const* BufferTypeStr() const Returns a string of the type this buffer. .. index:: pair: function; FormatStr .. _doxid-class_p1_1_1_camera_sdk_1_1_full_image_impl_1acd109c07746fd1c64f178248ec9f01fc: .. ref-code-block:: cpp :class: doxyrest-title-code-block virtual char const* FormatStr() const Returns a string of the type kind of this buffer, (RGB, JPEG, etc.)