NodeFeatures
NodeFeatures

Contains information on which features are supported by a WirelessNode.

normalizeNumSweeps
uint32 normalizeNumSweeps(
uint32 sweeps
) const

Normalizes the number of sweeps so that it is within range and a multiple of 100 (rounds up to next multiple).

Parameters
sweeps
uint32

the value to normalize. This will be updated to hold the normalized result.

normalizeTimeBetweenBursts
TimeSpan normalizeTimeBetweenBursts(
const TimeSpan &time
) const

Normalizes a TimeSpan so that it is within an acceptable range for setting the timeBetweenBursts.  A valid range is between 1 second and 24 hours. Seconds above 32767 will be rounded to minutes.  When setting the time between bursts, you should also call minTimeBetweenBursts and verify it is greater than this.

Parameters
time
const TimeSpan&

TimeSpan to normalize. This will be updated to hold the normalized result.

channels
const WirelessChannels& channels() const

Gets a reference to the WirelessChannels of this Node.

Returns

A reference to the WirelessChannels of this Node.

channelGroups
ChannelGroups channelGroups() const

Gets the ChannelGroups supported by this Node.

Returns

A ChannelGroups container containing each group supported by this Node.

supportsChannelSetting
bool supportsChannelSetting(
WirelessTypes::ChannelGroupSetting setting,
const ChannelMask &mask
) const

Checks if the Node supports a given WirelessTypes::ChannelGroupSetting for the given ChannelMask.

Parameters
setting

The WirelessTypes::ChannelGroupSetting to check for.

mask

The ChannelMask to check if the setting is supported for.

Returns

true if the WirelessTypes::ChannelGroupSetting is supported for the ChannelMask, false otherwise.

supportsHardwareGain
bool supportsHardwareGain() const

Checks if the Node supports Hardware Gain for any of its ChannelGroups.

Returns

true if the Node supports Hardware Gain for at least one ChannelGroup, false otherwise.

supportsHardwareOffset
bool supportsHardwareOffset() const

Checks if the Node supports Hardware Offset for any of its ChannelGroups.

Returns

true if the Node supports Hardware Offset for at least one ChannelGroup, false otherwise.

supportsGaugeFactor
bool supportsGaugeFactor() const

Checks if the Node supports Gauge Factor for any of its ChannelGroups.

Returns

true if the Node support Gauge Factor for at least on ChannelGroup, false otherwise.

supportsLostBeaconTimeout
virtual bool supportsLostBeaconTimeout() const

Checks if the Node supports the Lost Beacon Timeout option.

Returns

true if the Node supports Lost Beacon Timeout, false otherwise.

supportsFilterSettlingTime
bool supportsFilterSettlingTime() const

Checks if the Node supports Filter Settling Time for any of its ChannelGroups.

Returns

true if the Node supports Filter Settling Time for at least one ChannelGroup, false otherwise.

supportsThermocoupleType
virtual bool supportsThermocoupleType() const

Checks if the Node supports the Thermocouple Type for any of its ChannelGroups.

Returns

true if the Node supports Thermocouple Type for at least one ChannelGroup, false otherwise.

supportsFatigueConfig
virtual bool supportsFatigueConfig() const

Checks if the Node supports FatigueOptions configuration.

Returns

true if the Node supports FatigueOptions, false otherwise.

supportsYoungsModConfig
virtual bool supportsYoungsModConfig() const

Checks if the Node supports Young's Modulus (part of FatigueOptions) configuration.

Returns

true if the Node supports Young's Modulus configuration, false otherwise.

supportsPoissonsRatioConfig
virtual bool supportsPoissonsRatioConfig() const

Checks if the Node supports Poisson's Ratio (part of FatigueOptions) configuration.

Returns

true if the Node supports Poisson's Ratio configuration, false otherwise.

supportsFatigueDebugModeConfig
virtual bool supportsFatigueDebugModeConfig() const

Checks if the Node supports enabling Debug Mode (part of FatigueOptions) configuration.

Returns

true if the Node supports Debug Mode configuration, false otherwise.

supportsFatigueModeConfig
virtual bool supportsFatigueModeConfig() const

Checks if the Node supports Fatigue Mode (part of FatigueOptions) configuration.

Returns

true if the Node supports Fatigue Mode configuration, false otherwise.

supportsHistogramConfig
virtual bool supportsHistogramConfig() const

Checks if the Node supports HistogramOptions configuration.

Returns

true if the Node supports HistogramOptions, false otherwise.

supportsHistogramRateConfig
virtual bool supportsHistogramRateConfig() const

Checks if the Node supports Histogram transmit rate (part of HistogramOptions) configuration.

Returns

true if the Node supports Histogram transmit rate configuration, false otherwise.

supportsHistogramEnableConfig
virtual bool supportsHistogramEnableConfig() const

Checks if the Node supports turning Histograms on and off (part of FatigueOptions).

Returns

true if the Node supports turning Histograms on and off, false otherwise.

supportsActivitySense
virtual bool supportsActivitySense() const

Checks if the Node supports the ActivitySense feature.

Returns

true if the Node supports ActivitySense and can be configured for it.

supportsAutoBalance
virtual bool supportsAutoBalance() const

Checks if the Node supports the Auto Balance command for any of its ChannelGroups.

Returns

true if the Node supports Auto Balance for at least 1 ChannelGroup, false otherwise.

supportsAutoCal
virtual bool supportsAutoCal() const

Checks if the Node supports the AutoCal commands.

Returns

true if the Node supports an AutoCal command, false otherwise.

supportsLimitedDuration
virtual bool supportsLimitedDuration() const

Checks if the Node supports setting a limited duration of sampling.

Returns

true if the Node supported limited duration, false if the Node only supports unlimited sampling.

supportsChannel
bool supportsChannel(
uint8 channelNumber
) const

Checks if a specific channel is supported (can be enabled) by this Node.

Parameters
channelNumber
uint8

The channel to check if it is supported.

Returns

true if the channel is supported, false otherwise.

supportsSamplingMode
bool supportsSamplingMode(
WirelessTypes::SamplingMode samplingMode
) const

Checks if a WirelessTypes::SamplingMode is supported by this Node.

Parameters
samplingMode

The WirelessTypes::SamplingMode to check if supported.

Returns

true if the sampling mode is supported, false otherwise.

supportsSampleRate
bool supportsSampleRate(
WirelessTypes::WirelessSampleRate sampleRate,
WirelessTypes::SamplingMode samplingMode
) const

Checks if a sample rate is supported by the Node for the given WirelessTypes::SamplingMode.

Parameters
sampleRate

The WirelessTypes::WirelessSampleRate to check if supported.

samplingMode

The WirelessTypes::SamplingMode to check if the sample rate is supported for.

Returns

true if the sample rate is supported for the given sampling mode, false otherwise.

supportsDataFormat
bool supportsDataFormat(
WirelessTypes::DataFormat dataFormat
) const

Checks if a WirelessTypes::DataFormat is supported by this Node.

Parameters
dataFormat

The WirelessTypes::DataFormat to check if supported.

Returns

true if the data format is supported, false otherwise.

supportsDefaultMode
bool supportsDefaultMode(
WirelessTypes::DefaultMode mode
) const

Checks if a WirelessTypes::DefaultMode is supported by this Node.

Parameters
mode

The WirelessTypes::DefaultMode to check if supported.

Returns

true if the default is supported, false otherwise.

supportsDataCollectionMethod
bool supportsDataCollectionMethod(
WirelessTypes::DataCollectionMethod collectionMethod
) const

Checks if a WirelessTypes::DataCollectionMethod is supported by this Node.

Parameters
collectionMethod

The WirelessTypes::DataCollectionMethod to check if supported.

Returns

true if the data collection method is supported, false otherwise.

supportsTransmitPower
bool supportsTransmitPower(
WirelessTypes::TransmitPower power
) const

Checks if a WirelessTypes::TransmitPower is supported by this Node.

Parameters
power

The WirelessTypes::TransmitPower to check if supported.

Returns

true if the transmit power is supported, false otherwise.

supportsFatigueMode
bool supportsFatigueMode(
WirelessTypes::FatigueMode mode
) const

Checks if a WirelessTypes::FatigueMode is supported by this Node.

Parameters
mode

The WirelessTypes::FatigueMode to check if supported.

Returns

true if the fatigue mode is supported, false otherwise.

maxSampleRate
virtual WirelessTypes::WirelessSampleRate maxSampleRate(
WirelessTypes::SamplingMode samplingMode,
const ChannelMask &channels
) const

Gets the maximum SampleRate value that is supported by this Node with the given <SamplingMode> and ChannelMask.

Parameters
samplingMode

The WirelessTypes::SamplingMode to check the max sample rate for.

channels

The ChannelMask to check the max sample rate for.

Returns

The max WirelessTypes::WirelessSampleRate that is supported by this Node with the given WirelessTypes::SamplingMode and ChannelMask.

maxFilterSettlingTime
virtual WirelessTypes::SettlingTime maxFilterSettlingTime(
const SampleRate &rate
) const

Gets the maximum WirelessTypes::SettlingTime available for the given SampleRate.

Parameters
rate
const SampleRate&

The SampleRate to check the max filter settling time for.

Returns

The max WirelessTypes::SettlingTime available.

Exceptions
minInactivityTimeout
uint16 minInactivityTimeout() const

Gets the minimum inactivity timeout (in seconds) that is supported.

Returns

The min inactivity timeout in seconds.

minLostBeaconTimeout
uint16 minLostBeaconTimeout() const

Gets the minimum lost beacon timeout (in minutes) that is supported.  Note: A value of 0 disable the lost beacon timeout.

Returns

The min lost beacon timeout in minutes.

maxLostBeaconTimeout
uint16 maxLostBeaconTimeout() const

Gets the maximum lost beacon timeout (in minutes) that is supported.

Returns

The max lost beacon timeout in minutes.

minCheckRadioInterval
uint8 minCheckRadioInterval() const

Gets the minimum check radio interval (in seconds) that is supported.

Returns

The min check radio interval in seconds.

maxCheckRadioInterval
uint8 maxCheckRadioInterval() const

Gets the maximum check radio interval (in seconds) that is supported.

Returns

The maximum check radio interval in seconds.

minSweeps
uint32 minSweeps() const

Gets the minimum number of sweeps that can be assigned for the duration of a continuous sampling session.

Returns

The minimum number of sweeps for a sampling session.

maxSweeps
uint32 maxSweeps(
WirelessTypes::SamplingMode samplingMode,
WirelessTypes::DataFormat dataFormat,
const ChannelMask &channels
) const

Gets the maximum number of sweeps that can be assigned for a given WirelessTypes::SamplingMode.  This is the duration of each burst if in Burst Sync Sampling mode, or the total duration of sampling in other sampling modes.

Parameters
samplingMode

The WirelessTypes::SamplingMode of the sampling session.

dataFormat

The WirelessTypes::DataFormat of the sampling session.

numChannels

The number of active channels for the sampling session.

Returns

The maximum number of sweeps, or sweeps per burst, for a sampling session.

maxSweeps
uint32 maxSweeps(
WirelessTypes::DataFormat dataFormat,
const ChannelMask &channels
) const

Gets the maximum number of sweeps that can be assigned for the duration of a continuous sampling session.

Parameters
dataFormat

The WirelessTypes::DataFormat of the sampling session.

numChannels

The number of active channels for the sampling session.

Returns

The maximum number of sweeps for a sampling session.

maxSweepsPerBurst
virtual uint32 maxSweepsPerBurst(
WirelessTypes::DataFormat dataFormat,
const ChannelMask &channels
) const

Gets the maximum number of sweeps per burst that can be assigned for a Burst Sync Sampling session.

Parameters
dataFormat

The WirelessTypes::DataFormat of the sampling session.

numChannels

The number of active channels for the sampling session.

Returns

The maximum number of sweeps per burst for a Burst Sync Sampling session.

minTimeBetweenBursts
TimeSpan minTimeBetweenBursts(
WirelessTypes::DataFormat dataFormat,
const ChannelMask &channels,
const SampleRate &sampleRate,
uint32 sweepsPerBurst
) const

Gets the minimum time that can be assigned for a Burst Sync Sampling session.

Parameters
dataFormat

The WirelessTypes::DataFormat of the sampling session.

numChannels

The number of active channels for the sampling session.

sampleRate
const SampleRate&

The SampleRate that for the sampling session.

sweepsPerBurst
uint32

The number of sweeps per burst for the sampling session.

Returns

A TimeSpan representing the minimum time that can be assigned for a Burst Sync Sampling session.

minHardwareGain
double minHardwareGain() const

Gets the minimum hardware gain value that is supported.

Exceptions
maxHardwareGain
double maxHardwareGain() const

Gets the maximum hardware gain value that is supported.

Exceptions
normalizeHardwareGain
double normalizeHardwareGain(
double gain
) const

Normalizes the hardware gain value so that it is within an acceptable range.

Parameters
gain
double

The hardware gain to be normalized.

Returns

The normalized hardware gain value that can be stored on the Node.

Exceptions
numDamageAngles
virtual uint8 numDamageAngles() const

Gets the number of damage angles (see FatigueOptions) on this Node.

Returns

The number of damage angles on this Node.

numSnCurveSegments
virtual uint8 numSnCurveSegments() const

Gets the number of Sn Curve segments (see FatigueOptions) on this Node.

Returns

The number of Sn Curve segments on this Node.

defaultModes
virtual const WirelessTypes::DefaultModes defaultModes() const

Gets a list of the WirelessTypes::DefaultModes that are supported by this Node.

Returns

A vector of WirelessTypes::DefaultModes that are supported by this Node.

dataCollectionMethods
virtual const WirelessTypes::DataCollectionMethods dataCollectionMethods() const

Gets a list of the WirelessTypes::DataCollectionMethods that are supported by this Node.

Returns

A vector of WirelessTypes::DataCollectionMethods that are supported by this Node.

dataFormats
virtual const WirelessTypes::DataFormats dataFormats() const

Gets a list of the WirelessTypes::DataFormats that are supported by this Node.

Returns

A vector of WirelessTypes::DataFormats that are supported by this Node.

samplingModes
virtual const WirelessTypes::SamplingModes samplingModes() const

Gets a list of the WirelessTypes::SamplingModes that are supported by this Node.

Returns

A vector of WirelessTypes::SamplingModes that are supported by this Node.

sampleRates
virtual const WirelessTypes::WirelessSampleRates sampleRates(
WirelessTypes::SamplingMode samplingMode
) const

Gets a list of the WirelessTypes::WirelessSampleRates that are supported by this Node for the given sampling mode.

Parameters
samplingMode

The WirelessTypes::SamplingMode to get the sample rates for.

Returns

A vector of WirelessTypes::WirelessSampleRates that are supported by this Node for the given sampling mode.

Exceptions
transmitPowers
virtual const WirelessTypes::TransmitPowers transmitPowers() const

Gets a list of the WirelessTypes::TransmitPowers that are supported by this Node.

Returns

A vector of WirelessTypes::TransmitPowers that are supported by this Node.

histogramTransmitRates
virtual const WirelessTypes::WirelessSampleRates histogramTransmitRates() const

Gets a list of the Histogram Transmit Rates that are supported by this Node.

Returns

A vector of WirelessTypes::WirelessSampleRates representing the Histogram Transmit Rates that are supported by this Node.

fatigueModes
virtual const WirelessTypes::FatigueModes fatigueModes() const

Gets a list of the WirelessTypes::FatigueModes that are supported by this Node.

Returns

A vector of WirelessTypes::FatigueModes supported by the Node.