DFX Extraction library v4.14.5
enabling applications to perform DFX blood flow analysis
Public Member Functions | List of all members
dfx::MeasurementData Class Referenceabstract

#include "dfx/MeasurementData.h"

Public Member Functions

virtual std::vector< std::string > getDataPropertyKeys ()=0
 Returns a list of measurement data property keys that can be used with getDataProperty(). More...
 
virtual std::string getDataProperty (const std::string &key)=0
 Returns a measurement data property by key. More...
 
virtual std::vector< double > getData ()=0
 Returns the numerical data associated with this MeasurmentData. More...
 

Detailed Description

A MeasurementData contains MeasurementResult data for a specific signal.

Member Function Documentation

◆ getData()

virtual std::vector<double> dfx::MeasurementData::getData ( )
pure virtual

Returns the numerical data associated with this MeasurmentData.

The vector can contain one or more values based upon the study definition and what the server is able to provide.

For instance, if the MeasurementData is for "HEART_RATE" this may be one value which would be a summary for the entire measurement chunk or it could be an estimated value per-frame of the measurement chunk.

Returns
a vector of bytes containing the data of the MeasurementData.

◆ getDataProperty()

virtual std::string dfx::MeasurementData::getDataProperty ( const std::string &  key)
pure virtual

Returns a measurement data property by key.

Measurement data may include additional properties which are available based upon what is returned by getDataPropertyKeys().

This may include for instance "ID" which could be "HEART_RATE" if the signal this MeasurementData represents is associated with "HEART_RATE".

Returns
the value of the property, or an empty string if key doesn't exist.

◆ getDataPropertyKeys()

virtual std::vector<std::string> dfx::MeasurementData::getDataPropertyKeys ( )
pure virtual

Returns a list of measurement data property keys that can be used with getDataProperty().

Returns
list of measurement data property keys

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