.. index:: pair: class; P1::CameraSdk::SdkException
.. _doxid-class_p1_1_1_camera_sdk_1_1_sdk_exception:

class P1::CameraSdk::SdkException
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Base exception class for all exception thrown from the C++ API. :ref:`More...<details-class_p1_1_1_camera_sdk_1_1_sdk_exception>`


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

	#include <P1CameraExceptions.hpp>
	
	class SdkException: public runtime_error
	{
	public:
		// fields
	
		:ref:`ErrorCode<doxid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9>` :target:`mErrorCode<doxid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1af571b31ecbd4700542ba2e0bd3879d7d>`;

		// construction
	
		:target:`SdkException<doxid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a90799e271f0d89bfa3c080ca880fec2d>`(const SdkException& e2);
		:target:`SdkException<doxid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1a224466363c57be589438f793cdf76172>`(:ref:`ErrorCode<doxid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9>` errorCode = :ref:`kError<doxid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9a31e1ac6d9f0bfff8d7ae0a7aa2d5dc3a>`);
		:target:`SdkException<doxid-class_p1_1_1_camera_sdk_1_1_sdk_exception_1aac55eaa48b58e6b444f2288c00b6beb6>`(const char* message, :ref:`ErrorCode<doxid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9>` errorCode = :ref:`kError<doxid-namespace_p1_1_1_camera_sdk_1ada3dc51a13348c739a07d3ad8047c2a9a31e1ac6d9f0bfff8d7ae0a7aa2d5dc3a>`);
	};

	// direct descendants

	class :ref:`AnotherThreadPendingExc<doxid-class_p1_1_1_camera_sdk_1_1_another_thread_pending_exc>`;
	class :ref:`CameraCouldNotConnectExc<doxid-class_p1_1_1_camera_sdk_1_1_camera_could_not_connect_exc>`;
	class :ref:`CameraNotOpenExc<doxid-class_p1_1_1_camera_sdk_1_1_camera_not_open_exc>`;
	class :ref:`ImageReceiveTimeoutExc<doxid-class_p1_1_1_camera_sdk_1_1_image_receive_timeout_exc>`;
	class :ref:`NotificationAlreadyExistsExc<doxid-class_p1_1_1_camera_sdk_1_1_notification_already_exists_exc>`;
	class :ref:`NotificationTimeoutExc<doxid-class_p1_1_1_camera_sdk_1_1_notification_timeout_exc>`;
	class :ref:`PropertyNotFoundExc<doxid-class_p1_1_1_camera_sdk_1_1_property_not_found_exc>`;
	class :ref:`PropertyOutOfRangeException<doxid-class_p1_1_1_camera_sdk_1_1_property_out_of_range_exception>`;
	class :ref:`PropertySetFailedException<doxid-class_p1_1_1_camera_sdk_1_1_property_set_failed_exception>`;
	class :ref:`PropertyTypeNotFoundExc<doxid-class_p1_1_1_camera_sdk_1_1_property_type_not_found_exc>`;
	class :ref:`PropertyValueNotInListException<doxid-class_p1_1_1_camera_sdk_1_1_property_value_not_in_list_exception>`;
	class :ref:`PropertyWrongTypeExc<doxid-class_p1_1_1_camera_sdk_1_1_property_wrong_type_exc>`;
	class :ref:`SdkCameraNotFoundExc<doxid-class_p1_1_1_camera_sdk_1_1_sdk_camera_not_found_exc>`;
	class :ref:`SdkFactoryErrorExc<doxid-class_p1_1_1_camera_sdk_1_1_sdk_factory_error_exc>`;
	class :ref:`SdkNoFactoryExc<doxid-class_p1_1_1_camera_sdk_1_1_sdk_no_factory_exc>`;
	class :ref:`SdkNotOpenExc<doxid-class_p1_1_1_camera_sdk_1_1_sdk_not_open_exc>`;
	class :ref:`SdkNotYetImplementedExc<doxid-class_p1_1_1_camera_sdk_1_1_sdk_not_yet_implemented_exc>`;
.. _details-class_p1_1_1_camera_sdk_1_1_sdk_exception:

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

Base exception class for all exception thrown from the C++ API.

A child class would normally call this class' constructor to extract the human readable error message string. This string is then provided to the default ``std::exception`` class.