DataSweep
DataSweep

Represents 1 data sweep, including data for each channel, a timestamp, and a sample rate

Types
SamplingType
samplingType_NonSync

0 - NonSynchronized sampling type

samplingType_NonSync_Buffered

1 - Buffered NonSynchronized sampling type

samplingType_SyncSampling

2 - Synchronized Sampling sampling type

samplingType_SyncSampling_Burst

3 - Synchronized Sampling Burst sampling type

samplingType_AsyncDigital

4 - Asynchronous Digital sampling type

samplingType_AsyncDigitalAnalog

5 - Asynchronous Digital + Analog sampling type

samplingType_SHM

6 - Structural Health Monitoring type

samplingType_BeaconEcho

7 - Beacon Echo

samplingType_RfSweep

8 - RF Scan Sweep

Functions
DataSweep
DataSweep()

Creates a default constructed DataSweep.

Variables
m_timestamp
Timestamp m_timestamp

The Timestamp of the data sweep.

m_tick
uint32 m_tick

The tick value that was contained in the packet (increments for each sweep)

m_sampleRate
SampleRate m_sampleRate

The SampleRate that was contained in the packet

m_nodeAddress
NodeAddress m_nodeAddress

The node address that was contained in the packet (identifies the node this packet came from)

m_data
ChannelData m_data

Contains one or more WirelessDataPoints, corresponding to each channel's data for this sweep

m_samplingMode
SamplingType m_samplingMode

The SamplingType that identifies the sampling mode for this data sweep

m_baseRssi
int16 m_baseRssi

The Base Station RSSI that identifies the received signal strength at the Base Station

m_frequency
WirelessTypes::Frequency m_frequency

The WirelessTypes::Frequency representing the radio frequency that this DataSweep was collected on

Functions
timestamp
Timestamp timestamp() const

Gets the timestamp of the sweep as a Timestamp

Returns

A Timestamp representing the timestamp of the sweep

nanoseconds
uint64 nanoseconds() const

Gets the timestamp of the sweep in nanoseconds since UTC

Returns

The timestamp of the sweep in nanoseconds since UTC

tick
uint32 tick() const

Gets the tick value of the sweep

Returns

The tick value of the sweep

sampleRate
SampleRate sampleRate() const

Gets the sample rate of the sweep as a SampleRate

Returns

A SampleRate representing the sample rate of the sweep

nodeAddress
NodeAddress nodeAddress() const

Gets the node address that this sweep is associated with

Returns

The node address this sweep is associated with

data
const ChannelData& data() const

Gets the channel data in this sweep as a WirelessDataPoint::ChannelData container.

Returns

A WirelessDataPoint::ChannelData container holding the data for the sweep.

samplingType
SamplingType samplingType() const

Gets the SamplingType for this sweep

Returns

A SamplingType enum representing the sampling type of this sweep

nodeRssi
int16 nodeRssi() const

Gets the Node RSSI value that identifies the received signal strength at the Node

Returns

The Node RSSI value that identifies the received signal strength at the Node

baseRssi
int16 baseRssi() const

Gets the Base Station RSSI value that identifies the received signal strength at the BaseStation for this sweep

Returns

The Base Station RSSI value that identifies the received signal strength at the Base Station for this sweep

frequency
WirelessTypes::Frequency frequency() const

Gets the radio frequency that this DataSweep was collected on

Returns

A WirelessTypes::Frequency representing the radio frequency that this DataSweep was collected on

timestamp
void timestamp(
const Timestamp &time
)

Sets the timestamp of the sweep

Parameters
time
const Timestamp&

The Timestamp to set

tick
void tick(
uint32 tick
)

Sets the tick of the sweep

Parameters
tick
uint32

The tick to set

sampleRate
void sampleRate(
SampleRate rate
)

Sets the sample rate of the sweep

Parameters
rate

The SampleRate to set

nodeAddress
void nodeAddress(
NodeAddress address
)

Sets the node address of the sweep

Parameters
address

The node address to set

data
void data(
ChannelData data
)

Sets the data of the sweep

Parameters
data
ChannelData

The <ChannelData> to set

samplingMode

Sets the sampling mode of the sweep

Parameters
mode

The SamplingType to set

nodeRssi
void nodeRssi(
int16 rssi
)

Sets the Node RSSI value that identifies the received signal strength at the Node

Parameters
rssi
int16

The Node RSSI to set

baseRssi
void baseRssi(
int16 rssi
)

Sets the Base Station RSSI value that identifies the received signal strength at the Base Station for this sweep

Parameters
rssi
int16

The Base Station RSSI to set

frequency
void frequency(
WirelessTypes::Frequency freq
)

Sets the radio frequency that this DataSweep was collected on

Parameters
freq

The WirelessTypes::Frequency that this DataSweep was collected on

Types
DataSweeps

Typedef for a vector of DataSweep objects.