AstarteDeviceSdk::AstarteStoredProperty Class Reference

Representing data for a stored property. More...

#include <stored_property.hpp>

Public Member Functions
	AstarteStoredProperty (std::string_view interface_name, std::string_view path, int32_t version_major, AstarteOwnership ownership, AstarteData data)
	Constructor for the AstarteStoredProperty class.
auto	get_interface_name () const -> const std::string &
	Get the interface name contained within the object.
auto	get_path () const -> const std::string &
	Get the path contained within the object.
auto	get_version_major () const -> int32_t
	Get the major version within the object.
auto	get_ownership () const -> const AstarteOwnership &
	Get the ownership contained within the object.
auto	get_value () const -> const AstarteData &
	Get the value contained within the object.
auto	operator== (const AstarteStoredProperty &other) const -> bool
	Overloader for the comparison operator ==.
auto	operator!= (const AstarteStoredProperty &other) const -> bool
	Overloader for the comparison operator !=.

Detailed Description

Representing data for a stored property.

Constructor & Destructor Documentation

AstarteStoredProperty()

AstarteDeviceSdk::AstarteStoredProperty::AstarteStoredProperty ( std::string_view interface_name, std::string_view path, int32_t version_major, AstarteOwnership ownership, AstarteData data )

explicit

Constructor for the AstarteStoredProperty class.

Parameters

interface_name	The name of the interface of the property.
path	The path for the property.
version_major	The major version for the interface of the property.
ownership	The ownership for the interface of the property.
data	The Astarte data for the property.

Member Function Documentation

get_interface_name()

auto AstarteDeviceSdk::AstarteStoredProperty::get_interface_name ( ) const -> const std::string &

nodiscard

Get the interface name contained within the object.

Returns

A constant reference to the interface name string.

get_ownership()

auto AstarteDeviceSdk::AstarteStoredProperty::get_ownership ( ) const -> const AstarteOwnership &

nodiscard

Get the ownership contained within the object.

The ownership is the ownership of the interface of the property.

Returns

A constant reference to the ownership.

get_path()

auto AstarteDeviceSdk::AstarteStoredProperty::get_path ( ) const -> const std::string &

nodiscard

Get the path contained within the object.

Returns

A constant reference to the path string.

get_value()

auto AstarteDeviceSdk::AstarteStoredProperty::get_value ( ) const -> const AstarteData &

nodiscard

Get the value contained within the object.

Returns

A constant reference to the data, if any.

get_version_major()

auto AstarteDeviceSdk::AstarteStoredProperty::get_version_major ( ) const -> int32_t

nodiscard

Get the major version within the object.

The major version is the major version of the interface of the property.

Returns

The major version.

operator!=()

auto AstarteDeviceSdk::AstarteStoredProperty::operator!= ( const AstarteStoredProperty & other ) const -> bool

nodiscard

Overloader for the comparison operator !=.

Parameters

other

The object to compare to.

Returns

True when different, false otherwise.

operator==()

auto AstarteDeviceSdk::AstarteStoredProperty::operator== ( const AstarteStoredProperty & other ) const -> bool

nodiscard

Overloader for the comparison operator ==.

Parameters

other

The object to compare to.

Returns

True when equal, false otherwise.

---

The documentation for this class was generated from the following file:

• /home/runner/work/astarte-device-sdk-cpp/astarte-device-sdk-cpp/astarte-device-sdk-cpp/include/astarte_device_sdk/stored_property.hpp