alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider Class Reference

#include <SDKPrimitivesProvider.h>

Public Member Functions
bool	withTimerDelegateFactory (std::shared_ptr< sdkInterfaces::timing::TimerDelegateFactoryInterface > timerDelegateFactory)
std::shared_ptr< sdkInterfaces::timing::TimerDelegateFactoryInterface >	getTimerDelegateFactory ()
bool	initialize ()
bool	isInitialized () const
void	reset ()
void	terminate ()

Static Public Member Functions
static std::shared_ptr< SDKPrimitivesProvider >	getInstance ()

Detailed Description

Provides primitives to components. This class should only be used for objects which are impractical to pass as an explicit dependency.

Member Function Documentation

getInstance()

static std::shared_ptr<SDKPrimitivesProvider> alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider::getInstance ( )

static

Returns the Singleton instance of the SDKPrimitivesProvider.

Returns

The SDKPrimitivesProvider instance.

getTimerDelegateFactory()

std::shared_ptr<sdkInterfaces::timing::TimerDelegateFactoryInterface> alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider::getTimerDelegateFactory

(

)

Get the TimerDelegateFactoryInterface.

Returns

The TimerDelegateFactoryInterface.

initialize()

bool alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider::initialize

(

)

Initialize with the provided members.

Returns

Whether this operation was successful.

isInitialized()

bool alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider::isInitialized

(

)

const

Initialize.

Returns

Whether this is currently initialized.

reset()

void alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider::reset

(

)

Reset all configured properties.

terminate()

void alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider::terminate

(

)

Resets all configured properties. Resets the Singleton instance.

withTimerDelegateFactory()

bool alexaClientSDK::avsCommon::avs::initialization::SDKPrimitivesProvider::withTimerDelegateFactory

(

std::shared_ptr< sdkInterfaces::timing::TimerDelegateFactoryInterface >

timerDelegateFactory

)

Sets the TimerDelegateFactoryInterface.

Returns

Whether this operation was successful.

---

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

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