#include <StateReportGenerator.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::system::StateReportGenerator:

Public Types
template<class SettingsManagerT >
using	SettingConfigurations = typename settings::SettingsManagerBuilderBase< SettingsManagerT >::SettingConfigurations

Public Member Functions
std::vector< std::string >	generateReport ()

	StateReportGenerator ()=default

Static Public Member Functions
template<class SettingsManagerT >
static avsCommon::utils::Optional< StateReportGenerator >	create (std::shared_ptr< SettingsManagerT > settingManager, const SettingConfigurations< SettingsManagerT > &configurations)

Protected Member Functions
	StateReportGenerator (const std::vector< std::function< std::string()>> &reportFunctions)

Detailed Description

This class is responsible for generating a state report for every setting available in a given SettingsManager.

Note: This class is not thread safe.

Member Typedef Documentation

◆ SettingConfigurations

template<class SettingsManagerT >

using alexaClientSDK::capabilityAgents::system::StateReportGenerator::SettingConfigurations = typename settings::SettingsManagerBuilderBase<SettingsManagerT>::SettingConfigurations

Alias for the SettingsConfigurations of a given SettingsManager.

Template Parameters

SettingsManagerT The target settings manager type.

Constructor & Destructor Documentation

◆ StateReportGenerator() [1/2]

alexaClientSDK::capabilityAgents::system::StateReportGenerator::StateReportGenerator ( )

default

Default constructor. This should only be used by optional.

◆ StateReportGenerator() [2/2]

alexaClientSDK::capabilityAgents::system::StateReportGenerator::StateReportGenerator ( const std::vector< std::function< std::string()>> & reportFunctions )

explicitprotected

Constructor (protected for unit tests).

Parameters

reportFunctions The collection of report functions used to generate the entire report.

Member Function Documentation

◆ create()

template<class SettingsManagerT >

avsCommon::utils::Optional< StateReportGenerator > alexaClientSDK::capabilityAgents::system::StateReportGenerator::create	(	std::shared_ptr< SettingsManagerT >	settingManager,
		const SettingConfigurations< SettingsManagerT > &	configurations
	)

static

Create a StateReportGenerator for the given manager with the provided configurations.

Template Parameters

SettingsManagerT The type of the SettingManager.

Parameters

settingManager	The manager that exposes the setting states.
configurations	The configurations which hold the metadata to generate the report.

Returns: An optional with a valid StateReportGenerator if it succeeds; an empty optional otherwise.

◆ generateReport()

std::vector<std::string> alexaClientSDK::capabilityAgents::system::StateReportGenerator::generateReport ( )

Generate a report for each setting.

Returns: The generated reports.

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

/workplace/avs-device-sdk/CapabilityAgents/System/include/System/StateReportGenerator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions