dfx::MeasurementResult Class Reference

#include "dfx/MeasurementResult.h"

Public Member Functions
virtual uint8_t	isValid ()=0
virtual std::vector< std::string >	getMeasurementPropertyKeys ()=0
virtual std::string	getMeasurementProperty (const std::string &key)=0
virtual std::vector< std::string >	getMeasurementDataKeys ()=0
virtual std::shared_ptr< MeasurementData >	getMeasurementData (const std::string &key)=0
virtual std::string	getErrorCode ()=0

Detailed Description

A MeasurementResult is the decoded MeasurementResult from the server and contains properties along with individual MeasurementData for the various signals available in the study.

Member Function Documentation

getErrorCode()

virtual std::string dfx::MeasurementResult::getErrorCode ( )

pure virtual

Returns the error code associated with the measurement.

If the MeasurementResult isValid(), this will be "OK" otherwise it will contain another code which identifies an error like "INTERNAL_ERROR".

Returns

the error code associated with the measurement result.

getMeasurementData()

virtual std::shared_ptr<MeasurementData> dfx::MeasurementResult::getMeasurementData ( const std::string &  key )

pure virtual

Obtains the MeasurementData for a known key.

If the key does not exist, a nullptr will be returned.

Parameters

key	to obtain the MeasurementData for

Returns

the MeasurementData

getMeasurementDataKeys()

virtual std::vector<std::string> dfx::MeasurementResult::getMeasurementDataKeys ( )

pure virtual

Returns a list of available data keys contained in this measurement result.

The actual list is a function of the study definition and what the server was able to generate based upon the data provided. This is a convenience method to assist in inspecting the measurment data result, but if you know the keys of interest those can be asked for directly using getMeasurementData().

Possible keys might include "HEART_RATE", "SNR", etc.

Returns

a list of keys present in this measurement result

getMeasurementProperty()

virtual std::string dfx::MeasurementResult::getMeasurementProperty ( const std::string &  key )

pure virtual

Obtain individual properties associated with this MeasurementResult.

These properties are useful when communicating with the server about the Measurement. Specifically, it will include "MeasurementID", "MeasurementDataID", "MeasurementResultID" and possibly others.

Parameters

key	the measurement property to look up

Returns

the valid of the measurement property or an empty string

getMeasurementPropertyKeys()

virtual std::vector<std::string> dfx::MeasurementResult::getMeasurementPropertyKeys ( )

pure virtual

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

Returns

list of measurement property keys

isValid()

virtual uint8_t dfx::MeasurementResult::isValid ( )

pure virtual

Returns true if this measurement result is valid, otherwise returns false.

Returns

true (non-zero) if measurement result is valid, otherwise false (zero)

---

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

• dfx/MeasurementResult.h