.. index:: pair: struct; P1::CameraSdk::PropertySpecification
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification:

struct P1::CameraSdk::PropertySpecification
===========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A detailed description of a camera property. :ref:`More...<details-struct_p1_1_1_camera_sdk_1_1_property_specification>`


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

	#include <P1CameraTypes.hpp>
	
	struct PropertySpecification
	{
		// fields
	
		uint32_t :ref:`mId<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a3ac31aecc132601350204e3288ca4b03>` = :ref:`kPropertyUndefined<doxid-namespace_p1_1_1_camera_sdk_1ab4323412bb587363688ab6c89b7bb9f4>`;
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` :ref:`mValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a69cfcbaaad7353d50406bf502c9978d3>`;
		std::string :ref:`mName<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a3535274606fce13f3cb3447e269d6306>`;
		std::string :ref:`mGroup<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1aa708edb8122b36066937b4a6269a9a05>`;
		bool :ref:`mReadOnly<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1adf907e68f939e55cbbe304cd89170ebe>` = false;
		bool :target:`mEnabled<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1af4bbd6bf9b989c140874f5384bb4e4da>` = true;
		:ref:`PropertyUserLevel<doxid-namespace_p1_1_1_camera_sdk_1a0d37b6b86625dfa7ba5dcc02620c829e>` :ref:`mUserLevel<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a0914e4631e62e21d49c62722546c33ae>` = :ref:`kPropertyUserLevelUndefined<doxid-namespace_p1_1_1_camera_sdk_1a0d37b6b86625dfa7ba5dcc02620c829ea34a6a0c669bc6739db226046b8a5d592>`;
		bool :target:`mSelectOnly<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a58699b9423b8f68386eb14d92586428b>` = false;
		bool :target:`mDisplayAsHex<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a6d79eb430b902b5e05c69a8cffc5d0f9>` = false;
		bool :target:`mRefreshRequired<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1ae69697bc9a44c2a631b3408c4d6d664c>` = false;
		std::string :target:`mUnitString<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a1beb83ac6827e37afbb6c3dac47fd8fa>`;
		std::string :target:`mDescription<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1aaeb9318dcff9234a543b48691a53724c>`;
		uint32_t :ref:`mDisplayIndex<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1afe2cfeef396e9a5c331fad78da778fa1>` = 0;
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` :ref:`mDefault<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1aa9f57e99e94e3f4a600ef8775f7cc346>`;
		:ref:`PropertyRange<doxid-struct_p1_1_1_camera_sdk_1_1_property_range>` :ref:`mRange<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a04e05c2e4dab1538cbf8daae0167ee71>`;
		std::vector<:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>`> :ref:`mValueList<doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a1b81e6eedd3b605f7fef4da18163fe2a>`;

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

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

A detailed description of a camera property.

This class defines if a property has any restrictions to its valid values, like a range or even a list of allowed values.

All Properties belong to a category or group, have a unit and a visibility level, called the *user level*. The *user level* defines if the property is an advanced camera setting, that should probably be hidden from novice users.

To represent the current value of a proerty we use the class :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>`. It is also there the *type* of the property is defined.

You cannot change property specifications, you can change only property values, and only using :ref:`Camera::SetProperty <doxid-class_p1_1_1_camera_sdk_1_1_camera_1a760e318e79974c868aaa8088c1b420fd>`

You can obtain :ref:`PropertySpecification <doxid-struct_p1_1_1_camera_sdk_1_1_property_specification>` objects from :ref:`Camera::GetPropertySpec <doxid-class_p1_1_1_camera_sdk_1_1_camera_1a61cb2aba7c6a62307f8204c851470204>`

Fields
------

.. index:: pair: variable; mId
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a3ac31aecc132601350204e3288ca4b03:

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

	uint32_t mId = :ref:`kPropertyUndefined<doxid-namespace_p1_1_1_camera_sdk_1ab4323412bb587363688ab6c89b7bb9f4>`

The assigned id of the property.

All properties are identified uniquely by their *Id*. You use the *Id* to reference and look up properties on a camera.

.. index:: pair: variable; mValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a69cfcbaaad7353d50406bf502c9978d3:

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

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

The current value (and type) of the property.

This is the current assigned value to the property. If the property if not marked as *read-only* (:ref:`mReadOnly <doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1adf907e68f939e55cbbe304cd89170ebe>`), this value can be changed using :ref:`Camera::SetProperty <doxid-class_p1_1_1_camera_sdk_1_1_camera_1a760e318e79974c868aaa8088c1b420fd>`.

.. index:: pair: variable; mName
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a3535274606fce13f3cb3447e269d6306:

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

	std::string mName

The (human readable) name of the property.

This name is localized based on the camera's UI language setting. However, the default language is english.

This name can be presented to users in a UI

.. index:: pair: variable; mGroup
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1aa708edb8122b36066937b4a6269a9a05:

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

	std::string mGroup

The group that this property belongs to.

The group is a string that might contain double colons "::", to denote subgroups. You can use the *group* to group related properties in a UI.

.. index:: pair: variable; mReadOnly
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1adf907e68f939e55cbbe304cd89170ebe:

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

	bool mReadOnly = false

Indicates if this property is currently *read only*

Some properties are always *read only*, but others might be *read only* as a result of the camera settings. For example, if the exposure program is set to *auto*, then the *ISO*, *Aperture* and *shutter* properties are *read_only*. If the exposure program is set to *manual*, then they are writeable.

.. index:: pair: variable; mUserLevel
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a0914e4631e62e21d49c62722546c33ae:

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

	:ref:`PropertyUserLevel<doxid-namespace_p1_1_1_camera_sdk_1a0d37b6b86625dfa7ba5dcc02620c829e>` mUserLevel = :ref:`kPropertyUserLevelUndefined<doxid-namespace_p1_1_1_camera_sdk_1a0d37b6b86625dfa7ba5dcc02620c829ea34a6a0c669bc6739db226046b8a5d592>`

The visibility level of this peroperty.

Some properties are more advanced than others. Use this member to hide the advanced properties from novice users.

.. index:: pair: variable; mDisplayIndex
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1afe2cfeef396e9a5c331fad78da778fa1:

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

	uint32_t mDisplayIndex = 0

The sorting order of the property.

Instead of presenting properties as sorted by *Id* or name, sort by this integer. (Per group.)

.. index:: pair: variable; mDefault
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1aa9f57e99e94e3f4a600ef8775f7cc346:

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

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

The default value of the property.

This is the value that the property is restored to, then "reset to
default" is triggered, on the camera.

*Note* : that not all properties have a meaningful default value. (Such as "System clock")

.. index:: pair: variable; mRange
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a04e05c2e4dab1538cbf8daae0167ee71:

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

	:ref:`PropertyRange<doxid-struct_p1_1_1_camera_sdk_1_1_property_range>` mRange

The valid range of the property value.

Some properties are restricted to have a valid range of values they can take. If a range is applicable for this property, the :ref:`PropertyRange::mHas <doxid-struct_p1_1_1_camera_sdk_1_1_property_range_1adc8ca4ace1639df9f9b7e0cb24cb2c19>` is ``true``. If ``false``, this member can be ignored.

.. index:: pair: variable; mValueList
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_specification_1a1b81e6eedd3b605f7fef4da18163fe2a:

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

	std::vector<:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value>`> mValueList

List of allowed values, for this property.

Some properties can only take values, from this list of allowed values. If this list is present (size > 0), and you set a value that is not in the list, two things can happen: 1. the camera rejects the value or, 2. the value is truncated to the nearest value in the list.

Methods
-------

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

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

	std::string ToString() const

Get a human readable description of this :ref:`PropertySpecification <doxid-struct_p1_1_1_camera_sdk_1_1_property_specification>`.