com.lisnr.radius.Tone Class Reference

Represents a LISNR Radius Tone. More...

Inheritance diagram for com.lisnr.radius.Tone:

Public Member Functions
	Tone (byte[] payload)
byte[]	getData ()
double	getSnrDb ()
double	getHeaderEvmDb ()
double	getPayloadEvmDb ()
	Tone (Parcel src)
int	describeContents ()
void	writeToParcel (Parcel parcel, int flags)

Detailed Description

Represents a LISNR Radius Tone.

Constructor & Destructor Documentation

Tone() [1/2]

com.lisnr.radius.Tone.Tone ( byte[]  payload )

inline

Creates a new Tone object with the given payload.

Parameters

payload

payload to use for this Tone

Tone() [2/2]

com.lisnr.radius.Tone.Tone ( Parcel  src )

inline

Creates a new Tone object from parcel data.

Parameters

src	parcel data used to create the new Tone

Member Function Documentation

describeContents()

int com.lisnr.radius.Tone.describeContents ( )

inline

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Returns

a bitmask indicating the set of special object types marshaled by this Parcelable object instance. May be 0 or CONTENTS_FILE_DESCRIPTOR.

getData()

byte[] com.lisnr.radius.Tone.getData ( )

inline

Returns the data that was attached to this Tone.

Returns

byte array of data

getHeaderEvmDb()

double com.lisnr.radius.Tone.getHeaderEvmDb ( )

inline

Returns error vector magnitude of the header of this Tone.

Returns

raw header EVM value in dB

Note

This is only valid for Tone objects received using the com.lisnr.radius.Radius.PROFILE_PKAB2 or com.lisnr.radius.Radius.PROFILE_PKAB2_WIDEBAND profile. It will return 0 on any other Tone.

getPayloadEvmDb()

double com.lisnr.radius.Tone.getPayloadEvmDb ( )

inline

Returns the error vector magnitude of the payload this Tone.

Returns

raw payload EVM value in dB

Note

This is only valid for Tone objects received using the com.lisnr.radius.Radius.PROFILE_PKAB2 or com.lisnr.radius.Radius.PROFILE_PKAB2_WIDEBAND profile. It will return 0 on any other Tone.

getSnrDb()

double com.lisnr.radius.Tone.getSnrDb ( )

inline

Returns the signal to noise ratio value of this Tone.

Returns

raw SNR value in dB

Note

This is only valid for Tone objects received using the com.lisnr.radius.Radius.PROFILE_PKAB2, com.lisnr.radius.Radius.PROFILE_PKAB2_WIDEBAND or com.lisnr.radius.Radius.PROFILE_STANDARD2 profiles. It will return 0 on any other Tone.

writeToParcel()

void com.lisnr.radius.Tone.writeToParcel ( Parcel  parcel, int  flags  )

inline

Flattens the Tone to a parcel.

Parameters

parcel	parcel to be written to
flags	additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

---

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

• src/main/java/com/lisnr/radius/Tone.java