WirelessNodeConfig
WirelessNodeConfig

Class used for setting the configuration of WirelessNode objects.  Set all the configuration values that you want to change, then verify and apply them to a Node.

See also: WirelessNode::applyConfig

WirelessNodeConfig
WirelessNodeConfig()

Creates a blank WirelessNodeConfig.

defaultMode
WirelessTypes::DefaultMode defaultMode() const

Gets the WirelessTypes::DefaultMode value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

defaultMode
void defaultMode(
WirelessTypes::DefaultMode mode
)

Sets the WirelessTypes::DefaultMode value in the Config.

inactivityTimeout
uint16 inactivityTimeout() const

Gets the user inactivity timeout value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

inactivityTimeout
void inactivityTimeout(
uint16 timeout
)

Sets the user inactivity timeout value in the Config.  This controls how many seconds before the Node goes to sleep when idle. (min of 5 seconds) Note: A value of 65535 (0xFFFF) disables the inactivity timeout so that the Node never goes to sleep.

checkRadioInterval
uint8 checkRadioInterval() const

Gets the check radio interval value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

checkRadioInterval
void checkRadioInterval(
uint8 interval
)

Sets the check radio interval value (in seconds) in the Config.  This controls how often the Node wakes up from sleep to check for commands.

transmitPower
WirelessTypes::TransmitPower transmitPower() const

Gets the WirelessTypes::TransmitPower value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

transmitPower
void transmitPower(
WirelessTypes::TransmitPower power
)

Sets the WirelessTypes::TransmitPower value in the Config.

samplingMode
WirelessTypes::SamplingMode samplingMode() const

Gets the WirelessTypes::SamplingMode value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

samplingMode
void samplingMode(
WirelessTypes::SamplingMode mode
)

Sets the WirelessTypes::SamplingMode value in the Config.

sampleRate
WirelessTypes::WirelessSampleRate sampleRate() const

Gets the WirelessTypes::WirelessSampleRate value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

sampleRate
void sampleRate(
WirelessTypes::WirelessSampleRate rate
)

Sets the WirelessTypes::WirelessSampleRate value in the Config.

activeChannels
ChannelMask activeChannels() const

Gets the ChannelMask value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

activeChannels
void activeChannels(
ChannelMask channels
)

Sets the ChannelMask value in the Config.

numSweeps
uint32 numSweeps() const

Gets the number of sweeps value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

numSweeps
void numSweeps(
uint32 sweeps
)

Sets the number of sweeps value in the Config.  This affects the duration of sampling if unlimited duration is disabled, or the duration of each burst if the sampling mode is Sync Sampling Burst.  Note: The number of sweeps should be normalized before it is set, using NodeFeatures::normalizeNumSweeps.

unlimitedDuration
bool unlimitedDuration() const

Gets the value of the unlimited duration flag in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

unlimitedDuration
void unlimitedDuration(
bool enable
)

Sets the value of the unlimited duration flag in the Config.

dataFormat
WirelessTypes::DataFormat dataFormat() const

Gets the WirelessTypes::DataFormat value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

dataFormat
void dataFormat(
WirelessTypes::DataFormat format
)

Sets the WirelessTypes::DataFormat in the Config.

dataCollectionMethod
WirelessTypes::DataCollectionMethod dataCollectionMethod() const

Gets the WirelessTypes::DataCollectionMethod value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

dataCollectionMethod
void dataCollectionMethod(
WirelessTypes::DataCollectionMethod method
)

Sets the WirelessTypes::DataCollectionMethod in the Config, representing how the data will be collected.  Note: this has no affect if the sampling mode is Armed Datalogging, as this mode only operates in "log only".

timeBetweenBursts
TimeSpan timeBetweenBursts() const

Gets the amount of time between each burst value in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

timeBetweenBursts
void timeBetweenBursts(
const TimeSpan &time
)

Sets the amount of time between each burst in the Config.  Note: This value should be normalized before it is set, using NodeFeatures::normalizeTimeBetweenBursts.

lostBeaconTimeout
uint16 lostBeaconTimeout() const

Gets the lost beacon timeout in the Config, if set.

Exceptions
Error_NoData

The requested value has not been set.

lostBeaconTimeout
void lostBeaconTimeout(
uint16 minutes
)

Sets the lost beacon timeout in the Config.  Note: This value should be within NodeFeatures::minLostBeaconTimeout and NodeFeatures::maxLostBeaconTimeout.  Note: A value of 0 disables the lost beacon timeout.

hardwareGain
double hardwareGain(
const ChannelMask &mask
) const

Gets the hardware gain for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the hardware gain for.

Exceptions
Error_NoData

The requested value has not been set.

hardwareGain
void hardwareGain(
const ChannelMask &mask,
double gain
)

Sets the hardware gain for the given ChannelMask in the Config.  Note: This value should be normalized before it is set, using NodeFeatures::normalizeHardwareGain.

hardwareOffset
uint16 hardwareOffset(
const ChannelMask &mask
) const

Gets the hardware offset for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the hardware offset for.

Exceptions
Error_NoData

The requested value has not been set.

hardwareOffset
void hardwareOffset(
const ChannelMask &mask,
uint16 offset
)

Sets the hardware offset for the given ChannelMask in the Config.

gaugeFactor
float gaugeFactor(
const ChannelMask &mask
) const

Gets the gauge factor for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the gauge factor for.

Exceptions
Error_NoData

The requested value has not been set.

gaugeFactor
void gaugeFactor(
const ChannelMask &mask,
float factor
)

Sets the gauge Factor for the given ChannelMask in the Config.

linearEquation
const LinearEquation& linearEquation(
const ChannelMask &mask
) const

Gets the LinearEquation for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the linear equation for.

Exceptions
Error_NoData

The requested value has not been set.

linearEquation
void linearEquation(
const ChannelMask &mask,
const LinearEquation &linearEquation
)

Sets the LinearEquation for the given ChannelMask in the Config.

unit
WirelessTypes::CalCoef_Unit unit(
const ChannelMask &mask
) const

Gets the WirelessTypes::CalCoef_Unit for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the linear equation for.

Exceptions
Error_NoData

The requested value has not been set.

unit
void unit(
const ChannelMask &mask,
WirelessTypes::CalCoef_Unit unit
)

Sets the WirelessTypes::CalCoef_Unit for the given ChannelMask in the Config.

equationType
WirelessTypes::CalCoef_EquationType equationType(
const ChannelMask &mask
) const

Gets the WirelessTypes::CalCoef_EquationType for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the linear equation for.

Exceptions
Error_NoData

The requested value has not been set.

equationType
void equationType(
const ChannelMask &mask,
WirelessTypes::CalCoef_EquationType equation
)

Sets the WirelessTypes::CalCoef_EquationType for the given ChannelMask in the Config.

filterSettlingTime
WirelessTypes::SettlingTime filterSettlingTime(
const ChannelMask &mask
) const

Gets the WirelessTypes::SettlingTime for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the filter settling time for.

Exceptions
Error_NoData

The requested value has not been set.

filterSettlingTime
void filterSettlingTime(
const ChannelMask &mask,
WirelessTypes::SettlingTime settlingTime
)

Sets the WirelessTypes::SettlingTime for the given ChannelMask in the Config.

thermocoupleType
WirelessTypes::ThermocoupleType thermocoupleType(
const ChannelMask &mask
) const

Gets the WirelessTypes::ThermocoupleType for the given ChannelMask in the Config, if set.

Parameters
mask

The ChannelMask to set the thermocouple type for.

Exceptions
Error_NoData

The requested value has not been set.

thermocoupleType
void thermocoupleType(
const ChannelMask &mask,
WirelessTypes::ThermocoupleType type
)

Sets the WirelessTypes::ThermocoupleType for the given ChannelMask in the Config.

fatigueOptions
const FatigueOptions& fatigueOptions() const

Gets the FatigueOptions currently set in the Config.

Exceptions
Error_NoData

The requested value has not been set.

fatigueOptions
void fatigueOptions(
const FatigueOptions &fatigueOpts
)

Sets the FatigueOptions in the Config.

histogramOptions
const HistogramOptions& histogramOptions() const

Gets the HistogramOptions currently set in the Config.

Exceptions
Error_NoData

The requested value has not been set.

histogramOptions
void histogramOptions(
const HistogramOptions &histogramOpts
)

Sets the HistogramOptions in the Config.

activitySense
const ActivitySense& activitySense() const

Gets the ActivitySense currently set in the Config.

Exceptions
Error_NoData

The requested value has not been set.

activitySense
void activitySense(
const ActivitySense &activitySenseOpts
)

Sets the ActivitySense in the Config.