A typed, read-only view of Signal K metadata received for a path. More...

#include <sensesp/signalk/signalk_metadata_listener.h>

Public Member Functions
	SKMetaView ()=default

	SKMetaView (JsonObjectConst meta, std::shared_ptr< const JsonDocument > owned)

Public Attributes
String	display_name

String	units

String	description

String	display_units

std::vector< SKZone >	zones

std::shared_ptr< const JsonDocument >	raw

Detailed Description

A typed, read-only view of Signal K metadata received for a path.

This is the inbound counterpart to SKMetadata (which is an output-only serializer used by SKOutput). It is the value emitted by SKMetadataListener, so it must be cheaply copyable: it flows through ValueProducer by value (copied into the producer's output and into each observer). The commonly-used fields are exposed as typed members; the full received meta object is retained (owned, refcounted) in raw so that fields not modeled here (displayScale, vendor extensions, ...) are never lost.

Construct from the value object of a meta[] delta entry.

See also: SKMetadataListener; SKMetadata

Definition at line 49 of file signalk_metadata_listener.h.

Constructor & Destructor Documentation

◆ SKMetaView() [1/2]

sensesp::SKMetaView::SKMetaView ( )

default

◆ SKMetaView() [2/2]

sensesp::SKMetaView::SKMetaView	(	JsonObjectConst	meta,
		std::shared_ptr< const JsonDocument >	owned
	)

inline

Parse a typed view from a received meta value object. Stores owned as the lossless raw backing; meta must point into owned.

Definition at line 65 of file signalk_metadata_listener.h.

Member Data Documentation

◆ description

String sensesp::SKMetaView::description

Definition at line 52 of file signalk_metadata_listener.h.

◆ display_name

String sensesp::SKMetaView::display_name

Definition at line 50 of file signalk_metadata_listener.h.

◆ display_units

String sensesp::SKMetaView::display_units

Definition at line 53 of file signalk_metadata_listener.h.

◆ raw

std::shared_ptr<const JsonDocument> sensesp::SKMetaView::raw

The full received meta object, owned and refcounted (a copy is a refcount bump, not a deep copy). Carries any field not exposed as a typed member. Null on a default-constructed (no-data-yet) view.

Definition at line 59 of file signalk_metadata_listener.h.