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

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

.. toctree::
	:hidden:

Overview
~~~~~~~~

Holds 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 <C_P1CameraCommonCameraTypes.h>
	
	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;
		: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 };

		// 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_1abbc00edec03e872874121975aa3b123b>`(std::string const& fromString);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a188325249e8dba84670a1f6a455d35e8>`(char const* fromCString);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a050749f92095a2cfdcce01435c6a90e5>`(int64_t const& fromInteger);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a6baeb75688462de69074ef2c227277cb>`(int32_t const& fromInteger);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1abd2c07bf4b3e97104005bc9b60006b5b>`(uint32_t const& fromUInteger);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a0702bce345b66849041cb6168a7a0bdf>`(uint64_t const& fromUInteger);
		:ref:`PropertyValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1aebb46923cc448725ef4370a3585dd81b>`(double const& fromDouble);

		// methods
	
		:ref:`MSVC_ALLOW_PUBLIC_STL<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a34f49879bce32bf41b3dd15362174bdc>`(std::string mString);
		:ref:`MSVC_ALLOW_PUBLIC_STL<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1ae2f5e15c0413cbdf3df8289469f42c21>`(std::string mPresentationString);
		uint32_t :ref:`IntegerAsU32<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1add416681641e3da45d6cf70fc426a4b2>`() const;
		int32_t :ref:`IntegerAsI32<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a51da6e647e2a9b80c2b92f2d48d243ba>`() const;
		uint64_t :ref:`IntegerAsU64<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a562e87ffd6bef421f1a56f5e7115c49d>`() const;
		int64_t :ref:`IntegerAsI64<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a878cb1af1fc035820faf22b536744a88>`() const;
		std::string :ref:`StringValue<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1aac594700f0554b90dd2a6f3274f71f68>`() const;
		std::string :ref:`ToString<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a7cecc16c04a64e14c66b7d6e21c8196a>`() const;
		std::string :ref:`TypeString<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1adb113e005235a1241cdf987884eed803>`() const;
		bool :ref:`operator ==<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a8f824270c55bbf0372a83784482f0967>` (PropertyValue const& other) const;
		bool :target:`operator !=<doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1aaa47aba8d869deb1f79a471cc859bf10>` (PropertyValue const& other) 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
~~~~~~~~~~~~~~~~~~~~~~

Holds 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 PropertyValue::mPresentationString, 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 as this class.



.. rubric:: See also:

:ref:`PropertyType <doxid-namespace_p1_1_1_camera_sdk_1a246a9143d60d3f106ac1f00635317730>`

Camera::GetProperty

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>`

Indicates 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; 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.

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_1abbc00edec03e872874121975aa3b123b:

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

	PropertyValue(std::string const& 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_1a188325249e8dba84670a1f6a455d35e8:

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

	PropertyValue(char const* fromCString)

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

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

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

	PropertyValue(int64_t const& 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_1a6baeb75688462de69074ef2c227277cb:

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

	PropertyValue(int32_t const& 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_1abd2c07bf4b3e97104005bc9b60006b5b:

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

	PropertyValue(uint32_t const& fromUInteger)

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

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

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

	PropertyValue(uint64_t const& fromUInteger)

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

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

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

	PropertyValue(double const& fromDouble)

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

Methods
-------

.. index:: pair: function; MSVC_ALLOW_PUBLIC_STL
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a34f49879bce32bf41b3dd15362174bdc:

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

	MSVC_ALLOW_PUBLIC_STL(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: function; MSVC_ALLOW_PUBLIC_STL
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1ae2f5e15c0413cbdf3df8289469f42c21:

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

	MSVC_ALLOW_PUBLIC_STL(std::string mPresentationString)

This is a human readable representation of the value.

.. index:: pair: function; IntegerAsU32
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1add416681641e3da45d6cf70fc426a4b2:

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

	uint32_t IntegerAsU32() const

Return the this property's value as an unsigned Int32.

.. index:: pair: function; IntegerAsI32
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a51da6e647e2a9b80c2b92f2d48d243ba:

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

	int32_t IntegerAsI32() const

Return the this property's value as a signed Int32.

.. index:: pair: function; IntegerAsU64
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a562e87ffd6bef421f1a56f5e7115c49d:

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

	uint64_t IntegerAsU64() const

Return the this property's value as an unsigned Int64.

.. index:: pair: function; IntegerAsI64
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a878cb1af1fc035820faf22b536744a88:

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

	int64_t IntegerAsI64() const

Return the this property's value as a signed Int64.

.. index:: pair: function; StringValue
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1aac594700f0554b90dd2a6f3274f71f68:

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

	std::string StringValue() const

Returns a simple string representation of this property.

This method uses the "RepresentationString", if present.



.. 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; 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 description of the property value, including its type name.

This method is equivalent to using the std::ostream << operator

.. index:: pair: function; TypeString
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1adb113e005235a1241cdf987884eed803:

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

	std::string TypeString() const

Return a human readable name of this property's type.

.. index:: pair: function; operator==
.. _doxid-struct_p1_1_1_camera_sdk_1_1_property_value_1a8f824270c55bbf0372a83784482f0967:

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

	bool operator == (PropertyValue const& other) const

Compare type and 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.