AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager Class Reference

#include <MockPowerResourceManager.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager:
Collaboration graph
[legend]

Public Member Functions

 MOCK_METHOD2 (acquirePowerResource, void(const std::string &component, const PowerResourceLevel level))
 
 MOCK_METHOD1 (releasePowerResource, void(const std::string &component))
 
 MOCK_METHOD1 (isPowerResourceAcquired, bool(const std::string &component))
 
 MOCK_METHOD3 (create, std::shared_ptr< PowerResourceId >(const std::string &resourceId, bool isRefCounted, const PowerResourceLevel level))
 
 MOCK_METHOD2 (acquire, bool(const std::shared_ptr< PowerResourceId > &id, const std::chrono::milliseconds autoReleaseTimeout))
 
 MOCK_METHOD1 (release, bool(const std::shared_ptr< PowerResourceId > &id))
 
 MOCK_METHOD1 (close, bool(const std::shared_ptr< PowerResourceId > &id))
 
void setDefaultBehavior ()
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::PowerResourceManagerInterface
virtual ~PowerResourceManagerInterface ()=default
 
virtual void acquirePowerResource (const std::string &component, const PowerResourceLevel level=PowerResourceLevel::STANDBY_MED)=0
 
virtual void releasePowerResource (const std::string &component)=0
 
virtual bool isPowerResourceAcquired (const std::string &component)=0
 
virtual std::chrono::milliseconds getTimeSinceLastResumeMS ()
 
virtual std::chrono::milliseconds getTimeSinceLastPartialMS (const std::string &component, PartialStateBitSet &resourceFlags, PartialStateBitSet partialState=PowerResourceTypeFlag::TYPE_ALL_FLAG)
 
virtual std::shared_ptr< PowerResourceIdcreate (const std::string &resourceId, bool isRefCounted=true, const PowerResourceLevel level=PowerResourceLevel::STANDBY_MED)=0
 
virtual bool acquire (const std::shared_ptr< PowerResourceId > &id, const std::chrono::milliseconds autoReleaseTimeout=std::chrono::milliseconds::zero())=0
 
virtual bool release (const std::shared_ptr< PowerResourceId > &id)=0
 
virtual bool close (const std::shared_ptr< PowerResourceId > &id)=0
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::PowerResourceManagerInterface
enum  PowerResourceLevel {
  PowerResourceLevel::STANDBY_LOW = 0, PowerResourceLevel::STANDBY_MED, PowerResourceLevel::STANDBY_HIGH, PowerResourceLevel::ACTIVE_LOW,
  PowerResourceLevel::ACTIVE_MED, PowerResourceLevel::ACTIVE_HIGH
}
 
enum  PowerResourceTypeIndex {
  TYPE_CPU = 0, TYPE_DDR, TYPE_STORAGE, TYPE_NETWORK,
  TYPE_RESERVED_ONE, TYPE_RESERVED_TWO, NUM_OF_TYPES
}
 
enum  PowerResourceTypeFlag {
  TYPE_ALL_FLAG = 0, TYPE_CPU_FLAG = 1 << PowerResourceTypeIndex::TYPE_CPU, TYPE_DDR_FLAG = 1 << PowerResourceTypeIndex::TYPE_DDR, TYPE_STORAGE_FLAG = 1 << PowerResourceTypeIndex::TYPE_STORAGE,
  TYPE_NETWORK_FLAG = 1 << PowerResourceTypeIndex::TYPE_NETWORK, TYPE_RESERVED_ONE_FLAG = 1 << PowerResourceTypeIndex::TYPE_RESERVED_ONE, TYPE_RESERVED_TWO_FLAG = 1 << PowerResourceTypeIndex::TYPE_RESERVED_TWO
}
 
using PartialStateBitSet = std::bitset< PowerResourceTypeIndex::NUM_OF_TYPES >
 

Detailed Description

Mock class implementing PowerResourceManagerInterface

Member Function Documentation

◆ MOCK_METHOD1() [1/4]

alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::MOCK_METHOD1 ( releasePowerResource  ,
void(const std::string &component)   
)

◆ MOCK_METHOD1() [2/4]

alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::MOCK_METHOD1 ( isPowerResourceAcquired  ,
bool(const std::string &component)   
)

◆ MOCK_METHOD1() [3/4]

alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::MOCK_METHOD1 ( release  ,
bool(const std::shared_ptr< PowerResourceId > &id)   
)

◆ MOCK_METHOD1() [4/4]

alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::MOCK_METHOD1 ( close  ,
bool(const std::shared_ptr< PowerResourceId > &id)   
)

◆ MOCK_METHOD2() [1/2]

alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::MOCK_METHOD2 ( acquirePowerResource  ,
void(const std::string &component, const PowerResourceLevel level)   
)

◆ MOCK_METHOD2() [2/2]

alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::MOCK_METHOD2 ( acquire  ,
bool(const std::shared_ptr< PowerResourceId > &id, const std::chrono::milliseconds autoReleaseTimeout)   
)

◆ MOCK_METHOD3()

alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::MOCK_METHOD3 ( create  ,
std::shared_ptr< PowerResourceId const std::string &resourceId, bool isRefCounted, const PowerResourceLevel level 
)

◆ setDefaultBehavior()

void alexaClientSDK::avsCommon::sdkInterfaces::test::MockPowerResourceManager::setDefaultBehavior ( )
inline

Some methods require default behavior to be useful, even in a mock. This function sets those default behaviors.


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