QuectelTowerRK::TowerInfo Class Reference

Container for serving tower and neighbor tower information. More...

#include <QuectelTowerRK.h>

Public Member Functions
	TowerInfo ()
	Default constructor.
virtual	~TowerInfo ()
	Destructor.
	TowerInfo (const TowerInfo &other)
	You can construct an object as a copy of another object. This is a deep copy.
TowerInfo &	operator= (const TowerInfo &other)
	Copy another object into this object. This is a deep copy.
void	clear ()
	Clear the object to default values with no neighbors.
int	parseServing (const char *in)
	Parse the results of an AT+QENG serving cell request.
int	parseNeighbor (const char *in)
	Parse the results of an AT+QENG neighbor cells request.
void	log (const char *msg, LogLevel level=LOG_LEVEL_TRACE)
	Log the information to the debugging log.
TowerInfo &	toJsonWriter (JSONWriter &writer, int numToInclude=0)
	Add the serving and neighbor towers to the writer in an array.
bool	isValid () const
	Returns true if the object appears to contain valid data.

Data Fields
CellularServing	serving
	The serving cell. This member is public.
std::vector< CellularNeighbor >	neighbors
	Vector of neighbor cells. This member is public.

Detailed Description

Container for serving tower and neighbor tower information.

Constructor & Destructor Documentation

TowerInfo()

QuectelTowerRK::TowerInfo::TowerInfo

(

const TowerInfo &

other

)

You can construct an object as a copy of another object. This is a deep copy.

Parameters

other

After copying, changes to the other object have no effect on this object. Also the other object can be deleted, if desired.

Member Function Documentation

isValid()

bool QuectelTowerRK::TowerInfo::isValid

(

)

const

Returns true if the object appears to contain valid data.

Returns

true

false

This just checks the serving cell RAT to make sure it's not NONE.

log()

void QuectelTowerRK::TowerInfo::log	(	const char *	msg,
		LogLevel	level = LOG_LEVEL_TRACE )

Log the information to the debugging log.

Parameters

msg	A message to write before the serving cell
level	Logging level. Default is LOG_LEVEL_TRACE. LOG_LEVEL_INFO is another common option.

operator=()

QuectelTowerRK::TowerInfo & QuectelTowerRK::TowerInfo::operator=

(

const TowerInfo &

other

)

Copy another object into this object. This is a deep copy.

Parameters

other

The previous contents of this object are cleared first; this does not merge data.

parseNeighbor()

int QuectelTowerRK::TowerInfo::parseNeighbor

(

const char *

in

)

Parse the results of an AT+QENG neighbor cells request.

Parameters

in

Returns

int

parseServing()

int QuectelTowerRK::TowerInfo::parseServing

(

const char *

in

)

Parse the results of an AT+QENG serving cell request.

Parameters

in

Returns

int

toJsonWriter()

QuectelTowerRK::TowerInfo & QuectelTowerRK::TowerInfo::toJsonWriter	(	JSONWriter &	writer,
		int	numToInclude = 0 )

Add the serving and neighbor towers to the writer in an array.

Parameters

writer
numToInclude	Number of towers to add, or 0 for all

Returns

TowerInfo&

Field Documentation

neighbors

std::vector<CellularNeighbor> QuectelTowerRK::TowerInfo::neighbors

Vector of neighbor cells. This member is public.

You can use vector members on this, like size(), at(), and iter() to work with the results.

---

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

• src/QuectelTowerRK.h
• src/QuectelTowerRK.cpp