Python API
Loading...
Searching...
No Matches
plux.Session Class Reference

Stored session header class. More...

Public Member Functions

 __init__ (self)
 

Public Attributes

 startTime
 Session start time as a datetime.datetime object.
 
 schedStartTime
 The Schedule.startTime attribute value of the schedule associated with this session (unique schedule identifier).
 
 nFrames
 Total number of frames in the stored session as an integer.
 
 baseFreq
 Session acquisition base sampling frequency in Hertz as a float.
 
 sources
 Session sources as a tuple of SourceEx objects.
 
 text
 Optional user text from the Schedule.text attribute of the schedule associated with this session.
 
 properties
 Additional session properties as a dictionary of string keywords to associated values.
 

Detailed Description

Stored session header class.

MemoryDev.getSessions() returns objects of this class.

Constructor & Destructor Documentation

◆ __init__()

plux.Session.__init__ (   self)

Member Data Documentation

◆ startTime

plux.Session.startTime

Session start time as a datetime.datetime object.

This attribute value is unique to each session stored on the device, so this attribute is used as a session identifier in MemoryDev.replaySession().

◆ schedStartTime

plux.Session.schedStartTime

The Schedule.startTime attribute value of the schedule associated with this session (unique schedule identifier).

◆ nFrames

plux.Session.nFrames

Total number of frames in the stored session as an integer.

◆ baseFreq

plux.Session.baseFreq

Session acquisition base sampling frequency in Hertz as a float.

◆ sources

plux.Session.sources

Session sources as a tuple of SourceEx objects.

◆ text

plux.Session.text

Optional user text from the Schedule.text attribute of the schedule associated with this session.

◆ properties

plux.Session.properties

Additional session properties as a dictionary of string keywords to associated values.