aace::propertyManager::PropertyManager Class Reference

Public Member Functions
bool	setProperty (const std::string &name, const std::string &value)
virtual void	propertyStateChanged (const std::string &name, const std::string &value, const PropertyState state)=0
std::string	getProperty (const std::string &name)
virtual void	propertyChanged (const std::string &name, const std::string &newValue)=0

Detailed Description

PropertyManager should be extended to set and retrieve Engine property settings and be notified of property changes.

See also

aace::alexa::property::AlexaProperties.h

aace::core::property::CoreProperties.h

aace::network::property::NetworkProperties.h

aace::vehicle::property::VehicleProperties.h

Deprecated:

This platform interface is deprecated. Use the Alexa Auto Services Bridge (AASB) message broker to publish and subscribe to AASB messages instead.

See also

aace::core::MessageBroker

Member Function Documentation

setProperty()

bool aace::propertyManager::PropertyManager::setProperty	(	const std::string &	name,
		const std::string &	value
	)

Sets a property value in the Engine. setProperty() is an asynchronous operation and the Engine will call propertyStateChanged() with the status when it is completed.

Parameters

[in]	name	The name used by the Engine to identify the property. The property name must be one of the property constants recognized by the Engine, e.g. the properties in aace::alexa::property::AlexaProperties.h.
[in]	value	The property setting

Returns

true if the property value was updated or set to the current setting, else false if an error occurred.

propertyStateChanged()

virtual void aace::propertyManager::PropertyManager::propertyStateChanged ( const std::string &  name, const std::string &  value, const PropertyState  state  )

pure virtual

Notifies the platform implementation of the status of a property change after a call to setProperty().

Parameters

[in]	name	The name used by the Engine to identify the property.
[in]	value	The property value.
[in]	state	The state of the property change.

getProperty()

std::string aace::propertyManager::PropertyManager::getProperty

(

const std::string &

name

)

Retrieves the setting for the property identified by name from the Engine.

Note

After calling setProperty(), getProperty() will return the updated value only after the Engine calls propertyStateChanged() with PropertyState::SUCCEEDED.

Parameters

[in]

name

The name used by the Engine to identify the property. The property name must be one of the property constants recognized by the Engine, e.g. the properties in aace::alexa::property::AlexaProperties.h

Returns

The property value as a string, or an empty string if the property value was not found

propertyChanged()

virtual void aace::propertyManager::PropertyManager::propertyChanged ( const std::string &  name, const std::string &  newValue  )

pure virtual

Notifies the platform implementation of a property setting change in the Engine.

Note

This will not be called if the property setting change was initiated by PropertyManager::setProperty()

Parameters

[in]	name	The name used by the Engine to identify the property.
[in]	newValue	The new value of the property