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
Creates a blank WirelessNodeConfig.
The WirelessTypes::DefaultMode to set.
The inactivity timeout to set.
The check radio interval to set.
The WirelessTypes::TransmitPower to set.
The WirelessTypes::SamplingMode to set.
The WirelessTypes::WirelessSampleRate to set.
The numbers of sweeps to set.
The unlimited duration flag to set.
The WirelessTypes::DataFormat to set.
The WirelessTypes::DataCollectionMethod to set.
The amount of time between each burst to set.
The lost beacon timeout to set.
The HistogramOptions to set.
The map of ChannelMask to hardware gains to set.
The map of ChannelMask to hardware offsets to set.
The map of ChannelMask to gauge factors to set.
The map of ChannelMask to WirelessTypes::SettlingTime to set.
The map of ChannelMask to WirelessTypes::ThermocoupleType to set.
The map of ChannelMask to LinearEquation to set.
The map of ChannelMask to WirelessTypes::CalCoef_Unit to set.
The map of ChannelMask to WirelessTypes::CalCoef_EquationType to set.
WirelessTypes::SamplingMode curSamplingMode( |
| ) const |
Gets the sampling mode currently set, or from the node if not set.
WirelessTypes::WirelessSampleRate curSampleRate( |
| ) const |
Gets the sample rate currently set, or from the node if not set.
ChannelMask curActiveChs( |
| ) const |
Gets the active channels currently set, or from the node if not set.
uint32 curNumSweeps( |
| ) const |
Gets the number of sweeps currently set, or from the node if not set.
bool curUnlimitedDuration( |
| ) const |
Gets the unlimited duration flag currently set, or from the node if not set.
WirelessTypes::DataFormat curDataFormat( |
| ) const |
Gets the data format currently set, or from the node if not set.
TimeSpan curTimeBetweenBursts( |
| ) const |
Gets the time between bursts currently set, or from the node if not set.
WirelessTypes::SettlingTime curSettlingTime( |
| ) const |
Gets the filter settling time currently set for the given ChannelMask, or from the node if not set.
template<typename T> void checkValue( |
| ) const |
Throws an exception if an optional value isn't set.
opt const boost::optional<T>& | The boost::optional value to check if it is set. |
valueName const std::string& | The name of the value being checked. This will be included in the exception description if not set. |
Error_NoData | The requested value has not been set. |
template<typename T> bool isSet( |
| ) const |
Checks whether the optional value is set.
opt const boost::optional<T>& | The boost::optional value to check if it is set. |
true if the value is set, false if it is not set.
template<typename T> bool isSet( |
| ) const |
Checks whether a value is set in the ChannelMask option map for the given ChannelMask.
val | The map to check if any values are set within. |
true if the map contains at least 1 setting, false if it is empty.
template<typename T> bool isAnySet( |
| ) const |
Checks whether there are any values set in the ChannelMask option map.
map const std::map<ChannelMask, T>& | The map to check if any values are set within. |
true if the map contains at least 1 setting, false if it is empty.
template<typename T> const T& getChannelMapVal( |
| ) const |
Returns the value in the given map for the provided channel mask, and throws an exception if not found.
map const std::map<ChannelMask, T>& | The map of ChannelMask to T value to search in. |
mask const ChannelMask& | The ChannelMask to look for. |
valueName const std::string& | The name of the value being checked. This will be included in the exception description if not set. |
The value found for the ChannelMask in the provided map.
Error_NoData | The requested value has not been set for the provided ChannelMask. |
template<typename T> void setChannelMapVal( |
| ) |
Sets the value in the given map for the provided channel mask. This will update it if it already exists, and add an item to the map if it does not.
map std::map<ChannelMask, T>& | The map of ChannelMask to T value to add the value to. |
mask const ChannelMask& | The ChannelMask to set the value for. |
value T | The value to set in the map. |
bool verifySupported( |
| ) const |
Checks whether all the configuration values are supported by the node.
features const NodeFeatures& | The NodeFeatures of the WirelessNode to verify the configuration for. |
eeprom const NodeEepromHelper& | The NodeEepromHelper of the WirelessNode to use for communication. |
outIssues ConfigIssues& | The ConfigIssues holding any resulting issues that are found with the configuration. Must be empty when calling. |
true if no issues were found, false otherwise. If false, the outIssues parameter will hold all issues that were found.
bool verifyConflicts( |
| ) const |
Checks whether configuration values conflict with each other. If any of the config values that need to be checked aren't currently set, they will be read from the Node for verification.
features const NodeFeatures& | The NodeFeatures of the WirelessNode to verify the configuration for. |
eeprom const NodeEepromHelper& | The NodeEepromHelper of the WirelessNode to use for communication. |
outIssues ConfigIssues& | The ConfigIssues holding any resulting issues that are found with the configuration. Must be empty when calling. |
true if no issues were found, false otherwise. If false, the outIssues parameter will hold all issues that were found.
void apply( |
| ) const |
Writes all of the configuration values that are set to a WirelessNode.
features const NodeFeatures& | The NodeFeatures of the WirelessNode to write the config to. |
eeprom | The NodeEepromHelper of the WirelessNode to write the config to. |
Error_InvalidNodeConfig: Invalid Configuration for the Node. Check the exception for specific details.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
bool verify( |
| ) const |
Checks whether the current settings are ok to be written to a given WirelessNode.
features const NodeFeatures& | The NodeFeatures of the WirelessNode to verify the configuration for. |
eeprom const NodeEepromHelper& | The NodeEepromHelper of the WirelessNode to use for communication. |
outIssues ConfigIssues& | The ConfigIssues holding any resulting issues that are found with the configuration. |
true if the configuration is valid. false if the configuration is invalid and outIssues should be checked for more information.
Error_NodeCommunication: Failed to communicate with the Node.
Error_Connection: A connection error has occurred with the parent BaseStation.
Gets the WirelessTypes::DefaultMode value in the Config, if set.
Error_NoData | The requested value has not been set. |
void defaultMode( |
| ) |
Sets the WirelessTypes::DefaultMode value in the Config.
Gets the user inactivity timeout value in the Config, if set.
Error_NoData | The requested value has not been set. |
void inactivityTimeout( |
| ) |
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.
Gets the check radio interval value in the Config, if set.
Error_NoData | The requested value has not been set. |
void checkRadioInterval( |
| ) |
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.
Gets the WirelessTypes::TransmitPower value in the Config, if set.
Error_NoData | The requested value has not been set. |
void transmitPower( |
| ) |
Sets the WirelessTypes::TransmitPower value in the Config.
Gets the WirelessTypes::SamplingMode value in the Config, if set.
Error_NoData | The requested value has not been set. |
void samplingMode( |
| ) |
Sets the WirelessTypes::SamplingMode value in the Config.
Gets the WirelessTypes::WirelessSampleRate value in the Config, if set.
Error_NoData | The requested value has not been set. |
void sampleRate( |
| ) |
Sets the WirelessTypes::WirelessSampleRate value in the Config.
Gets the ChannelMask value in the Config, if set.
Error_NoData | The requested value has not been set. |
Gets the number of sweeps value in the Config, if set.
Error_NoData | The requested value has not been set. |
void numSweeps( |
| ) |
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.
Gets the value of the unlimited duration flag in the Config, if set.
Error_NoData | The requested value has not been set. |
void unlimitedDuration( |
| ) |
Sets the value of the unlimited duration flag in the Config.
Gets the WirelessTypes::DataFormat value in the Config, if set.
Error_NoData | The requested value has not been set. |
void dataFormat( |
| ) |
Sets the WirelessTypes::DataFormat in the Config.
Gets the WirelessTypes::DataCollectionMethod value in the Config, if set.
Error_NoData | The requested value has not been set. |
void dataCollectionMethod( |
| ) |
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".
Gets the amount of time between each burst value in the Config, if set.
Error_NoData | The requested value has not been set. |
void timeBetweenBursts( |
| ) |
Sets the amount of time between each burst in the Config. Note: This value should be normalized before it is set, using NodeFeatures::normalizeTimeBetweenBursts.
Gets the lost beacon timeout in the Config, if set.
Error_NoData | The requested value has not been set. |
void lostBeaconTimeout( |
| ) |
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.
double hardwareGain( |
| ) const |
Gets the hardware gain for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the hardware gain for. |
Error_NoData | The requested value has not been set. |
void hardwareGain( |
| ) |
Sets the hardware gain for the given ChannelMask in the Config. Note: This value should be normalized before it is set, using NodeFeatures::normalizeHardwareGain.
uint16 hardwareOffset( |
| ) const |
Gets the hardware offset for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the hardware offset for. |
Error_NoData | The requested value has not been set. |
void hardwareOffset( |
| ) |
Sets the hardware offset for the given ChannelMask in the Config.
float gaugeFactor( |
| ) const |
Gets the gauge factor for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the gauge factor for. |
Error_NoData | The requested value has not been set. |
void gaugeFactor( |
| ) |
Sets the gauge Factor for the given ChannelMask in the Config.
const LinearEquation& linearEquation( |
| ) const |
Gets the LinearEquation for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the linear equation for. |
Error_NoData | The requested value has not been set. |
void linearEquation( |
| ) |
Sets the LinearEquation for the given ChannelMask in the Config.
WirelessTypes::CalCoef_Unit unit( |
| ) const |
Gets the WirelessTypes::CalCoef_Unit for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the linear equation for. |
Error_NoData | The requested value has not been set. |
void unit( |
| ) |
Sets the WirelessTypes::CalCoef_Unit for the given ChannelMask in the Config.
WirelessTypes::CalCoef_EquationType equationType( |
| ) const |
Gets the WirelessTypes::CalCoef_EquationType for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the linear equation for. |
Error_NoData | The requested value has not been set. |
void equationType( |
| ) |
Sets the WirelessTypes::CalCoef_EquationType for the given ChannelMask in the Config.
WirelessTypes::SettlingTime filterSettlingTime( |
| ) const |
Gets the WirelessTypes::SettlingTime for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the filter settling time for. |
Error_NoData | The requested value has not been set. |
void filterSettlingTime( |
| ) |
Sets the WirelessTypes::SettlingTime for the given ChannelMask in the Config.
WirelessTypes::ThermocoupleType thermocoupleType( |
| ) const |
Gets the WirelessTypes::ThermocoupleType for the given ChannelMask in the Config, if set.
mask const ChannelMask& | The ChannelMask to set the thermocouple type for. |
Error_NoData | The requested value has not been set. |
void thermocoupleType( |
| ) |
Sets the WirelessTypes::ThermocoupleType for the given ChannelMask in the Config.
Gets the FatigueOptions currently set in the Config.
Error_NoData | The requested value has not been set. |
void fatigueOptions( |
| ) |
Sets the FatigueOptions in the Config.
Gets the HistogramOptions currently set in the Config.
Error_NoData | The requested value has not been set. |
void histogramOptions( |
| ) |
Sets the HistogramOptions in the Config.
Gets the ActivitySense currently set in the Config.
Error_NoData | The requested value has not been set. |
void activitySense( |
| ) |
Sets the ActivitySense in the Config.