Device Power Information used as part of the PresenceDescriptor. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions
void	clear ()

virtual void	initForDocumenting ()

Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual std::string	toString ()

virtual bool	isDocumenting () const

Public Attributes
int	source
	[Optional, Default: 0] Is the source the power is being delivered from

int	state
	[Optional, Default: 0] Is the current state that the power system is in.

int	level
	[Optional, Default: 0] Is the current level of the battery or power system as a percentage. Valid range is 0 to 100.

Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json	_attached

Additional Inherited Members
Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool	_documenting

Detailed Description

Device Power Information used as part of the PresenceDescriptor.

Helper C++ class to serialize and de-serialize Power JSON

Example JSON:

{
   "level": 0,
   "source": 0,
   "state": 0
}

See also: PresenceDescriptor

Definition at line 1750 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Power()

AppConfigurationObjects::Power::Power ( )

inline

Definition at line 1787 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Power::clear ( )

inline

Definition at line 1792 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::Power::initForDocumenting ( )

inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 1799 of file ConfigurationObjects.h.

Member Data Documentation

◆ level

int AppConfigurationObjects::Power::level

[Optional, Default: 0] Is the current level of the battery or power system as a percentage. Valid range is 0 to 100.

Definition at line 1785 of file ConfigurationObjects.h.

◆ source

int AppConfigurationObjects::Power::source

[Optional, Default: 0] Is the source the power is being delivered from

Valid values are

Value	Description
0	Undefined
1	Battery
2	Wired

Definition at line 1768 of file ConfigurationObjects.h.

◆ state

int AppConfigurationObjects::Power::state

[Optional, Default: 0] Is the current state that the power system is in.

Valid values are

Value	Description
0	Undefined
1	Charging
2	Discharging
3	Not Charging
4	Full

Definition at line 1782 of file ConfigurationObjects.h.

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

engage/src/api/c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Additional Inherited Members