AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
ArtifactUnderTest Class Reference

#include <ArtifactUnderTest.h>

Inheritance diagram for ArtifactUnderTest:
Inheritance graph
[legend]
Collaboration diagram for ArtifactUnderTest:
Collaboration graph
[legend]

Public Member Functions

bool hasAllProps ()
 
bool hasStateProp ()
 
bool hasPriorityProp ()
 
bool hasPathProp ()
 
State getStateProp ()
 
Priority getPriorityProp ()
 
string getPathProp ()
 
Priority setPriorityProp (Priority p)
 
bool waitUntilStateEquals (State expectedState, milliseconds timeout=milliseconds(500))
 
void onCommunicationPropertyChange (const std::string &PropertyName, int newValue) override
 
void onCommunicationPropertyChange (const std::string &PropertyName, string) override
 
void resetCounts ()
 
void subscribeToChangeEvents ()
 
 ArtifactUnderTest (std::shared_ptr< AmdCommunicationInterface > comm, shared_ptr< ArtifactRequest > request)
 
- Public Member Functions inherited from alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< int >
virtual ~CommunicationPropertyChangeSubscriber ()=default
 
- Public Member Functions inherited from alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< string >
virtual ~CommunicationPropertyChangeSubscriber ()=default
 

Public Attributes

std::shared_ptr< AmdCommunicationInterfacecommsHandler
 
shared_ptr< ArtifactRequestrequest
 
unordered_map< State, int, alexaClientSDK::avsCommon::utils::functional::EnumClassHashstateMap
 
int updateEventCount = 0
 

Constructor & Destructor Documentation

◆ ArtifactUnderTest()

ArtifactUnderTest::ArtifactUnderTest ( std::shared_ptr< AmdCommunicationInterface comm,
shared_ptr< ArtifactRequest request 
)
inline

Member Function Documentation

◆ getPathProp()

string ArtifactUnderTest::getPathProp ( )
inline

◆ getPriorityProp()

Priority ArtifactUnderTest::getPriorityProp ( )
inline

◆ getStateProp()

State ArtifactUnderTest::getStateProp ( )
inline

◆ hasAllProps()

bool ArtifactUnderTest::hasAllProps ( )
inline

◆ hasPathProp()

bool ArtifactUnderTest::hasPathProp ( )
inline

◆ hasPriorityProp()

bool ArtifactUnderTest::hasPriorityProp ( )
inline

◆ hasStateProp()

bool ArtifactUnderTest::hasStateProp ( )
inline

◆ onCommunicationPropertyChange() [1/2]

void ArtifactUnderTest::onCommunicationPropertyChange ( const std::string &  propertyName,
int  newValue 
)
inlineoverridevirtual

Function that is called when the Communication Property that is subscribed to has the value changed.

Parameters
propertyNameThe name of the property
newValueThe new value of the property

Implements alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< int >.

◆ onCommunicationPropertyChange() [2/2]

void ArtifactUnderTest::onCommunicationPropertyChange ( const std::string &  propertyName,
string  newValue 
)
inlineoverridevirtual

Function that is called when the Communication Property that is subscribed to has the value changed.

Parameters
propertyNameThe name of the property
newValueThe new value of the property

Implements alexaClientSDK::acsdkCommunicationInterfaces::CommunicationPropertyChangeSubscriber< string >.

◆ resetCounts()

void ArtifactUnderTest::resetCounts ( )
inline

◆ setPriorityProp()

Priority ArtifactUnderTest::setPriorityProp ( Priority  p)
inline

◆ subscribeToChangeEvents()

void ArtifactUnderTest::subscribeToChangeEvents ( )
inline

◆ waitUntilStateEquals()

bool ArtifactUnderTest::waitUntilStateEquals ( State  expectedState,
milliseconds  timeout = milliseconds(500) 
)
inline

Member Data Documentation

◆ commsHandler

std::shared_ptr<AmdCommunicationInterface> ArtifactUnderTest::commsHandler

◆ request

shared_ptr<ArtifactRequest> ArtifactUnderTest::request

◆ stateMap

unordered_map<State, int, alexaClientSDK::avsCommon::utils::functional::EnumClassHash> ArtifactUnderTest::stateMap

◆ updateEventCount

int ArtifactUnderTest::updateEventCount = 0

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0