CellularHelper
Public Member Functions | Data Fields
CellularHelperLocationResponse Class Reference

Reponse class for the AT+ULOC command. More...

#include <CellularHelper.h>

Inheritance diagram for CellularHelperLocationResponse:
CellularHelperPlusStringResponse CellularHelperCommonResponse

Public Member Functions

bool isValid () const
 Returns true if a valid location was found.
 
void postProcess ()
 Converts the data in string into the broken out fields like lat, lon, alt, uncertainty.
 
String toString () const
 Converts this object into a readable string. More...
 
- Public Member Functions inherited from CellularHelperPlusStringResponse
virtual int parse (int type, const char *buf, int len)
 Method to parse the output from the modem. More...
 
String getDoubleQuotedPart (bool onlyFirst=true) const
 Gets the double quoted part of a string response. More...
 
- Public Member Functions inherited from CellularHelperCommonResponse
void logCellularDebug (int type, const char *buf, int len) const
 Used when enableDebug is true to log the Cellular.command callback data using Log.info. More...
 

Data Fields

bool valid = false
 Set to true if the values have been set.
 
float lat = 0.0
 Estimated latitude, in degrees (-90 to +90)
 
float lon = 0.0
 Estimated longitude, in degrees (-180 to +180)
 
int alt = 0
 Estimated altitude, in meters. Not always returned.
 
int uncertainty = 0
 Maximum possible error, in meters (0 - 20000000)
 
- Data Fields inherited from CellularHelperPlusStringResponse
String command
 Your subclass must set this to the command requesting (not including the AT+ part) More...
 
String string
 Returned string is stored here.
 
- Data Fields inherited from CellularHelperCommonResponse
int resp = RESP_ERROR
 Response code from Cellular.command. More...
 
bool enableDebug = false
 Enables debug mode (default: false) More...
 

Detailed Description

Reponse class for the AT+ULOC command.

This class is returned from CellularHelper.getLocation(). You normally won't instantiate one of these directly.

Member Function Documentation

◆ toString()

String CellularHelperLocationResponse::toString ( ) const

Converts this object into a readable string.

The string will be of the format lat=12.345 lon=567.89 alt=0 uncertainty=2000.


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