.. index:: pair: struct; P1::CameraSdk::PropertyValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value:

struct P1::CameraSdk::PropertyValue
===================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Hold a single property value, and acts like a wrapper of different property types. :ref:`More...<details-struct_p1_1_1_camera_sdk_1_1_property_value>`


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

	#include <P1CameraTypes.hpp>
	
	struct PropertyValue
	{
		// fields
	
		:ref:`PropertyType<doxid-namespace_p1_1_1_camera_sdk_1a246a9143d60d3f106ac1f00635317730>` :ref:`mType<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a0e7a40af04ff39bf12ddb6bc863dc225>` = :ref:`kPropertyTypeUndefined<doxid-namespace_p1_1_1_camera_sdk_1a246a9143d60d3f106ac1f00635317730ae1b6f0c9dba3550becb1041ae9f408ba>`;
		int64_t :ref:`mInt<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a583660f2b483e2b4466f619177509e20>` = 0;
		double :ref:`mDouble<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a7503af941380149d28321a094130c9f1>` = 0.0;
		std::string :ref:`mString<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a196c97637e6dbe6edc2293cd1a3f8429>`;
		:ref:`ValuePoint<doxid-struct_p1_1_1_camera_sdk_1_1_value_point>` :ref:`mPoint<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a5b5567c408b8a66a08c80e94342984ac>`;
		:ref:`ValueColorFloat<doxid-struct_p1_1_1_camera_sdk_1_1_value_color_float>` :ref:`mColor<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1af544547e80962d78af3ed2d102ee32c3>`;
		:ref:`ValueArea<doxid-struct_p1_1_1_camera_sdk_1_1_value_area>` :ref:`mArea<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a9f5c35d3f6e7ad0589a17bebbf5c2c62>`;
		:ref:`ValueAreaFloat<doxid-struct_p1_1_1_camera_sdk_1_1_value_area_float>` :ref:`mAreaFloat<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1ac2af0a75e2f98ba8be6d54e6e04523cf>`;
		:ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` :ref:`mRect<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1ad17a2e4b2c1781cb5bc3ef1782d8f830>`;
		:ref:`ValueRange<doxid-struct_p1_1_1_camera_sdk_1_1_value_range>` :ref:`mRange<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a8ac51dce8440074b94bc747225543b1d>` { 0, 0 };
		:ref:`ValueRangeFloat<doxid-struct_p1_1_1_camera_sdk_1_1_value_range_float>` :ref:`mRangeFloat<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a1433fc7c0805402451aeab38d48210d8>` { 0.0, 0.0 };
		std::string :ref:`mPresentationString<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a1f536077d2a50cca03a3407caab02b32>`;

		// construction
	
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1adda140b86fe77ac9f254b80f43b5f46e>`();
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1afebaf26e4e9340a24b7138daed0c67b4>`(const std::string& fromString);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a72a9a559f0b8d864753a97a38a25b33f>`(const int64_t& fromInteger);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a8991802f9ac4858110b92db068f63a29>`(const int32_t& fromInteger);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a359a2d130b3f179e1993887f13252329>`(const double& fromDouble);

		// methods
	
		std::string :ref:`ToString<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a7cecc16c04a64e14c66b7d6e21c8196a>`() const;
		std::string :target:`StringValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1aac594700f0554b90dd2a6f3274f71f68>`() const;
		static PropertyValue :ref:`CreateEnum<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a1f33c2785fc828fcbd062908f99c7390>`(uint32_t enumValue);
	};
.. _details-struct_p1_1_1_camera_sdk_1_1_property_value:

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

Hold a single property value, and acts like a wrapper of different property types.

This class holds only the value of a property. It does not know about the property itself, for that we have the :ref:`PropertySpecification <doxid-struct_p1_1_1_camera_sdk_1_1_property_specification>` class. :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` can hold value of type: ``integer``, ``floating point``, ``string``, ``point``, ``color``, ``area`` and ``rect``.

A propertyValue also have a :ref:`PropertyValue::mPresentationString <doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a1f536077d2a50cca03a3407caab02b32>`, that is a string representation of its value.

Preferrably you should not create PropertyValues yourself. Rather you should obtains them from a camera and modify them.

If you are familiar with *Qt*, the ``QVariant`` class achieves the same goal is this class.



.. rubric:: See also:

:ref:`PropertyType <doxid-namespace_p1_1_1_camera_sdk_1a246a9143d60d3f106ac1f00635317730>`

:ref:`Camera::GetProperty <doxid-class_p1_1_1_camera_sdk_1_1_camera_1a91cc3caf8c9675327d29e544a1174087>`

Fields
------

.. index:: pair: variable; mType
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a0e7a40af04ff39bf12ddb6bc863dc225:

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

	:ref:`PropertyType<doxid-namespace_p1_1_1_camera_sdk_1a246a9143d60d3f106ac1f00635317730>` mType = :ref:`kPropertyTypeUndefined<doxid-namespace_p1_1_1_camera_sdk_1a246a9143d60d3f106ac1f00635317730ae1b6f0c9dba3550becb1041ae9f408ba>`

Indicate the type of the value contained in this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` object.

.. index:: pair: variable; mInt
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a583660f2b483e2b4466f619177509e20:

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

	int64_t mInt = 0

All integer based values are contained in this member (enum, int, uint, time, etc.)

.. index:: pair: variable; mDouble
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a7503af941380149d28321a094130c9f1:

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

	double mDouble = 0.0

All floating point values are contained in this member. (float 32 and 64)

.. index:: pair: variable; mString
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a196c97637e6dbe6edc2293cd1a3f8429:

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

	std::string mString

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a string type, the string is contained here.

.. index:: pair: variable; mPoint
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a5b5567c408b8a66a08c80e94342984ac:

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

	:ref:`ValuePoint<doxid-struct_p1_1_1_camera_sdk_1_1_value_point>` mPoint

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a point type, it is contained here.

.. index:: pair: variable; mColor
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1af544547e80962d78af3ed2d102ee32c3:

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

	:ref:`ValueColorFloat<doxid-struct_p1_1_1_camera_sdk_1_1_value_color_float>` mColor

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a color type, it is contained here.

.. index:: pair: variable; mArea
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a9f5c35d3f6e7ad0589a17bebbf5c2c62:

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

	:ref:`ValueArea<doxid-struct_p1_1_1_camera_sdk_1_1_value_area>` mArea

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a area type, it is contained here.

.. index:: pair: variable; mAreaFloat
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1ac2af0a75e2f98ba8be6d54e6e04523cf:

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

	:ref:`ValueAreaFloat<doxid-struct_p1_1_1_camera_sdk_1_1_value_area_float>` mAreaFloat

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a floating point area type, it is contained here.

.. index:: pair: variable; mRect
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1ad17a2e4b2c1781cb5bc3ef1782d8f830:

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

	:ref:`ValueRect<doxid-struct_p1_1_1_camera_sdk_1_1_value_rect>` mRect

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a rectangle type, it is contained here.

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

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

	:ref:`ValueRange<doxid-struct_p1_1_1_camera_sdk_1_1_value_range>` mRange { 0, 0 }

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a integer range type, it is contained here.

.. index:: pair: variable; mRangeFloat
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a1433fc7c0805402451aeab38d48210d8:

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

	:ref:`ValueRangeFloat<doxid-struct_p1_1_1_camera_sdk_1_1_value_range_float>` mRangeFloat { 0.0, 0.0 }

If this :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` is a floating point range type, it is contained here.

.. index:: pair: variable; mPresentationString
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a1f536077d2a50cca03a3407caab02b32:

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

	std::string mPresentationString

This is a human readable representation of the value.

Construction
------------

.. index:: pair: function; PropertyValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1adda140b86fe77ac9f254b80f43b5f46e:

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

	PropertyValue()

Create an empty property value (no data)

.. index:: pair: function; PropertyValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1afebaf26e4e9340a24b7138daed0c67b4:

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

	PropertyValue(const std::string& fromString)

Create a string type property value, based on the provided string.

.. index:: pair: function; PropertyValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a72a9a559f0b8d864753a97a38a25b33f:

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

	PropertyValue(const int64_t& fromInteger)

Create a Int64 type property value, based on the provided integer.

.. index:: pair: function; PropertyValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a8991802f9ac4858110b92db068f63a29:

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

	PropertyValue(const int32_t& fromInteger)

Create a Int32 type property value, based on the provided integer.

.. index:: pair: function; PropertyValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a359a2d130b3f179e1993887f13252329:

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

	PropertyValue(const double& fromDouble)

Create a float64 type property value, based on the provided double.

Methods
-------

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

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

	std::string ToString() const

Returns a simple string representation of this property.



.. rubric:: Returns:

A string value that describes the :ref:`PropertyValue <doxid-struct_p1_1_1_camera_sdk_1_1_property_value>` 's value

.. index:: pair: function; CreateEnum
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a1f33c2785fc828fcbd062908f99c7390:

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

	static PropertyValue CreateEnum(uint32_t enumValue)

Create a enum type property value, based on the provided integer.