FMAR.Comms.Vitals.ClientVitalsBroadcaster Class Reference

The ClientVitalsBroadcaster class is responsible for broadcasting vital signs data from the client to the server and other clients. It manages the collection, caching, and transmission of vital signs such as heart rate and EKG data. It also handles airway obstruction actions and notifies when certain thresholds are exceeded. More...

Inheritance diagram for FMAR.Comms.Vitals.ClientVitalsBroadcaster:

Public Member Functions
override void	OnNetworkSpawn ()
	Called when the network object is spawned. Initializes the pulse engine and registers the broadcaster.
override void	OnNetworkDespawn ()
	Called when the network object is despawned. Unregisters the broadcaster.
bool	TryGetVital (DataType vital, out List<(double time, double value)> list)
	Tries to get the list of vital sign data for the specified DataType.
Public Member Functions inherited from FMAR.Networking.FmarClientComponent
void	Init (FmarClient client)
Public Member Functions inherited from FMAR.Comms.Vitals.IVitalsProvider

Properties
IReadOnlyCollection< DataType >	VitalsProvided [get]
	Gets the collection of data types for the provided vital signs.
IReadOnlyDictionary< VitalsThreshold, float >	VitalsThresholdAlertTimers [get]
	Provides the dictionary of alert timers for the vital sign thresholds.
List< InspectorRow >	InspectorRows [get]
	Gets the list of inspector widgets for displaying vital signs information.
Properties inherited from FMAR.Networking.FmarClientComponent
FmarClient	Client [get]
Properties inherited from FMAR.Comms.Vitals.IVitalsProvider
Properties inherited from FMAR.Internal.Inspectables.IInspectable

Additional Inherited Members
Protected Attributes inherited from FMAR.Networking.FmarClientComponent
FmarClient	client

Detailed Description

The ClientVitalsBroadcaster class is responsible for broadcasting vital signs data from the client to the server and other clients. It manages the collection, caching, and transmission of vital signs such as heart rate and EKG data. It also handles airway obstruction actions and notifies when certain thresholds are exceeded.

Member Function Documentation

OnNetworkDespawn()

override void FMAR.Comms.Vitals.ClientVitalsBroadcaster.OnNetworkDespawn ( )

inline

Called when the network object is despawned. Unregisters the broadcaster.

OnNetworkSpawn()

override void FMAR.Comms.Vitals.ClientVitalsBroadcaster.OnNetworkSpawn ( )

inline

Called when the network object is spawned. Initializes the pulse engine and registers the broadcaster.

TryGetVital()

bool FMAR.Comms.Vitals.ClientVitalsBroadcaster.TryGetVital ( DataType vital, out List<(double time, double value)> list )

inline

Tries to get the list of vital sign data for the specified DataType.

Parameters

vital	The type of vital sign to retrieve.
list	The list of vital sign data.

Returns

True if the vital sign data is found, otherwise false.

Implements FMAR.Comms.Vitals.IVitalsProvider.

Property Documentation

InspectorRows

List<InspectorRow> FMAR.Comms.Vitals.ClientVitalsBroadcaster.InspectorRows

get

Gets the list of inspector widgets for displaying vital signs information.

Implements FMAR.Internal.Inspectables.IInspectable.

VitalsProvided

IReadOnlyCollection<DataType> FMAR.Comms.Vitals.ClientVitalsBroadcaster.VitalsProvided

get

Gets the collection of data types for the provided vital signs.

Implements FMAR.Comms.Vitals.IVitalsProvider.

VitalsThresholdAlertTimers

IReadOnlyDictionary<VitalsThreshold, float> FMAR.Comms.Vitals.ClientVitalsBroadcaster.VitalsThresholdAlertTimers

get

Provides the dictionary of alert timers for the vital sign thresholds.

Implements FMAR.Comms.Vitals.IVitalsProvider.

---

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

• /github/workspace/Packages/FMAR/Comms/Vitals/Runtime/Scripts/ClientVitalsBroadcaster.cs