alexaClientSDK::avsCommon::avs::CapabilityState Struct Reference

#include <CapabilityState.h>

Collaboration diagram for alexaClientSDK::avsCommon::avs::CapabilityState:

Public Member Functions
	CapabilityState (const std::string &valuePayload, const utils::timing::TimePoint &timeOfSample=utils::timing::TimePoint::now(), const uint32_t uncertaintyInMilliseconds=0)
	CapabilityState (const CapabilityState &other)=default
	CapabilityState ()=default
CapabilityState &	operator= (const CapabilityState &other)=default
bool	operator== (const CapabilityState &rhs) const
bool	operator!= (const CapabilityState &rhs) const

Public Attributes
std::string	valuePayload
	A string representation of the value payload. More...
utils::timing::TimePoint	timeOfSample
	The time at which the property value was recorded. More...
uint32_t	uncertaintyInMilliseconds
	The number of milliseconds that have elapsed since the property value was last confirmed. More...

Detailed Description

This structure represents the state of a capability, including the time that this state was reported and the uncertaintyInMilliseconds.

Constructor & Destructor Documentation

CapabilityState() [1/3]

alexaClientSDK::avsCommon::avs::CapabilityState::CapabilityState ( const std::string &  valuePayload, const utils::timing::TimePoint &  timeOfSample = utils::timing::TimePoint::now(), const uint32_t  uncertaintyInMilliseconds = 0  )

inline

The Constructor.

Parameters

valuePayload	A string representation of the value payload.
timeOfSample	The time at which the property value was recorded.
uncertaintyInMilliseconds	The number of milliseconds that have elapsed since the property value was last confirmed.

CapabilityState() [2/3]

alexaClientSDK::avsCommon::avs::CapabilityState::CapabilityState ( const CapabilityState &  other )

default

Copy constructor.

Parameters

other

The state to copy from.

CapabilityState() [3/3]

alexaClientSDK::avsCommon::avs::CapabilityState::CapabilityState ( )

default

Default constructor.

Note

Avoid using this method. This was added only to enable the to use Optional::value().

Member Function Documentation

operator!=()

bool alexaClientSDK::avsCommon::avs::CapabilityState::operator!= ( const CapabilityState &  rhs ) const

inline

Equality operators.

Parameters

rhs	The element to compare to this.

Returns

Whether the operation holds.

operator=()

CapabilityState& alexaClientSDK::avsCommon::avs::CapabilityState::operator= ( const CapabilityState &  other )

default

Assignment operator.

Parameters

other

The state to copy from.

operator==()

bool alexaClientSDK::avsCommon::avs::CapabilityState::operator== ( const CapabilityState &  rhs ) const

inline

Equality operators.

Parameters

rhs	The element to compare to this.

Returns

Whether the operation holds.

Member Data Documentation

timeOfSample

utils::timing::TimePoint alexaClientSDK::avsCommon::avs::CapabilityState::timeOfSample

The time at which the property value was recorded.

uncertaintyInMilliseconds

uint32_t alexaClientSDK::avsCommon::avs::CapabilityState::uncertaintyInMilliseconds

The number of milliseconds that have elapsed since the property value was last confirmed.

valuePayload

std::string alexaClientSDK::avsCommon::avs::CapabilityState::valuePayload

A string representation of the value payload.

---

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

• /workplace/avs-device-sdk/AVSCommon/AVS/include/AVSCommon/AVS/CapabilityState.h