FatigueOptions
SnCurveSegment
SnCurveSegment

Represents a single segment of an SN-Curve.

SnCurveSegment
SnCurveSegment(
float m,
float loga
)

Creates an SnCurveSegment.

Parameters
m
float

The m value of the segment.

loga
float

The logA value of the segment.

m
float m() const

Gets the m value of the segment.

m
void m(
float val
)

Sets the m value of the segment.

Parameters
val
float

The m value to set.

logA
float logA() const

Gets the logA value of the segment.

logA
void logA(
float val
)

Sets the logA value of the segment.

Parameters
val
float

The logA value to set.

DamageAngles

Typedef for a map of angle IDs (uint8) to damage angles (float).

SnCurveSegments

Typedef for a map of segment IDs (uint8) to SnCurveSegment objects.

FatigueOptions
FatigueOptions

Contains all of the fatigue options that can be configured for a WirelessNode.

youngsModulus
float youngsModulus() const

Gets the Young's Modulus set in this options object.

youngsModulus
void youngsModulus(
float val
)

Sets the Young's Modulus in this options object.

Parameters
val
float

The Young's Modulus to set.

poissonsRatio
float poissonsRatio() const

Gets the Poisson's Ration set in this options object.

poissonsRatio
void poissonsRatio(
float val
)

Sets the Poisson's Ratio in this options object.

Parameters
val
float

The Poisson's Ratio to set.

peakValleyThreshold
uint16 peakValleyThreshold() const

Gets the Peak/Valley Threshold set in this options object.

peakValleyThreshold
void peakValleyThreshold(
uint16 val
)

Sets the Peak/Valley Threshold in this options object.

Parameters
val
uint16

The Peak/Valley Threshold to set.

debugMode
bool debugMode() const

Gets the debug mode flag set in this options object.  This determines whether raw angle data that builds the Histograms will be sent when sampling.

debugMode
void debugMode(
bool enable
)

Sets the debug mode flag in this options object.  This determines whether raw angle data that builds the Histograms will be sent when sampling.

Parameters
enable
bool

Whether to enable (true) or disable (false) debug mode.

damageAngle
float damageAngle(
uint8 angleId
) const

Gets the damage angle set in this options object, for the given angle id (0-based).

Parameters
angleId
uint8

The angle ID to get the damage angle for.

Exceptions
Error_NoData

The given angle ID was not set in this object.

damageAngles
const DamageAngles& damageAngles() const

Gets the DamageAngles container set in this options object.

damageAngle
void damageAngle(
uint8 angleId,
float angle
)

Sets the damage angle in this options object, for the given angle id (0-based).  The angle will be automatically converted to between 0 and 360 if it is out of range.

Parameters
angleId
uint8

The angle ID to set the damage angle for.

angle
float

The damage angle value to set.

snCurveSegment
const SnCurveSegment& snCurveSegment(
uint8 segmentId
) const

Gets the SnCurveSegment set in this options object, for the given segment id (0-based).

Parameters
segmentId
uint8

The segment ID to get the segment for.

Exceptions
Error_NoData

The given segment ID was not set in this object.

snCurveSegments
const SnCurveSegments& snCurveSegments() const

Gets the SnCurveSegments container set in this options object.

snCurveSegment
void snCurveSegment(
uint8 segmentId,
const SnCurveSegment &segment
)

Sets the SnCurveSegment in this options object, for the given segment id (0-based).

Parameters
segmentId
uint8

The segment ID to set the segment for.

segment

The SnCurveSegment to set.

fatigueMode
WirelessTypes::FatigueMode fatigueMode() const

The WirelessTypes::FatigueMode that is set in this options object.

distributedAngleMode_enabled

Sets whether distributed angle mode is enabled or disabled in this options object.  Distributed Angle Mode allows the user to enable an even distribution of 4-16 angles.  When in this mode, the standard damageAngles will not be used by the Node.

Parameters
enable

Whether to enable or disable distributed angle mode.

distributedAngleMode_numAngles
uint8 distributedAngleMode_numAngles() const

Gets the current number of angles to use for distributed angle mode in this options object.  Note: The Node will only use this if the fatigueMode is set to distributed angle mode.

distributedAngleMode_numAngles
void distributedAngleMode_numAngles(
uint8 numAngles
)

Sets the current number of angles to use for distributed angle mode in this options object.  Note: Note: The Node will only use this if the fatigueMode is set to distributed angle mode.

Parameters
numAngles
uint8

The number of angles to use (4-16).

distributedAngleMode_lowerBound
float distributedAngleMode_lowerBound() const

Gets the current lower bound angle (in degrees) to use for distributed angle mode in this options object.  Note: Note: The Node will only use this if the fatigueMode is set to distributed angle mode.

distributedAngleMode_lowerBound
void distributedAngleMode_lowerBound(
float angle
)

Sets the current lower bound angle to use for distributed angle mode in this options object.  Note: Note: The Node will only use this if the fatigueMode is set to distributed angle mode.  Note: The lower bound and upper bound angles must be at least 1 degree.

Parameters
angle
float

The lower bound angle (in degrees) to use.

distributedAngleMode_upperBound
float distributedAngleMode_upperBound() const

Gets the current upper bound angle (in degrees) to use for distributed angle mode in this options object.  Note: Note: The Node will only use this if the fatigueMode is set to distributed angle mode.

distributedAngleMode_upperBound
void distributedAngleMode_upperBound(
float angle
)

Sets the current upper bound angle to use for distributed angle mode in this options object.  Note: Note: The Node will only use this if the fatigueMode is set to distributed angle mode.  Note: The lower bound and upper bound angles must be at least 1 degree.

Parameters
angle
float

The upper bound angle (in degrees) to use.

histogramEnable
bool histogramEnable() const

Gets whether sending Histograms is enabled or disabled, in this options object.

histogramEnable
void histogramEnable(
bool enable
)

Sets whether sending Histograms is enabled or disabled, in this options object.

Parameters
enable
bool

Whehter to enable or disable sending Histograms.