alexaClientSDK::capabilityAgents::system Namespace Reference

Namespaces
	test

Classes
class	LocaleHandler
class	ReportStateHandler
class	RevokeAuthorizationHandler
class	SoftwareInfoSender
class	SoftwareInfoSendRequest
class	StateReportGenerator
class	StateReportGeneratorTest
class	SystemCapabilityProvider
class	TimeZoneHandler
class	UserInactivityMonitor
	This class implements a CapabilityAgent that handles the SetEndpoint directive. More...

Typedefs
using	SystemComponent = acsdkManufactory::Component< std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorInterface >, acsdkManufactory::Import< std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > >>
using	MockSettingManager = SettingsManager< SettingInterface< bool >, SettingInterface< int >, SettingInterface< std::string > >
	Alias for setting manager configuration. More...

Enumerations
enum	Index { BOOL, INT, STRING }
	Index used for setting access. More...

Functions
SystemComponent	getComponent (const std::chrono::milliseconds &sendPeriod=std::chrono::hours(1))
	TEST_F (StateReportGeneratorTest, test_createWithoutSettingManagerShouldFail)
	TEST_F (StateReportGeneratorTest, test_createWithEmptySettingManagerShouldSucceed)
	TEST_F (StateReportGeneratorTest, test_createWithFullSettingManagerShouldSucceed)
	TEST_F (StateReportGeneratorTest, test_generateReportWithFullSettingManager)
	TEST_F (StateReportGeneratorTest, test_generateReportWithPartialSettingManager)

Variables
Mock values and string representantion.
constexpr bool	BOOL_SETTING_VALUE = true
constexpr int	INT_SETTING_VALUE = 10
static const std::string	BOOL_SETTING_STRING_VALUE = "true"
static const std::string	INT_SETTING_STRING_VALUE = "10"
static const std::string	STRING_SETTING_VALUE = "string"
static const std::string	STRING_SETTING_STRING_VALUE = R"("string")"

Typedef Documentation

MockSettingManager

using alexaClientSDK::capabilityAgents::system::MockSettingManager = typedef SettingsManager<SettingInterface<bool>, SettingInterface<int>, SettingInterface<std::string> >

Alias for setting manager configuration.

SystemComponent

using alexaClientSDK::capabilityAgents::system::SystemComponent = typedef acsdkManufactory::Component< std::shared_ptr<avsCommon::sdkInterfaces::UserInactivityMonitorInterface>, acsdkManufactory::Import<std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::DirectiveSequencerInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface> >>

Manufactory Component definition for the System Capability Agent and related handlers.

Enumeration Type Documentation

Index

enum alexaClientSDK::capabilityAgents::system::Index

Index used for setting access.

Enumerator
BOOL
INT
STRING

Function Documentation

getComponent()

SystemComponent alexaClientSDK::capabilityAgents::system::getComponent

(

const std::chrono::milliseconds &

sendPeriod = std::chrono::hours(1)

)

Get the Manufactory component for System.

Parameters

sendPeriod

Optional. The period of send events for the UserInactivityMonitorInterface in seconds. Default value is 1 hour.

Returns

The Manufactory component for System.

TEST_F() [1/5]

alexaClientSDK::capabilityAgents::system::TEST_F	(	StateReportGeneratorTest	,
		test_createWithoutSettingManagerShouldFail
	)

TEST_F() [2/5]

alexaClientSDK::capabilityAgents::system::TEST_F	(	StateReportGeneratorTest	,
		test_createWithEmptySettingManagerShouldSucceed
	)

TEST_F() [3/5]

alexaClientSDK::capabilityAgents::system::TEST_F	(	StateReportGeneratorTest	,
		test_createWithFullSettingManagerShouldSucceed
	)

TEST_F() [4/5]

alexaClientSDK::capabilityAgents::system::TEST_F	(	StateReportGeneratorTest	,
		test_generateReportWithFullSettingManager
	)

TEST_F() [5/5]

alexaClientSDK::capabilityAgents::system::TEST_F	(	StateReportGeneratorTest	,
		test_generateReportWithPartialSettingManager
	)

Variable Documentation

BOOL_SETTING_STRING_VALUE

const std::string alexaClientSDK::capabilityAgents::system::BOOL_SETTING_STRING_VALUE = "true"

static

BOOL_SETTING_VALUE

constexpr bool alexaClientSDK::capabilityAgents::system::BOOL_SETTING_VALUE = true

INT_SETTING_STRING_VALUE

const std::string alexaClientSDK::capabilityAgents::system::INT_SETTING_STRING_VALUE = "10"

static

INT_SETTING_VALUE

constexpr int alexaClientSDK::capabilityAgents::system::INT_SETTING_VALUE = 10

STRING_SETTING_STRING_VALUE

const std::string alexaClientSDK::capabilityAgents::system::STRING_SETTING_STRING_VALUE = R"("string")"

static

STRING_SETTING_VALUE

const std::string alexaClientSDK::capabilityAgents::system::STRING_SETTING_VALUE = "string"

static