Represents a single Signal K alarm zone within metadata. More...

#include <sensesp/signalk/signalk_metadata.h>

Public Member Functions
	SKMetadataZone (SKAlarmState state, const String &message, float lower, float upper=NAN)

Public Attributes
float	lower
	Lower bound of the zone; NAN if not set.

float	upper
	Upper bound of the zone; NAN if not set.

String	message

SKAlarmState	state

Detailed Description

Represents a single Signal K alarm zone within metadata.

A missing bound means the zone is unbounded on that side. Zones are emitted in the order they were added; consumers differ in how they resolve overlapping zones, so prefer non-overlapping zones.

See also: https://demo.signalk.org/documentation/_signalk/server-api/Zone.html

Definition at line 33 of file signalk_metadata.h.

Constructor & Destructor Documentation

◆ SKMetadataZone()

sensesp::SKMetadataZone::SKMetadataZone	(	SKAlarmState	state,
		const String &	message,
		float	lower,
		float	upper = `NAN`
	)

inline

Parameters

state	Alarm state the zone maps to.
message	Text shown for values in the zone.
lower	Lower bound; pass NAN for a zone only bounded from above.
upper	Upper bound; omit for a zone only bounded from below.

Definition at line 45 of file signalk_metadata.h.

Member Data Documentation

◆ lower

float sensesp::SKMetadataZone::lower

Lower bound of the zone; NAN if not set.

Definition at line 34 of file signalk_metadata.h.

◆ message

String sensesp::SKMetadataZone::message

Definition at line 36 of file signalk_metadata.h.

◆ state

SKAlarmState sensesp::SKMetadataZone::state

Definition at line 37 of file signalk_metadata.h.

◆ upper

float sensesp::SKMetadataZone::upper

Upper bound of the zone; NAN if not set.

Definition at line 35 of file signalk_metadata.h.

The documentation for this struct was generated from the following file:

src/sensesp/signalk/signalk_metadata.h

Public Member Functions

Public Attributes