PhyphoxBleExperiment Class Reference

#include <phyphoxBleExperiment.h>

Classes
class	Button
	New in 2.0. More...
class	Dropdown
class	Edit
class	Element
	Base of every view element. Holds the plain data the serializer reads. More...
class	ExportData
class	ExportSet
class	Graph
class	InfoField
class	InputElement
	Common API of the elements that send a value to the board. More...
class	Sensor
	A sensor of the phone whose readings the phone sends to the board. More...
class	Separator
class	Slider
class	Toggle
class	Value
class	View
	A tab in the app. Links its elements into a list until addExperiment() copies them. More...

Public Member Functions
	PhyphoxBleExperiment ()=default
	PhyphoxBleExperiment (const char *title, const char *category=nullptr, const char *description=nullptr)
	Shortcut for setTitle/setCategory/setDescription.
	PhyphoxBleExperiment (const PhyphoxBleExperiment &)=delete
PhyphoxBleExperiment &	operator= (const PhyphoxBleExperiment &)=delete
void	setTitle (const char *)
void	setCategory (const char *)
void	setDescription (const char *)
void	setColor (const char *)
void	setRepeating (int)
	Samples per data notification when using the array write; emits the repeating attribute.
void	setSubscribeOnStart (bool)
void	setResendUnchanged (bool)
	1.x behaviour: the phone writes every input's value every analysis cycle, not only on change (decision D14).
PhyphoxBleExperiment &	addView (View &)
PhyphoxBleExperiment &	addSensor (Sensor &)
PhyphoxBleExperiment &	addExportSet (ExportSet &)

Public Attributes
phyphox::ExperimentData	data
	experiment-level fields; arrays filled at addExperiment
View *	views = nullptr
	list heads
View *	lastView = nullptr
Sensor *	sensors = nullptr
Sensor *	lastSensor = nullptr
ExportSet *	exportSets = nullptr
ExportSet *	lastExportSet = nullptr

Constructor & Destructor Documentation

PhyphoxBleExperiment() [1/3]

PhyphoxBleExperiment::PhyphoxBleExperiment ( )

default

PhyphoxBleExperiment() [2/3]

PhyphoxBleExperiment::PhyphoxBleExperiment	(	const char *	title,
		const char *	category = nullptr,
		const char *	description = nullptr
	)

Shortcut for setTitle/setCategory/setDescription.

PhyphoxBleExperiment() [3/3]

PhyphoxBleExperiment::PhyphoxBleExperiment ( const PhyphoxBleExperiment &  )

delete

Member Function Documentation

addExportSet()

PhyphoxBleExperiment & PhyphoxBleExperiment::addExportSet

(

ExportSet &

)

addSensor()

PhyphoxBleExperiment & PhyphoxBleExperiment::addSensor

(

Sensor &

)

addView()

PhyphoxBleExperiment & PhyphoxBleExperiment::addView

(

View &

)

operator=()

PhyphoxBleExperiment & PhyphoxBleExperiment::operator= ( const PhyphoxBleExperiment &  )

delete

setCategory()

void PhyphoxBleExperiment::setCategory

(

const char *

)

setColor()

void PhyphoxBleExperiment::setColor

(

const char *

)

setDescription()

void PhyphoxBleExperiment::setDescription

(

const char *

)

setRepeating()

void PhyphoxBleExperiment::setRepeating

(

int

)

Samples per data notification when using the array write; emits the repeating attribute.

setResendUnchanged()

void PhyphoxBleExperiment::setResendUnchanged

(

bool

)

1.x behaviour: the phone writes every input's value every analysis cycle, not only on change (decision D14).

Also handy as a heartbeat from the phone.

setSubscribeOnStart()

void PhyphoxBleExperiment::setSubscribeOnStart

(

bool

)

setTitle()

void PhyphoxBleExperiment::setTitle

(

const char *

)

Member Data Documentation

data

phyphox::ExperimentData PhyphoxBleExperiment::data

experiment-level fields; arrays filled at addExperiment

exportSets

ExportSet* PhyphoxBleExperiment::exportSets = nullptr

lastExportSet

ExportSet* PhyphoxBleExperiment::lastExportSet = nullptr

lastSensor

Sensor* PhyphoxBleExperiment::lastSensor = nullptr

lastView

View* PhyphoxBleExperiment::lastView = nullptr

sensors

Sensor* PhyphoxBleExperiment::sensors = nullptr

views

View* PhyphoxBleExperiment::views = nullptr

list heads

---

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

• src/phyphoxBleExperiment.h