QtXBee::Wpan::RxBaseResponse Class Reference

The RxBaseResponse class is the base to implement a Wpan Response. More...

#include <rxbaseresponse.h>

Inheritance diagram for QtXBee::Wpan::RxBaseResponse:
QtXBee::XBeeResponse QtXBee::XBeePacket QtXBee::Wpan::RxResponse16 QtXBee::Wpan::RxResponse64 QtXBee::Wpan::RxResponseIoSampleBase QtXBee::Wpan::RxResponseIoSample16 QtXBee::Wpan::RxResponseIoSample64

Public Member Functions

 RxBaseResponse (QObject *parent=0)
 
virtual void clear ()
 Clears the packet by reseting all attributes to their default value. More...
 
virtual QString toString ()
 Returns a debug string containing all packet's informations. More...
 
void setRSSI (const qint8 rssi)
 Sets the RSSI (Received Signal Strength Indication) More...
 
void setOptions (const quint8 options)
 
qint8 rssi () const
 Returns the RSSI (Received Signal Strength Indication) More...
 
quint8 options () const
 
- Public Member Functions inherited from QtXBee::XBeeResponse
 XBeeResponse (QObject *parent=0)
 XBeeResponse's constructor. More...
 
 ~XBeeResponse ()
 XBeeResponse's destructor.
 
void setData (const QByteArray &data)
 Sets the response's data. More...
 
QByteArray data () const
 Returns the response's data. More...
 
- Public Member Functions inherited from QtXBee::XBeePacket
 XBeePacket (QObject *parent=0)
 XBeePacket's constructor. More...
 
void setStartDelimiter (unsigned sd)
 Sets the frame's start delimiter. By default the start delemiter is set to 0x7E. More...
 
void setLength (unsigned length)
 Sets the frame's length. More...
 
void setFrameType (ApiId type)
 Sets the frame's type. More...
 
void setFrameId (quint8 id)
 Sets the frame's id. More...
 
void setChecksum (unsigned cs)
 Sets the checksum. More...
 
bool setPacket (const QByteArray &packet)
 Sets the packet's raw data. More...
 
QByteArray packet () const
 Returns the frame's packet (raw data) More...
 
unsigned startDelimiter () const
 Returns the frame's start delimiter. More...
 
quint16 length () const
 Returns the frame-specific data length (Number of bytes between the length and the checksum) More...
 
ApiId frameType () const
 Returns the frame's type. More...
 
quint8 frameId () const
 Returns the frame's id. More...
 
unsigned checksum () const
 Returns the packet's checksum. More...
 
virtual void assemblePacket ()
 Assembles the packet to be able to send it. More...
 
void escapePacket ()
 
bool unescapePacket ()
 

Protected Attributes

qint8 m_rssi
 
quint8 m_options
 
- Protected Attributes inherited from QtXBee::XBeeResponse
QByteArray m_data
 
- Protected Attributes inherited from QtXBee::XBeePacket
QByteArray m_packet
 

Additional Inherited Members

- Public Types inherited from QtXBee::XBeePacket
enum  ApiId {
  TxRequest64Id = 0x00, TxRequest16Id = 0x01, ATCommandId = 0x08, ATCommandQueueId = 0x09,
  ZBTxRequestId = 0x10, ZBExplicitTxRequestId = 0x11, RemoteATCommandRequestId = 0x17, CreateSourceRouteId = 0x21,
  ZBRegisterJoiningDeviceId = 0x24, Rx64ResponseId = 0x80, Rx16ResponseId = 0x81, Rx64IOResponseId = 0x82,
  Rx16IOResponseId = 0x83, ATCommandResponseId = 0x88, TxStatusResponseId = 0x89, ModemStatusResponseId = 0x8A,
  ZBTxStatusResponseId = 0x8B, ZBRxResponseId = 0x90, ZBExplicitRxResponseId = 0x91, ZBIOSampleResponseId = 0x92,
  XBeeSensorReadIndicatorId = 0x94, ZBIONodeIdentificationId = 0x95, RemoteATCommandResponseId = 0x97, OverTheAirFirmwareUpdateId = 0xA0,
  RouteRecordIndicatorId = 0xA1, DeviceAuthenticatedIndicatorId = 0xA2, ManyToOneRouteRequestId = 0xA3, RegisterJoiningDeviceStatusId = 0xA4,
  JoinNotificationStatusId = 0xA5, UndefinedId = 0xFF
}
 The ApiId enum identifies sent/received frame's type. More...
 
enum  SpecialByte { StartDelimiter = 0x7E, Escape = 0x7D, XON = 0x11, XOFF = 0x13 }
 The SpecialByte enum defines the special bytes. More...
 
- Static Public Member Functions inherited from QtXBee::XBeePacket
static QString frameTypeToString (const ApiId type)
 Returns the given frame type ApiId into a human readable string. More...
 
- Protected Member Functions inherited from QtXBee::XBeePacket
virtual bool parseApiSpecificData (const QByteArray &data)
 Parses the packet API specific data. More...
 
void createChecksum (QByteArray array)
 Computes the checksum of the given QByteArray, and set it. More...
 

Detailed Description

The RxBaseResponse class is the base to implement a Wpan Response.

Todo:
Handle options

Member Function Documentation

void QtXBee::Wpan::RxBaseResponse::clear ( )
virtual

Clears the packet by reseting all attributes to their default value.

Note
All subclass should reimplement this method.

Reimplemented from QtXBee::XBeeResponse.

Reimplemented in QtXBee::Wpan::RxResponseIoSampleBase, QtXBee::Wpan::RxResponse16, and QtXBee::Wpan::RxResponse64.

qint8 QtXBee::Wpan::RxBaseResponse::rssi ( ) const

Returns the RSSI (Received Signal Strength Indication)

Returns
the RSSI (Received Signal Strength Indication)
See Also
RxBaseResponse::setRSSI()
void QtXBee::Wpan::RxBaseResponse::setRSSI ( const qint8  rssi)

Sets the RSSI (Received Signal Strength Indication)

Parameters
rssi
See Also
RxBaseResponse::rssi()
QString QtXBee::Wpan::RxBaseResponse::toString ( )
virtual

Returns a debug string containing all packet's informations.

Returns
a debug string containing all packet's informations.

Reimplemented from QtXBee::XBeePacket.

Reimplemented in QtXBee::Wpan::RxResponseIoSampleBase, QtXBee::Wpan::RxResponse16, and QtXBee::Wpan::RxResponse64.


The documentation for this class was generated from the following files:
  • /home/thomas/Projects/QtXBee/src/qtxb/wpan/rxbaseresponse.h
  • /home/thomas/Projects/QtXBee/src/qtxb/wpan/rxbaseresponse.cpp