FirstModulAR 0.1.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | Events | List of all members
FMARPulseEngineDriver Class Reference

Custom PulseEngineDriver utilizing an Enum for various data, instead of integers. Pulse's default is unwieldy. More...

Inheritance diagram for FMARPulseEngineDriver:
PulseDataSource

Public Types

enum  DataType {
  Lead3ElectricPotential , HeartRate , ArterialPressure , MeanArterialPressure ,
  SystolicArterialPressure , DiastolicArterialPressure , OxygenSaturation , EndTidalCarbonDioxidePressure ,
  RespirationRate , CoreTemperatureFahrenheit , CarinaCarbonDioxidePartialPressure , BloodVolume ,
  TotalLungVolume , CerebralBloodFlow
}
 

Public Member Functions

List<(double Time, double Value)> GetData (DataType dataType)
 Provides the most recent data for a given data type.
 

Static Public Member Functions

static string GetDataTypeString (float value, DataType dataType)
 Provides a user-friendly formatted string comtaining the data type name and the value with units.
 
static string GetLongLabelString (DataType dataType)
 Provides a user-friendly formatted string containing a verbose label describing the data type.
 
static string GetShortLabelString (DataType dataType)
 Provides a user-friendly formatted string containing a shortened label describing the data type.
 
static string GetShortUnitsString (DataType dataType)
 Provides a user-friendly formatted string containing a short label describing the unit measurement for the data type.
 

Public Attributes

TextAsset initialStateFile
 
eSerializationFormat serializationFormat = eSerializationFormat.JSON
 
double sampleRate = 0.02
 
PulseEngine engine
 
bool pauseUpdate = false
 
- Public Attributes inherited from PulseDataSource
PulseData data = null
 

Protected Member Functions

virtual void OnValidate ()
 
virtual void Awake ()
 
virtual void Start ()
 
virtual void Update ()
 
virtual void OnApplicationQuit ()
 

Protected Attributes

double pulseTime
 
double pulseTimeStep = 0.02
 
double pulseSampleTime
 
bool pullAllData = true
 
double[] data_values
 

Properties

string PatientName [get]
 

Events

Action PulseDataUpdated
 

Detailed Description

Custom PulseEngineDriver utilizing an Enum for various data, instead of integers. Pulse's default is unwieldy.

Member Enumeration Documentation

◆ DataType

enum FMARPulseEngineDriver.DataType
Enumerator
Lead3ElectricPotential 
HeartRate 
ArterialPressure 
MeanArterialPressure 
SystolicArterialPressure 
DiastolicArterialPressure 
OxygenSaturation 
EndTidalCarbonDioxidePressure 
RespirationRate 
CoreTemperatureFahrenheit 
CarinaCarbonDioxidePartialPressure 
BloodVolume 
TotalLungVolume 
CerebralBloodFlow 

Member Function Documentation

◆ Awake()

virtual void FMARPulseEngineDriver.Awake ( )
inlineprotectedvirtual

◆ GetData()

List<(double Time, double Value)> FMARPulseEngineDriver.GetData ( DataType dataType)
inline

Provides the most recent data for a given data type.

Parameters
dataType
Returns
list of time/value tuples

◆ GetDataTypeString()

static string FMARPulseEngineDriver.GetDataTypeString ( float value,
DataType dataType )
inlinestatic

Provides a user-friendly formatted string comtaining the data type name and the value with units.

◆ GetLongLabelString()

static string FMARPulseEngineDriver.GetLongLabelString ( DataType dataType)
inlinestatic

Provides a user-friendly formatted string containing a verbose label describing the data type.

◆ GetShortLabelString()

static string FMARPulseEngineDriver.GetShortLabelString ( DataType dataType)
inlinestatic

Provides a user-friendly formatted string containing a shortened label describing the data type.

◆ GetShortUnitsString()

static string FMARPulseEngineDriver.GetShortUnitsString ( DataType dataType)
inlinestatic

Provides a user-friendly formatted string containing a short label describing the unit measurement for the data type.

◆ OnApplicationQuit()

virtual void FMARPulseEngineDriver.OnApplicationQuit ( )
inlineprotectedvirtual

◆ OnValidate()

virtual void FMARPulseEngineDriver.OnValidate ( )
inlineprotectedvirtual

◆ Start()

virtual void FMARPulseEngineDriver.Start ( )
inlineprotectedvirtual

◆ Update()

virtual void FMARPulseEngineDriver.Update ( )
inlineprotectedvirtual

Member Data Documentation

◆ data_values

double [] FMARPulseEngineDriver.data_values
protected

◆ engine

PulseEngine FMARPulseEngineDriver.engine

◆ initialStateFile

TextAsset FMARPulseEngineDriver.initialStateFile

◆ pauseUpdate

bool FMARPulseEngineDriver.pauseUpdate = false

◆ pullAllData

bool FMARPulseEngineDriver.pullAllData = true
protected

◆ pulseSampleTime

double FMARPulseEngineDriver.pulseSampleTime
protected

◆ pulseTime

double FMARPulseEngineDriver.pulseTime
protected

◆ pulseTimeStep

double FMARPulseEngineDriver.pulseTimeStep = 0.02
protected

◆ sampleRate

double FMARPulseEngineDriver.sampleRate = 0.02

◆ serializationFormat

eSerializationFormat FMARPulseEngineDriver.serializationFormat = eSerializationFormat.JSON

Property Documentation

◆ PatientName

string FMARPulseEngineDriver.PatientName
get

Event Documentation

◆ PulseDataUpdated

Action FMARPulseEngineDriver.PulseDataUpdated
The documentation for this class was generated from the following file: