BaseStation_BeaconStatus
BeaconStatus
BeaconStatus

Represents the status of a BaseStation beacon.  See also BaseStation::beaconStatus.

Functions
BeaconStatus
BeaconStatus()

Creates a default BeaconStatus object.

BeaconStatus
BeaconStatus(
bool beaconEnabled,
const Timestamp &currentTimestamp
)

Creates a BeaconStatus object with the given parameters.

Parameters
beaconEnabled
bool

Whether the beacon is enabled or disabled.

currentTimestamp
const Timestamp&

The current Timestamp of the beacon.

Variables
m_enabled
bool m_enabled

Whether the beacon is enabled or disabled.

m_timestamp
Timestamp m_timestamp

The current Timestamp of the beacon.

Functions
enabled
bool enabled()

Gets whether the beacon is enabled (true) or disabled (false).

timestamp;

Gets the current Timestamp of the beacon.

BaseStation_BeaconStatus
BaseStation_BeaconStatus

Contains logic for the base station Get Beacon Status command.

Functions
buildCommand
static ByteStream buildCommand()

Builds the beacon status command.

Returns

A ByteStream containing the base station beacon status command.

Response
public
ResponsePattern
GenericInertialCommand.​Response
GenericInertialCommand.​Response
GenericInertialCommand.​Response
GenericInertialCommand.​Response
GenericInertialCommand.​Response
GenericInertialCommand.​Response
GenericInertialCommand.​Response
GenericInertialCommand.​Response
GenericInertialCommand.​Response
Response

Handles the response to the command

Functions
Response
Response(
std::weak_ptr<ResponseCollectorcollector
)

Creates a get beacon status Response object

Parameters
collector
std::weak_ptr<ResponseCollector>

The ResponseCollector used to register and unregister the response

Variables
m_result
BeaconStatus m_result

The BeaconStatus that holds the result of the command.

Functions
match
virtual bool match(
const WirelessPacket &packet
) override

Checks if the packet passed in matches either the success or failure response.

Parameters
packet

The WirelessPacket to try to match.

Returns

true if the response pattern was found, false otherwise.

result
BeaconStatus result()

Gets the BeaconStatus that holds the result of the response.

matchSuccessResponse
bool matchSuccessResponse(
const WirelessPacket &packet
)

Checks if the packet passed in matches the success response.

Parameters
packet

The WirelessPacket to try to match.

Returns

true if the success response pattern was found, false otherwise

matchFailResponse
bool matchFailResponse(
const WirelessPacket &packet
)

Checks if the packet passed in matches the failure response.

Parameters
packet

The WirelessPacket to try to match.

Returns

true if the failure response pattern was found, false otherwise