SyncNetworkInfo
SyncNetworkInfo

Contains network information for a WirelessNode that has been added to the Sync Sampling Network.

Types
NodeStatus

The status of an individual node.

status_OK  = 0

The node successfully fits in the network.

status_PoorCommunication  = 1

The node failed to communicate.

status_DoesNotFit  = 2

The node is out of the network, as the bandwidth does not allow it.

status_Contention  = 3

The node is out of the network, as network contention does not allow it.

Functions
SyncNetworkInfo
SyncNetworkInfo(
WirelessNode &node
)

Creates a SyncNetworkInfo object

Parameters
wirelessNode

The WirelessNode that this SyncNetworkInfo will belong to.

Variables
m_node
WirelessNode m_node

The WirelessNode that this info belongs to

m_nodeAddress
NodeAddress m_nodeAddress

The NodeAddress of the Node that this info belongs to.

m_model
WirelessModels::NodeModel m_model

The WirelessModels::NodeModel of the Node that this info belongs to.

m_percentBandwidth
float m_percentBandwidth

The standard percent of bandwidth that this node takes up

m_percentBandwidth_optimized
float m_percentBandwidth_optimized

The space-optimized percent of bandwidth that this node takes up

m_tdmaAddress
uint32 m_tdmaAddress

The TDMA address that was found for this node

m_slotSize
uint16 m_slotSize

The number of individual slots that the node takes up per transmission

m_maxTdmaAddress
uint32 m_maxTdmaAddress

The maximum TDMA address that can be assigned for the node

m_txPerGroup
uint32 m_txPerGroup

The number of transmissions per group

m_groupSize
uint32 m_groupSize

The size of the group

m_maxRetxPerBurst
uint32 m_maxRetxPerBurst

The number of maximum retransmissions per burst (if burst)

m_status
NodeStatus m_status

The status of the node

m_syncSamplingVersion
uint8 m_syncSamplingVersion

The version of the Sync Sampling formulas to use.

m_optimized
bool m_optimized

Whether or not this node has attempted optimization

m_configApplied
bool m_configApplied

Whether or not the configuration has been applied for this node

m_startedSampling
bool m_startedSampling

Whether or not the Node has been send the Start Sync Sampling command.

m_hasPendingConfig
bool m_hasPendingConfig

Whether or not there is a "pending" configuration set for this Node.

m_pendingConfig
WirelessNodeConfig m_pendingConfig

A WirelessNodeConfig set to be used in all sync network calculations, without actually being applied to the Node.

Functions
status
NodeStatus status() const

Gets the node's network status.

Returns

The NodeStatus of the node.

configurationApplied
bool configurationApplied() const

Gets whether or not the network configuration has been successfully applied to this node.

Returns

true if the network configuration has been successfully applied, false otherwise.

percentBandwidth
float percentBandwidth() const

Gets the node's individual percent of bandwidth in the network.

Returns

The node's individual percent of bandwidth.

tdmaAddress
uint32 tdmaAddress() const

Gets the TDMA address that was found and assigned to the node.

Returns

The TDMA address that was assigned to the node.

maxTdmaAddress
uint32 maxTdmaAddress() const

Gets the maximum TDMA address that can be assigned to this node. (Advanced)

Returns

The maximum TDMA address allowed for this node in its current configuration.

transmissionsPerGroup

Gets the number of transmissions per group for this node. (Advanced)

Returns

The number of transmissions per group for this node.

groupSize
uint32 groupSize() const

Gets the group size for this node. (Advanced)

Returns

The group size for this node.

syncSamplingVersion
uint8 syncSamplingVersion() const

The version of the Sync Sampling formulas to use.

hasPendingConfig
bool hasPendingConfig() const

Gets whether or not this network info has a pending configuration set.

Returns

true if a pending config has been set, false otherwise

setPendingConfig
void setPendingConfig(
const WirelessNodeConfig &config
)

Sets a pending configuration for the Node in this network info.  This is a configuration that is not actually applied to the Node, but should be used in all sync network calculations.

Parameters
config

The WirelessNodeConfig to set for the Node.

Exceptions
getPendingConfig
const WirelessNodeConfig& getPendingConfig() const

Gets the current pending configuration that is set.

Returns

The WirelessNodeConfig pointer that is currently set.

clearPendingConfig
void clearPendingConfig()

Clears any pending config that is currently set.