ModularSensors > Classes > Variable > ProcessorStats_SampleNumber
ModularSensors > Modules > Processor Metadata > ProcessorStats_SampleNumber


ProcessorStats_SampleNumber class

The Variable sub-class used for the sample number output from the main processor.

This is a board diagnostic. It is roughly the number of samples measured since the processor was last restarted. This value simply increments up by one every time the addSingleMeasurementResult() function is called for the processor sensor. It is intended only as a rough diagnostic to show when the processor restarts.

Base classes

class Variable
The variable class for a value and related metadata.

Constructors, destructors, conversion operators

ProcessorStats_SampleNumber(ProcessorStats* parentSense, const char* uuid = "", const char* varCode = PROCESSOR_SAMPNUM_DEFAULT_CODE) explicit
Construct a new ProcessorStats_SampleNumber object.
ProcessorStats_SampleNumber()
Construct a new ProcessorStats_SampleNumber object.
~ProcessorStats_SampleNumber()
Destroy the ProcessorStats_SampleNumber() object - no action needed.

Function documentation

ProcessorStats_SampleNumber(ProcessorStats* parentSense, const char* uuid = "", const char* varCode = PROCESSOR_SAMPNUM_DEFAULT_CODE) explicit

Construct a new ProcessorStats_SampleNumber object.

Parameters
parentSense The parent ProcessorStats providing the result values.
uuid A universally unique identifier (UUID or GUID) for the variable; optional with the default value of an empty string.
varCode A short code to help identify the variable in files; optional with a default value of "SampNum".

ProcessorStats_SampleNumber()

Construct a new ProcessorStats_SampleNumber object.