Contains information on which features are supported by a WirelessNode.
NodeFeatures( |
| ) |
Creates a NodeFeatures object.
info const NodeInfo& | A NodeInfo object representing standard information of the WirelessNode. |
The NodeInfo object containing basic information retreived from eeprom about the Node.
Contains all of the supported channels for this Node..
Contains all of the ChannelGroups that are supported by this Node.
static std::unique_ptr<NodeFeatures> create( |
| ) |
Builds and returns a NodeFeatures pointer based on the given parameters.
info const NodeInfo& | A NodeInfo object representing standard information of the WirelessNode. |
A NodeFeatures unique_ptr.
Error_NotSupported: The Node model is not supported by MSCL.
void addCalCoeffChannelGroup( |
| ) |
Adds a cal coefficient (Linear Equation, unit, equation type) to the channel groups for the specified channel.
static WirelessTypes::SettlingTime maxFilterSettlingTime_A( |
| ) |
Gets the max filter settling time allowed by the given SampleRate. This is version A of this function. Different nodes use different versions.
static WirelessTypes::SettlingTime maxFilterSettlingTime_B( |
| ) |
Gets the max filter settling time allowed by the given SampleRate. This is version B of this function. Different nodes use different versions.
uint32 normalizeNumSweeps( |
| ) const |
Normalizes the number of sweeps so that it is within range and a multiple of 100 (rounds up to next multiple).
sweeps uint32 | the value to normalize. This will be updated to hold the normalized result. |
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.
time const TimeSpan& | TimeSpan to normalize. This will be updated to hold the normalized result. |
const EepromLocation& findEeprom( |
| ) const |
Finds the EepromLocation for the provided setting and channel mask pair.
setting | The WirelessTypes::ChannelGroupSetting to search for. |
mask const ChannelMask& | The ChannelMask of the setting to search for. |
The EepromLocation for the found option.
Error_NotSupported: The WirelessTypes::ChannelGroupSetting or ChannelMask is not supported.
bool anyChannelGroupSupports( |
| ) const |
Checks if any channel group on the Node supports the given WirelessTypes::ChannelGroupSetting.
setting | The WirelessTypes::ChannelGroupSetting to check if any channel group supports. |
true if at least 1 channel group supports the setting, false otherwise.
bool anyChannelGroupSupports( |
| ) const |
Checks if any channel group, with the specified channel number, supports the given WirelessTypes::ChannelGroupSetting.
setting | The WirelessTypes::ChannelGroupSetting to check if any channel group supports. |
channelNumber uint8 | The channel number (ch1 = 1, ch8 = 8) to check if it is in the mask for the found setting. |
true if at least 1 channel group, containing the specified channel number, supports the setting, false otherwise.
Gets a reference to the WirelessChannels of this Node.
A reference to the WirelessChannels of this Node.
Gets the ChannelGroups supported by this Node.
A ChannelGroups container containing each group supported by this Node.
bool supportsChannelSetting( |
| ) const |
Checks if the Node supports a given WirelessTypes::ChannelGroupSetting for the given ChannelMask.
setting | The WirelessTypes::ChannelGroupSetting to check for. |
mask const ChannelMask& | The ChannelMask to check if the setting is supported for. |
true if the WirelessTypes::ChannelGroupSetting is supported for the ChannelMask, false otherwise.
Checks if the Node supports Hardware Gain for any of its ChannelGroups.
true if the Node supports Hardware Gain for at least one ChannelGroup, false otherwise.
Checks if the Node supports Hardware Offset for any of its ChannelGroups.
true if the Node supports Hardware Offset for at least one ChannelGroup, false otherwise.
Checks if the Node supports Gauge Factor for any of its ChannelGroups.
true if the Node support Gauge Factor for at least on ChannelGroup, false otherwise.
Checks if the Node supports the Lost Beacon Timeout option.
true if the Node supports Lost Beacon Timeout, false otherwise.
Checks if the Node supports Filter Settling Time for any of its ChannelGroups.
true if the Node supports Filter Settling Time for at least one ChannelGroup, false otherwise.
Checks if the Node supports the Thermocouple Type for any of its ChannelGroups.
true if the Node supports Thermocouple Type for at least one ChannelGroup, false otherwise.
Checks if the Node supports FatigueOptions configuration.
true if the Node supports FatigueOptions, false otherwise.
Checks if the Node supports Young's Modulus (part of FatigueOptions) configuration.
true if the Node supports Young's Modulus configuration, false otherwise.
Checks if the Node supports Poisson's Ratio (part of FatigueOptions) configuration.
true if the Node supports Poisson's Ratio configuration, false otherwise.
Checks if the Node supports enabling Debug Mode (part of FatigueOptions) configuration.
true if the Node supports Debug Mode configuration, false otherwise.
Checks if the Node supports Fatigue Mode (part of FatigueOptions) configuration.
true if the Node supports Fatigue Mode configuration, false otherwise.
Checks if the Node supports HistogramOptions configuration.
true if the Node supports HistogramOptions, false otherwise.
Checks if the Node supports Histogram transmit rate (part of HistogramOptions) configuration.
true if the Node supports Histogram transmit rate configuration, false otherwise.
Checks if the Node supports turning Histograms on and off (part of FatigueOptions).
true if the Node supports turning Histograms on and off, false otherwise.
Checks if the Node supports the ActivitySense feature.
true if the Node supports ActivitySense and can be configured for it.
Checks if the Node supports the Auto Balance command for any of its ChannelGroups.
true if the Node supports Auto Balance for at least 1 ChannelGroup, false otherwise.
Checks if the Node supports the AutoCal commands.
true if the Node supports an AutoCal command, false otherwise.
Checks if the Node supports setting a limited duration of sampling.
true if the Node supported limited duration, false if the Node only supports unlimited sampling.
bool supportsChannel( |
| ) const |
Checks if a specific channel is supported (can be enabled) by this Node.
channelNumber uint8 | The channel to check if it is supported. |
true if the channel is supported, false otherwise.
bool supportsSamplingMode( |
| ) const |
Checks if a WirelessTypes::SamplingMode is supported by this Node.
samplingMode | The WirelessTypes::SamplingMode to check if supported. |
true if the sampling mode is supported, false otherwise.
bool supportsSampleRate( |
| ) const |
Checks if a sample rate is supported by the Node for the given WirelessTypes::SamplingMode.
sampleRate | The WirelessTypes::WirelessSampleRate to check if supported. |
samplingMode | The WirelessTypes::SamplingMode to check if the sample rate is supported for. |
true if the sample rate is supported for the given sampling mode, false otherwise.
bool supportsDataFormat( |
| ) const |
Checks if a WirelessTypes::DataFormat is supported by this Node.
dataFormat | The WirelessTypes::DataFormat to check if supported. |
true if the data format is supported, false otherwise.
bool supportsDefaultMode( |
| ) const |
Checks if a WirelessTypes::DefaultMode is supported by this Node.
mode | The WirelessTypes::DefaultMode to check if supported. |
true if the default is supported, false otherwise.
bool supportsDataCollectionMethod( |
| ) const |
Checks if a WirelessTypes::DataCollectionMethod is supported by this Node.
collectionMethod | The WirelessTypes::DataCollectionMethod to check if supported. |
true if the data collection method is supported, false otherwise.
bool supportsTransmitPower( |
| ) const |
Checks if a WirelessTypes::TransmitPower is supported by this Node.
power | The WirelessTypes::TransmitPower to check if supported. |
true if the transmit power is supported, false otherwise.
bool supportsFatigueMode( |
| ) const |
Checks if a WirelessTypes::FatigueMode is supported by this Node.
mode | The WirelessTypes::FatigueMode to check if supported. |
true if the fatigue mode is supported, false otherwise.
virtual WirelessTypes::WirelessSampleRate maxSampleRate( |
| ) const |
Gets the maximum SampleRate value that is supported by this Node with the given <SamplingMode> and ChannelMask.
samplingMode | The WirelessTypes::SamplingMode to check the max sample rate for. |
channels const ChannelMask& | The ChannelMask to check the max sample rate for. |
The max WirelessTypes::WirelessSampleRate that is supported by this Node with the given WirelessTypes::SamplingMode and ChannelMask.
virtual WirelessTypes::SettlingTime maxFilterSettlingTime( |
| ) const |
Gets the maximum WirelessTypes::SettlingTime available for the given SampleRate.
rate const SampleRate& | The SampleRate to check the max filter settling time for. |
The max WirelessTypes::SettlingTime available.
Error_NotSupported: The Filter Settling Time feature is not supported by this Node.
Gets the minimum inactivity timeout (in seconds) that is supported.
The min inactivity timeout in seconds.
Gets the minimum lost beacon timeout (in minutes) that is supported. Note: A value of 0 disable the lost beacon timeout.
The min lost beacon timeout in minutes.
Gets the maximum lost beacon timeout (in minutes) that is supported.
The max lost beacon timeout in minutes.
Gets the minimum check radio interval (in seconds) that is supported.
The min check radio interval in seconds.
Gets the maximum check radio interval (in seconds) that is supported.
The maximum check radio interval in seconds.
Gets the minimum number of sweeps that can be assigned for the duration of a continuous sampling session.
The minimum number of sweeps for a sampling session.
uint32 maxSweeps( |
| ) 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.
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. |
The maximum number of sweeps, or sweeps per burst, for a sampling session.
uint32 maxSweeps( |
| ) const |
Gets the maximum number of sweeps that can be assigned for the duration of a continuous sampling session.
dataFormat | The WirelessTypes::DataFormat of the sampling session. |
numChannels | The number of active channels for the sampling session. |
The maximum number of sweeps for a sampling session.
virtual uint32 maxSweepsPerBurst( |
| ) const |
Gets the maximum number of sweeps per burst that can be assigned for a Burst Sync Sampling session.
dataFormat | The WirelessTypes::DataFormat of the sampling session. |
numChannels | The number of active channels for the sampling session. |
The maximum number of sweeps per burst for a Burst Sync Sampling session.
TimeSpan minTimeBetweenBursts( |
| ) const |
Gets the minimum time that can be assigned for a Burst Sync Sampling session.
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. |
A TimeSpan representing the minimum time that can be assigned for a Burst Sync Sampling session.
Gets the minimum hardware gain value that is supported.
Error_NotSupported: The hardware gain feature is not supported by this Node.
Gets the maximum hardware gain value that is supported.
Error_NotSupported: The hardware gain feature is not supported by this Node.
double normalizeHardwareGain( |
| ) const |
Normalizes the hardware gain value so that it is within an acceptable range.
gain double | The hardware gain to be normalized. |
The normalized hardware gain value that can be stored on the Node.
Error_NotSupported: The hardware gain feature is not supported by this Node.
Gets the number of damage angles (see FatigueOptions) on this Node.
The number of damage angles on this Node.
Gets the number of Sn Curve segments (see FatigueOptions) on this Node.
The number of Sn Curve segments on this Node.
Gets a list of the WirelessTypes::DefaultModes that are supported by this Node.
A vector of WirelessTypes::DefaultModes that are supported by this Node.
Gets a list of the WirelessTypes::DataCollectionMethods that are supported by this Node.
A vector of WirelessTypes::DataCollectionMethods that are supported by this Node.
Gets a list of the WirelessTypes::DataFormats that are supported by this Node.
A vector of WirelessTypes::DataFormats that are supported by this Node.
Gets a list of the WirelessTypes::SamplingModes that are supported by this Node.
A vector of WirelessTypes::SamplingModes that are supported by this Node.
virtual const WirelessTypes::WirelessSampleRates sampleRates( |
| ) const |
Gets a list of the WirelessTypes::WirelessSampleRates that are supported by this Node for the given sampling mode.
samplingMode | The WirelessTypes::SamplingMode to get the sample rates for. |
A vector of WirelessTypes::WirelessSampleRates that are supported by this Node for the given sampling mode.
Error: The WirelessTypes::SamplingMode is not supported by this Node.
Gets a list of the WirelessTypes::TransmitPowers that are supported by this Node.
A vector of WirelessTypes::TransmitPowers that are supported by this Node.
Gets a list of the Histogram Transmit Rates that are supported by this Node.
A vector of WirelessTypes::WirelessSampleRates representing the Histogram Transmit Rates that are supported by this Node.
Gets a list of the WirelessTypes::FatigueModes that are supported by this Node.
A vector of WirelessTypes::FatigueModes supported by the Node.
Checks if the Node supports the new transmit powers (true), or the old ones (false).
Checks if the Node supports the AutoBalance (Version 2) command.
Checks if the Node supports a sleep interval eeprom directly in seconds.
Checks if eeprom changes can be committed by only cycling the radio, instead of cycling power.