plux.Schedule Class Reference

Session schedule class. More...

Inheritance diagram for plux.Schedule:

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

Public Attributes
	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.

A session schedule contains all the information needed to start an internal acquisition session.

See also

MemoryDev.addSchedule(), MemoryDev.getSchedules()

Constructor & Destructor Documentation

__init__()

plux.Schedule.__init__

(

self

)

Initializes Schedule attributes to their default values.

Reimplemented in plux.ScheduleEx.

Member Data Documentation

startTime

plux.Schedule.startTime

Scheduled session start time or condition (integer: 1, or a datetime.datetime; default value: 1).

If this attribute has the integer value 1, the scheduled session will start when the digital port input changes. If this attribute is a datetime.datetime object, the scheduled session will start when the device real-time clock reaches this value.

This attribute value is unique to each schedule on the device, so this attribute is used as a schedule identifier in MemoryDev.deleteSchedule() and Session.schedStartTime.

duration

plux.Schedule.duration

Scheduled session duration limit in seconds (integer: >= 0; default value: 0).

If this attribute is zero, no session duration limit is set. An internal acquisition session can always be stopped by calling MemoryDev.stopSessionAcq().

nRepeats

plux.Schedule.nRepeats

Number of session repetitions (integer: 0; default value: 0).

This attribute is not yet supported by current devices.

repeatPeriod

plux.Schedule.repeatPeriod

Repetition period in seconds (integer: 0; default value: 0).

This attribute is not yet supported by current devices.

baseFreq

plux.Schedule.baseFreq

Acquisition base sampling frequency in Hertz (float: > 0; default value: 1000).

sources

plux.Schedule.sources

Scheduled session sources as a sequence of Source objects, or a single Source object.

text

plux.Schedule.text

Optional user text to store in Session.text attribute of saved sessions (maximum of 70 characters).