Edia.Experiment Class Reference

Main manager for the experiment. More...

Public Member Functions
bool	IsXblockExecuterListed (string assetId)
	Determines if an XBlock executor with the given asset ID is listed in the experiment's executors.
void	ShowMessageToUser (string msg)
	Show a message to the VR user in an overlayed panel.
void	ShowMessageToUser (List< string > msgs)
	Show a list of messages to the VR user, one at a time, in the MessagePanelInVR.
void	ShowMessageToUser (string msg, float duration)
	Show a message to the VR user in the MessagePanelInVR for a certain duration.
void	ShowMessageToUser (string msg, bool showButton)
	Show a message to the VR user in the MessagePanelInVR.
void	HideMessagePanelMenu ()
	Hides the message panel menu in the VR environment.
void	HideMessagePanelToUser ()
	Hide the MessagePanelInVR panel.
void	ShowMessageToExperimenter (string msg, bool autohide)
	Shows a message in the controlpanel.
void	ShowMessageToExperimenter (string msg)
	Shows a message in the controlpanel.
void	AddTrialInfoToPanel (string key, string value)
	Adds trial information, represented by a key-value pair, to the control panel.
void	EnablePauseButton (bool _onOff)
	Show/Hide Pause button on controller panel.
void	EnableEyeCalibrationTrigger (bool _onOff)
	Set system open for calibration call from event or button.
void	WaitOnProceed ()
	Enables Controller 'Proceed' button, and waits OnEvProceed event.
void	Proceed ()
	Triggers OnEvProceed event.
void	ProceedWithDelay (float duration)
	Call next step in the trial with delay.
void	ConvertAndSaveDataToUXF (string[] headers, List< string[]> values, string filename)
	Converts given data to a UXF Table, and stores the data to disk linked to the active trial at the time.
void	StoreMarker (string annotation)
	Saves a marker with a timestamp to disk.
void	AddToTrialResults (string key, string value)
	Add a <key>pain to the trial results table.

Detailed Description

Main manager for the experiment.

Handles the statemachine, encapsulating UXF. Offers developers friendly and easy access to most used functionalities for controlling an experiment.

Member Function Documentation

AddToTrialResults()

void Edia.Experiment.AddToTrialResults ( string key, string value )

inline

Add a <key>pain to the trial results table.

Parameters

key	Name of the key
value	Value in string format

AddTrialInfoToPanel()

void Edia.Experiment.AddTrialInfoToPanel ( string key, string value )

inline

Adds trial information, represented by a key-value pair, to the control panel.

It will be auto deleted after trial is done

Parameters

key	The key identifying the trial information.
value	The value associated with the key in the trial information.

ConvertAndSaveDataToUXF()

void Edia.Experiment.ConvertAndSaveDataToUXF ( string[] headers, List< string[]> values, string filename )

inline

Converts given data to a UXF Table, and stores the data to disk linked to the active trial at the time.

Parameters

headers	Headers of the data
values	Data as List<string>[]
filename	Name to store the data with

EnableEyeCalibrationTrigger()

void Edia.Experiment.EnableEyeCalibrationTrigger ( bool _onOff )

inline

Set system open for calibration call from event or button.

Parameters

onOff

EnablePauseButton()

void Edia.Experiment.EnablePauseButton ( bool _onOff )

inline

Show/Hide Pause button on controller panel.

Parameters

_onOff

IsXblockExecuterListed()

bool Edia.Experiment.IsXblockExecuterListed ( string assetId )

inline

Determines if an XBlock executor with the given asset ID is listed in the experiment's executors.

Parameters

assetId

The unique identifier of the XBlock executor to check for.

Returns

True if an executor with the specified asset ID is listed, otherwise false.

ProceedWithDelay()

void Edia.Experiment.ProceedWithDelay ( float duration )

inline

Call next step in the trial with delay.

Parameters

duration

Time to wait before proceeding. Expects float

ShowMessageToExperimenter() [1/2]

void Edia.Experiment.ShowMessageToExperimenter ( string msg )

inline

Shows a message in the controlpanel.

Autohides the panel.

Parameters

msg	Message to show

ShowMessageToExperimenter() [2/2]

void Edia.Experiment.ShowMessageToExperimenter ( string msg, bool autohide )

inline

Shows a message in the controlpanel.

Parameters

msg	Message to show
autohide	Autohide the message

ShowMessageToUser() [1/4]

void Edia.Experiment.ShowMessageToUser ( List< string > msgs )

inline

Show a list of messages to the VR user, one at a time, in the MessagePanelInVR.

Parameters

msg	Messages to show

ShowMessageToUser() [2/4]

void Edia.Experiment.ShowMessageToUser ( string msg )

inline

Show a message to the VR user in an overlayed panel.

Default: Proceed button ON

Parameters

msg	Message to show

ShowMessageToUser() [3/4]

void Edia.Experiment.ShowMessageToUser ( string msg, bool showButton )

inline

Show a message to the VR user in the MessagePanelInVR.

Parameters

msg	Message to show
showButton	False = no button. To hide use HideMessagePanelToUser

ShowMessageToUser() [4/4]

void Edia.Experiment.ShowMessageToUser ( string msg, float duration )

inline

Show a message to the VR user in the MessagePanelInVR for a certain duration.

Does NOT auto proceed

Parameters

msg	Message to show
duration	Time to show the message

StoreMarker()

void Edia.Experiment.StoreMarker ( string annotation )

inline

Saves a marker with a timestamp to disk.

Also fires EvStoreMarker event with parameter.

Parameters

annotation

Annotation to store

---

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

• D:/Felix/Projects/EDIA/edia_core/Assets/com.edia.core/Runtime/Base/Scripts/Experiment/Experiment.cs