Skip to content

Session Objects

ehennestad edited this page May 25, 2022 · 2 revisions

Properties

  • subjectID Id of subject (animal) for the session
  • sessionID Unique session id
  • Date Date of the experiment
  • Time Time of the experiment
  • Experiment Name of experiment which the session belongs to (char)
  • Protocol Name of experimental protocol for the session (char)
  • Description A custom description of the session (char)

Additionally, any table variable which is created in the Nansen app will also be added to the properties of the session object.

Methods

getSessionFolder : Get session folder for a given dataLocationName

  • sessionObject.getSessionFolder() returns the session folder for the default DataLocation

  • sessionObject.getSessionFolder(dataLocationName) returns the session folder for the given DataLocation name where dataLocationName is a char

saveData : Saves data for given variable

  • sessionObj.saveData(varName, data) saves data to the specified variable

  • sessionObj.saveData(varName, data, Name, Value, ...) saves data to the specified variable using options given as name-value pairs. The name value pairs only take effect if the specified variable does not exist in the Variable Model.

Note: If a variable already exists in the Variable Model, it can be loaded and saved without specifying the options. The following options can be set using name value pairs

OPTIONS:

  • DataLocation (char) : Specifies the name of the data location where the variable should be saved to
  • Subfolder (char) : Saves the variable in the given subfolder in the session folder.
  • FileType (char) : Save variable to a file of given type
  • FileAdapter (char) : FileAdapter to use for variable

See also getDataFilePath

loadData

getDataFilePath