Session schedule class. More...

#include <plux.h>

Public Member Functions
	Schedule (void)
	Initializes all structure fields.

Public Attributes
time_t	startTime
	Scheduled session start time or condition (1 or a time_t value).

int	duration
	Scheduled session duration limit in seconds.

int	nSessions
	Number of sessions to be recorded. Default value is one.

int	repeatPeriod
	Repetition period in seconds. Default value is zero.

float	baseFreq
	Acquisition base sampling frequency in Hertz. Default value is 1000.

Sources	sources
	Scheduled session sources.

String	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

◆ Schedule()

Plux::Schedule::Schedule ( void )

inline

Initializes all structure fields.

All arguments are optional. A structure field is initialized with the corresponding argument value, if provided. Otherwise, the field is initialized with its default value.

Member Data Documentation

◆ startTime

time_t Plux::Schedule::startTime

Scheduled session start time or condition (1 or a time_t value).

If this attribute has the value 1, the scheduled session will start when the digital port input changes. Otherwise, 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. Default value is 1.

◆ duration

int Plux::Schedule::duration

Scheduled session duration limit in seconds.

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

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

plux.h