Handles the response to the command
<GenericInertialCommand::Response>
Gets the InertialTypes::Command
Gets the data field byte that should be received with the data field (if any)
Response( |
| ) |
Creates a get beacon status Response object
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
bool parseResponse( |
| ) const |
Parses a successfully matched response for the ContinuousDataStream command.
response | The GenericInertialCommandResponse that matches the data field for this response. |
true if the data stream is enabled, false if it is disabled.
Response( |
| ) |
Creates the ContinuousDataStream::Response object.
collector std::weak_ptr<ResponseCollector> | The ResponseCollector to register the response with. |
dataResponse bool | Whether the command is expecting a data field response |
type | The InertialTypes::InertialCategory to use for the command/response. |
virtual bool match_data( |
| ) override |
Attempts to match an InertialDataField to the expected data field response.
true if the field matches the expected data, false if it does not.
Gets the InertialTypes::Command for the Inertial command
Gets the descriptor set byte for the Inertial command
Gets the command byte for the Inertial command
Gets the ack/nack byte that should be received with the ack/nack field
Response( |
| ) |
Creates a Ping Response object
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
ackNackResponse bool | Whether or not an ack/nack response field is expected |
dataResponse bool | Whether or not a data response field is expected |
cmdName std::string | The name of the command (to be used in exceptions that may be thrown) |
virtual bool match( |
| ) override |
Checks if the InertialDataField passed in matches the expected response pattern's bytes
field const InertialDataField& | The InertialDataField in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
bool match_ackNack( |
| ) |
Checks if the InertialDataField matches the ACK/NACK field for this command (if one is even expected)
field const InertialDataField& | The InertialDataField in which to try to find the pattern |
true if the packet matches the expected response pattern, false otherwise
virtual bool match_data( |
| ) |
Checks if the InertialDataField matches the data field for this command (if one is even expected)
field const InertialDataField& | The InertialDataField in which to try to find the pattern |
true if the packet matches the expected response pattern, false otherwise
bool wait( |
| ) |
Waits for a certain amount of time for the response pattern to be matched
timeout uint64 | The maximum time (in milliseconds) to wait until the command times out and returns, if not found first |
true if the response pattern was matched, false otherwise
Gets the GenericInertialCommandResponse that holds the result of the response
A GenericInertialCommandResponse that holds the result of the response
virtual bool match_data( |
| ) override |
Attempts to match an InertialDataField to the expected data field response.
true if the field matches the expected data, false if it does not.
virtual bool match_data( |
| ) override |
Attempts to match an InertialDataField to the expected data field response.
true if the field matches the expected data, false if it does not.
Response( |
| ) |
Creates an ArmForDatalogging Response object
nodeAddress | the node address to check for |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
Response( |
| ) |
Creates a LongPing Response object
nodeAddress | the node address to check for in the response. |
channelNumber uint8 | The channel number to check for in the response. |
targetPercent float | The target percentage (0-100) to check for in the response. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response. |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
Response( |
| ) |
Creates a AutoCal Response object
nodeAddress | The node address to check for. |
model | The WirelessModels::NodeModel of the Node we are expecting a response for. |
fwVersion const Version& | The firmware version of the Node we are expecting a response for. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response. |
Gets whether the AutoCal operation has started or not.
true if the Node indicated that the AutoCal operation has started, false otherwise.
Gets the total time (in seconds) that the Node reported it will take to complete the AutoCal operation.
The time (in seconds) that the Node reported it will take to complete AutoCal.
Gets the WirelessTypes::AutoCalCompletionFlag of the AutoCal operation.
The WirelessTypes::AutoCalCompletionFlag of the AutoCal operation.
Gets the information bytes returned from the AutoCal completion packet.
The information Bytes from the AutoCal completion packet.
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes.
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
bool match_nodeReceived( |
| ) |
Checks if the WirelessPacket passed in matches the "Node Received" packet.
packet | The WirelessPacket to try to match. |
true if the packet matches the Node Received packet, false otherwise.
bool match_shmLink( |
| ) |
Checks if the WirelessPacket matches the SHM-Link AutoCal packet.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the packet matches the SHM-Link AutoCal packet, false otherwise.
virtual bool match( |
| ) override |
Checks if the packet passed in matches either the success or failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the response pattern was found, false otherwise.
bool matchSuccessResponse( |
| ) |
Checks if the packet passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the success response pattern was found, false otherwise
bool matchFailResponse( |
| ) |
Checks if the packet passed in matches the failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the failure response pattern was found, false otherwise
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the response pattern was found, false otherwise
virtual bool match( |
| ) override |
Checks if the packet passed in matches any response to the Ping command.
packet const WirelessPacket& | The WirelessPacket to check for a match. |
true if the response pattern was found, false otherwise.
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the response pattern was found, false otherwise
Gets the result value of the response.
The result value of the response.
Error: failed to read the base station's eeprom.
bool matchSuccessResponse( |
| ) |
Checks if the bytes passed in match the success response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the success response pattern was found, false otherwise
bool matchFailResponse( |
| ) |
Checks if the bytes passed in match the failure response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the failure response pattern was found, false otherwise
Response( |
| ) |
Creates a read eeprom Response object.
eepromAddress uint16 | The eeprom address being read from. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response. |
virtual bool match( |
| ) override |
Checks if the packet passed in matches either the success or failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the response pattern was found, false otherwise.
Gets the result value of the response.
The result value of the response.
Error: failed to read the base station's eeprom.
Gets the WirelessPacket::ResponseErrorCode from the response packet.
The error code from the response.
bool matchSuccessResponse( |
| ) |
Checks if the packet passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the success response pattern was found, false otherwise
bool matchFailResponse( |
| ) |
Checks if the packet passed in matches the failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the failure response pattern was found, false otherwise
Response( |
| ) |
Creates a get beacon status Response object
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
min uint32 | The minimum sweep frequency to match. |
max uint32 | The maximum sweep frequency to match. |
interval uint32 | The sweep interval to match. |
options uint16 | The advanced options to match. |
virtual bool match( |
| ) override |
Checks if the packet passed in matches either the success or failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the response pattern was found, false otherwise.
bool matchSuccessResponse( |
| ) |
Checks if the packet passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the success response pattern was found, false otherwise
Response( |
| ) |
Creates a set beacon Response object
utcTime uint64 | The start time for the beacon in UTC seconds from the Unix Epoch (01/01/1970) |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the response pattern was found, false otherwise
Gets the start time that was sent to enable the beacon
a Timestamp representing the start time that was sent to enable the beacon
Response( |
| ) |
Creates a set beacon Response object
utcTime uint32 | The start time for the beacon in UTC seconds from the Unix Epoch (01/01/1970) |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the packet passed in matches either the success or failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the response pattern was found, false otherwise.
Gets the start time that was sent to enable the beacon
a Timestamp representing the start time that was sent to enable the beacon
bool matchSuccessResponse( |
| ) |
Checks if the packet passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the success response pattern was found, false otherwise
bool matchFailResponse( |
| ) |
Checks if the packet passed in matches the failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the failure response pattern was found, false otherwise
Response( |
| ) |
Creates a write eeprom Response object
valueToWrite uint16 | The value that is expected to be written to eeprom from the associated command |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the response pattern was found, false otherwise
bool matchSuccessResponse( |
| ) |
Checks if the bytes passed in match the success response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the success response pattern was found, false otherwise
bool matchFailResponse( |
| ) |
Checks if the bytes passed in match the failure response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the failure response pattern was found, false otherwise
Response( |
| ) |
Creates a write eeprom Response object
valueToWrite uint16 | The value that is expected to be written to eeprom from the associated command |
eepromAddress uint16 | The eeprom address being written to. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the packet passed in matches either the success or failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the response pattern was found, false otherwise.
Gets the WirelessPacket::ResponseErrorCode from the response packet.
The error code from the response.
bool matchSuccessResponse( |
| ) |
Checks if the packet passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the success response pattern was found, false otherwise
bool matchFailResponse( |
| ) |
Checks if the packet passed in matches the failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the failure response pattern was found, false otherwise
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the response pattern was found, false otherwise
Response( |
| ) |
Creates a LongPing Response object
nodeAddress | the node address to check for |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
Gets the PingResponse that holds the result of the response
A PingResponse that holds the result of the response
virtual bool match( |
| ) override |
Checks if the DataBuffer passed in matches the expected response pattern's bytes
data | The DataBuffer containing the bytes to match |
true if the bytes match a response pattern, false otherwise
Gets the dataPoints that were downloaded from the Node
A ByteStream holding the data points (if any) that were downloaded from the Node
bool matchSuccessResponsePart1( |
| ) |
Checks if the DataBuffer passed in matches the first part (Command Byte) of the response bytes
data | The DataBuffer containing the bytes to match |
true if the bytes match the first part of the success response pattern, false otherwise
bool matchSuccessResponse( |
| ) |
Checks if the DataBuffer passed in matches the success response bytes
data | The DataBuffer containing the bytes to match |
true if the bytes match the success response pattern, false otherwise
Checks if the DataBuffer passed in matches the fail response bytes
data | The DataBuffer containing the bytes to match |
true if the bytes match the fail response pattern, false otherwise
Response( |
| ) |
Creates a EepromRead Response object
nodeAddress | the node address to check for |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
Gets the result eeprom value that was read from the Node.
The eeprom value read from the Node.
Response( |
| ) |
Creates a EepromRead Response object
nodeAddress | The node address to check for. |
eepromAddress uint16 | The eeprom address we read from. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response. |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes.
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern. |
true if the packet matches a response pattern, false otherwise.
Gets the result eeprom value that was read from the Node.
The eeprom value read from the Node.
Gets the WirelessPacket::ResponseErrorCode from the response packet.
The error code from the response.
bool matchSuccessResponse( |
| ) |
Checks if the WirelessPacket passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to match. |
true if the packet matches the success response, false otherwise.
bool matchFailResponse( |
| ) |
Checks if the WirelessPacket passed in matches the failure response.
packet const WirelessPacket& | The WirelessPacket to match. |
true if the packet matches the fail response, false otherwise.
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the response pattern was found, false otherwise
Gets the sensor value that was in the response to the read single sensor command.
Response( |
| ) |
Creates a SetToIdle Response object
nodeAddress | the node address to check for. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response. |
baseStation const BaseStation& | The BaseStation that will send the command (used for canceling this command). |
Destroys the SetToIdle Response object. This also cancels the SetToIdle operation on the BaseStation, if not already complete or canceled.
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position.
data | The DataBuffer containing the bytes in which to try to find the pattern. |
true if the response pattern was found, false otherwise.
Attempts to cancel the Stop Node operation.
Error_Communication: Failed to cancel the Stop Node operation.
Gets the <SetToIdleResult> of the Stop Node command.
The <SetToIdleResult> containing the result of the Stop Node command.
virtual bool match( |
| ) override |
Checks if the bytes passed in match the response pattern from their current read position
data | The DataBuffer containing the bytes in which to try to find the pattern |
true if the response pattern was found, false otherwise
Response( |
| ) |
Creates a ShortPing_v2 Response object.
nodeAddress | the node address to check for. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response. |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
bool matchSuccessResponse( |
| ) |
Checks if the packet passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the success response pattern was found, false otherwise
bool matchFailResponse( |
| ) |
Checks if the packet passed in matches the failure response.
packet const WirelessPacket& | The WirelessPacket to try to match. |
true if the failure response pattern was found, false otherwise
Response( |
| ) |
Creates a StartSyncSampling Response object
nodeAddress | the node address to check for |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
Response( |
| ) |
Creates a WriteEeprom Response object
nodeAddress | the node address to check for |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
Response( |
| ) |
Creates a WriteEeprom_v2 Response object
nodeAddress | the node address to check for. |
eepromAddress uint16 | the eeprom address that was written to. |
valueWritten uint16 | the value that was written to eeprom. |
collector std::weak_ptr<ResponseCollector> | The ResponseCollector used to register and unregister the response. |
virtual bool match( |
| ) override |
Checks if the WirelessPacket passed in matches the expected response pattern's bytes
packet const WirelessPacket& | The WirelessPacket in which to try to find the pattern |
true if the packet matches a response pattern, false otherwise
Gets the WirelessPacket::ResponseErrorCode from the response packet.
The error code from the response.
bool matchSuccessResponse( |
| ) |
Checks if the WirelessPacket passed in matches the success response.
packet const WirelessPacket& | The WirelessPacket to match. |
true if the packet matches the success response, false otherwise.
bool matchFailResponse( |
| ) |
Checks if the WirelessPacket passed in matches the failure response.
packet const WirelessPacket& | The WirelessPacket to match. |
true if the packet matches the fail response, false otherwise.
The device selector to look for in the response.
Whether or not an ack/nack response field is expected
Whether or not a data response field is expected
The name of the command
The GenericInertialCommandResponse that holds the result of the GenericInertialCommand
The channel number to look for in the response.
The target percentage to look for in the response.
The AutoBalanceResult containing info about the autobalance response.
The WirelessModels::NodeModel of the Node we are expecting a response for.
Whether the AutoCal has been successfully started or not (as reported by the Node).
The <AutoCalCompletionFlag> representing the final autocal status.
The amount of time (in seconds) that the autocal operation will take to complete. This value gets reported by the Node before starting the calibration.
The result value of the read eeprom command.
The eeprom address to match in the response.
The result value of the read eeprom command.
The WirelessPacket::ResponseErrorCode from the response.
The min frequency to match in the response.
The max frequency to match in the response.
The interval to match in the response.
The options to send with the command.
The start time that was sent to the beacon as a Timestamp object
The start time that was sent to the beacon.
The value that is expected to be written to eeprom from the associated command
The value that is expected to be written to eeprom from the associated command.
The eeprom address to match in the response.
The WirelessPacket::ResponseErrorCode from the response.
The data points that make up the "page" that was downloaded from the Node
Whether or not part 1 (the Command Byte) of the response has been matched
The result eeprom value from the command.
The eeprom address to look for in the ReadEeprom response.
The result eeprom value from the command.
The WirelessPacket::ResponseErrorCode from the response.
The value read from the sensor.
The node address to look for in the response.
The <SetToIdleResult> detailing the result of the Set to Idle command.
The BaseStation that will send the command (used for canceling this command).
The mutex used for thread safety.
The eeprom address to look for in the WriteEeprom_v2 response.
The eeprom value to look for in the WriteEeprom_v2 response.
The WirelessPacket::ResponseErrorCode from the response.