class documentation

class BeaconInformation: (source)

Constructor: BeaconInformation(seenBeacons)

View In Hierarchy

Information about positioning beacons (a generalized term for the reference objects that help you determine your position, such as satellites or cell towers).

Method __init__ Initializes a beacon information object.
Method __repr__ Returns a string representation of this beacon information object.
Instance Variable seenBeacons A set of visible beacons. Note that visible beacons are not necessarily used in acquiring a positioning fix.
Instance Variable usedBeacons A set of the beacons that were used in obtaining a positioning fix. This only contains beacons that are actually used, not beacons for which it is unknown if they are used or not.
def __init__(self, seenBeacons=()): (source)

Initializes a beacon information object.

Parameters
seenBeacons:iterable of IPositioningBeaconsA collection of beacons that are currently seen.
def __repr__(self) -> str: (source)

Returns a string representation of this beacon information object.

The beacons are sorted by their identifier.

Returns
strThe string representation.
seenBeacons: set of IPositioningBeacon = (source)

A set of visible beacons. Note that visible beacons are not necessarily used in acquiring a positioning fix.

usedBeacons: set of IPositioningBeacon = (source)

A set of the beacons that were used in obtaining a positioning fix. This only contains beacons that are actually used, not beacons for which it is unknown if they are used or not.