Location 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
uint32_t	ts
	[Read Only: Unix timestamp - Zulu/UTC] Indicates the timestamp that the location was recorded.

double	latitude
	Its the latitude position using the using the Signed degrees format (DDD.dddd). Valid range is -90 to 90.

double	longitude
	Its the longitudinal position using the Signed degrees format (DDD.dddd) format. Valid range is -180 to 180.

double	altitude
	[Optional, Default: INVALID_LOCATION_VALUE] The altitude above sea level in meters.

double	direction
	[Optional, Default: INVALID_LOCATION_VALUE] Direction the endpoint is traveling in degrees. Valid range is 0 to 360 (NOTE: 0 and 360 are both the same heading).

double	speed
	[Optional, Default: INVALID_LOCATION_VALUE] The speed the endpoint is traveling at in meters per second.

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

Static Public Attributes
static constexpr double	INVALID_LOCATION_VALUE = -999.999

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

Detailed Description

Location information used as part of the PresenceDescriptor.

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

Location is presented by using the World Geodetic System (WGS84)

Example JSON:

{
   "altitude": 123.0,
   "direction": 1.0,
   "latitude": 123.456,
   "longitude": 456.789,
   "speed": 1234.0,
   "ts": 123456
}

See also: PresenceDescriptor

Definition at line 1517 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ Location()

AppConfigurationObjects::Location::Location ( )

inline

Definition at line 1543 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::Location::clear ( )

inline

Definition at line 1548 of file ConfigurationObjects.h.

◆ initForDocumenting()

virtual void AppConfigurationObjects::Location::initForDocumenting ( )

inlinevirtual

Reimplemented from AppConfigurationObjects::ConfigurationObjectBase.

Definition at line 1558 of file ConfigurationObjects.h.

Member Data Documentation

◆ altitude

double AppConfigurationObjects::Location::altitude

[Optional, Default: INVALID_LOCATION_VALUE] The altitude above sea level in meters.

Definition at line 1535 of file ConfigurationObjects.h.

◆ direction

double AppConfigurationObjects::Location::direction

[Optional, Default: INVALID_LOCATION_VALUE] Direction the endpoint is traveling in degrees. Valid range is 0 to 360 (NOTE: 0 and 360 are both the same heading).

Definition at line 1538 of file ConfigurationObjects.h.

◆ INVALID_LOCATION_VALUE

constexpr double AppConfigurationObjects::Location::INVALID_LOCATION_VALUE = -999.999

staticconstexpr

Definition at line 1523 of file ConfigurationObjects.h.

◆ latitude

double AppConfigurationObjects::Location::latitude

Its the latitude position using the using the Signed degrees format (DDD.dddd). Valid range is -90 to 90.

Definition at line 1529 of file ConfigurationObjects.h.

◆ longitude

double AppConfigurationObjects::Location::longitude

Its the longitudinal position using the Signed degrees format (DDD.dddd) format. Valid range is -180 to 180.

Definition at line 1532 of file ConfigurationObjects.h.

◆ speed

double AppConfigurationObjects::Location::speed

[Optional, Default: INVALID_LOCATION_VALUE] The speed the endpoint is traveling at in meters per second.

Definition at line 1541 of file ConfigurationObjects.h.

◆ ts

uint32_t AppConfigurationObjects::Location::ts

[Read Only: Unix timestamp - Zulu/UTC] Indicates the timestamp that the location was recorded.

Definition at line 1526 of file ConfigurationObjects.h.

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

c/include/ConfigurationObjects.h

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members