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

Session schedule class with running attribute. More...

Inheritance diagram for plux.ScheduleEx:
plux.Schedule

Public Member Functions

 __init__ (self)
 Initializes Schedule attributes to their default values.
 

Public Attributes

 running
 True if this schedule is currently running or False otherwise.
 
- Public Attributes inherited from plux.Schedule
 startTime
 Scheduled session start time or condition (integer: 1, or a datetime.datetime; default value: 1).
 
 duration
 Scheduled session duration limit in seconds (integer: >= 0; default value: 0).
 
 nRepeats
 Number of session repetitions (integer: 0; default value: 0).
 
 repeatPeriod
 Repetition period in seconds (integer: 0; default value: 0).
 
 baseFreq
 Acquisition base sampling frequency in Hertz (float: > 0; default value: 1000).
 
 sources
 Scheduled session sources as a sequence of Source objects, or a single Source object.
 
 text
 Optional user text to store in Session.text attribute of saved sessions (maximum of 70 characters).
 

Detailed Description

Session schedule class with running attribute.

MemoryDev.getSchedules() returns objects of this class to specify which of the returned schedules is currently running (if any).

Constructor & Destructor Documentation

◆ __init__()

plux.ScheduleEx.__init__ (   self)

Initializes Schedule attributes to their default values.

Reimplemented from plux.Schedule.

Member Data Documentation

◆ running

plux.ScheduleEx.running

True if this schedule is currently running or False otherwise.