.. index:: pair: struct; P1::CameraSdk::PropertyRange
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_range:

struct P1::CameraSdk::PropertyRange
===================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Numeric property *range span* class, used by :ref:`PropertySpecification <doxid-struct_p1_1_1_camera_sdk_1_1_property_specification>`. :ref:`More...<details-struct_p1_1_1_camera_sdk_1_1_property_range>`


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

	#include <P1CameraTypes.hpp>
	
	struct PropertyRange
	{
		// fields
	
		bool :ref:`mHas<doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1adc8ca4ace1639df9f9b7e0cb24cb2c19>` = false;
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` :ref:`mMin<doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1a45b4d774e3ef4dd21bc39c477b5433e1>`;
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` :ref:`mMax<doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1aedbc70848a0201b8ec5bc759ab55e458>`;

		// methods
	
		std::string :ref:`ToString<doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1a7e806152de88857f775171552202876d>`() const;
	};
.. _details-struct_p1_1_1_camera_sdk_1_1_property_range:

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

Numeric property *range span* class, used by :ref:`PropertySpecification <doxid-struct_p1_1_1_camera_sdk_1_1_property_specification>`.

Some camera properties have a valid range of values, defined by a minimum and maximum. This class defines these boundaries.

A valid :ref:`PropertyRange <doxid-struct_p1_1_1_camera_sdk_1_1_property_range>` object, *must* have its member :ref:`mHas <doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1adc8ca4ace1639df9f9b7e0cb24cb2c19>` set to ``true``. ``false`` indicates an invalid range object.

Fields
------

.. index:: pair: variable; mHas
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1adc8ca4ace1639df9f9b7e0cb24cb2c19:

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

	bool mHas = false

Indicate if this object is valid, and range check should be applied.

.. index:: pair: variable; mMin
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1a45b4d774e3ef4dd21bc39c477b5433e1:

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

	:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` mMin

The lower bound of the range.

.. index:: pair: variable; mMax
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1aedbc70848a0201b8ec5bc759ab55e458:

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

	:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` mMax

The upper bound of the range.

Methods
-------

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

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

	std::string ToString() const

Get a human readable representation of the range.