alexaClientSDK::capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent Class Reference

#include <SoftwareComponentReporterCapabilityAgent.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent:

Collaboration diagram for alexaClientSDK::capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent:

Public Member Functions
	~SoftwareComponentReporterCapabilityAgent ()=default
ComponentReporterInterface Functions
bool	addConfiguration (const std::shared_ptr< avsCommon::avs::ComponentConfiguration > configuration) override
CapabilityConfigurationInterface Functions
std::unordered_set< std::shared_ptr< avsCommon::avs::CapabilityConfiguration > >	getCapabilityConfigurations () override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ComponentReporterInterface
virtual	~ComponentReporterInterface ()=default
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface
virtual	~CapabilityConfigurationInterface ()=default

Static Public Member Functions
static std::shared_ptr< SoftwareComponentReporterCapabilityAgent >	create ()

Detailed Description

Capability Agent to collect the component configurations and report them to AVS.

Constructor & Destructor Documentation

~SoftwareComponentReporterCapabilityAgent()

alexaClientSDK::capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent::~SoftwareComponentReporterCapabilityAgent ( )

default

Destructor.

Member Function Documentation

addConfiguration()

bool alexaClientSDK::capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent::addConfiguration ( const std::shared_ptr< avsCommon::avs::ComponentConfiguration >  configuration )

overridevirtual

Adds a Component to the ComponentReporterInterface.

Parameters

configuration

A ComponentConfiguration to be added to the endpoint.

Returns

Bool indicating success/failure of adding a configuration. True for success, false for failure.

Implements alexaClientSDK::avsCommon::sdkInterfaces::ComponentReporterInterface.

create()

static std::shared_ptr<SoftwareComponentReporterCapabilityAgent> alexaClientSDK::capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent::create ( )

static

Create Method for Capability Agent

Returns

Returns a shared_ptr to the SoftwareComponentReporterCapabilityAgent.

getCapabilityConfigurations()

std::unordered_set<std::shared_ptr<avsCommon::avs::CapabilityConfiguration> > alexaClientSDK::capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent::getCapabilityConfigurations ( )

overridevirtual

Returns the configurations of the capability interfaces being implemented.

Returns

A set of CapabilityConfigurations

Implements alexaClientSDK::avsCommon::sdkInterfaces::CapabilityConfigurationInterface.

---

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

• /workplace/avs-device-sdk/CapabilityAgents/SoftwareComponentReporter/include/SoftwareComponentReporter/SoftwareComponentReporterCapabilityAgent.h