PABatchTool Class Reference

Inheritance diagram for PABatchTool:

Public Types
enum	Events {   BatchToolStarting, BatchToolRunning, BatchToolComplete, BatchToolClosing,   SwitchToResults }

Public Member Functions
function	PABatchTool (in batchSettings)
	Class constructor. More...
function	close (in this, in varargin)
function	getSourceDirectoryCallback (in this, in hObject, in eventdata)
	Batch figure button callback for getting a directory of actigraph files to process. More...
function	getOutputDirectoryCallback (in this, in hObject, in eventdata)
	Batch figure button callback for getting a directory to save processed output files to. More...
function	setSourcePath (in this, in tmpSrcPath)
function	setOutputPath (in this, in tmpOutputPath)
function	calculateFilesFound (in this, in sourcePathname, in text_filesFound_h)
	Determines the number of actigraph files located in the specified source path and updates the GUI's count display. More...
function	updateOutputLogs (in this, in outputPathname, in text_outputLogs_h)
	Determines the number of actigraph files located in the specified source path and updates the GUI's count display. More...
function	startBatchProcessCallback (in this, in hObject, in eventdata)
	Callback that starts a batch process based on batch gui paramters. More...
function	waitbarCloseRequestCallback (in this, in hWaitbar, in ignoredArg)
function	waitbarCancelCallback (in this, in hCancelBtn, in eventData)

Static Public Member Functions
static function	getDefaultParameters ()
	Returns a structure of PABatchTool default, saveable parameters as a struct. More...
static function	prepLogFile (in settings)

Member Enumeration Documentation

enum PABatchTool::Events

Enumerator
BatchToolStarting
BatchToolRunning
BatchToolComplete
BatchToolClosing
SwitchToResults

Constructor & Destructor Documentation

function PABatchTool::PABatchTool

(

in

batchSettings

)

Class constructor.

Parameters

batchSettings

Struct containing settings to use for the batch process (optional). if it is not inclded then the getDefaultParameters() method will be called to obtain default values.

Return values

PABatchTool

Instance of PABatchTool.

Member Function Documentation

function PABatchTool::calculateFilesFound	(	in	this,
		in	sourcePathname,
		in	text_filesFound_h
	)

Determines the number of actigraph files located in the specified source path and updates the GUI's count display.

Parameters

this	Instance of PAController
text_sourcePath_h	Text graphic handle for placing the path selected on the GUI display
text_filesFound_h	Text graphic handle to place the number of actigraph files found in the source directory.

function PABatchTool::close	(	in	this,
		in	varargin
	)

static function PABatchTool::getDefaultParameters ( )

static

Returns a structure of PABatchTool default, saveable parameters as a struct.

Return values

pStruct

A structure of parameters which include the following fields featureFcn signalTagLine

function PABatchTool::getOutputDirectoryCallback	(	in	this,
		in	hObject,
		in	eventdata
	)

Batch figure button callback for getting a directory to save processed output files to.

Parameters

this	Instance of PAController
hObject	handle to buttont (see GCBO)
eventdata	reserved - to be defined in a future version of MATLAB

function PABatchTool::getSourceDirectoryCallback	(	in	this,
		in	hObject,
		in	eventdata
	)

Batch figure button callback for getting a directory of actigraph files to process.

Parameters

this	Instance of PAController
hObject	handle to buttont (see GCBO)
eventdata	reserved - to be defined in a future version of MATLAB

static function PABatchTool::prepLogFile ( in  settings )

static

function PABatchTool::setOutputPath	(	in	this,
		in	tmpOutputPath
	)

function PABatchTool::setSourcePath	(	in	this,
		in	tmpSrcPath
	)

function PABatchTool::startBatchProcessCallback	(	in	this,
		in	hObject,
		in	eventdata
	)

Callback that starts a batch process based on batch gui paramters.

Parameters

this	Instance of PAController
hObject	MATLAB graphic handle of the callback object
eventdata	reserved by MATLAB, not used.

function PABatchTool::updateOutputLogs	(	in	this,
		in	outputPathname,
		in	text_outputLogs_h
	)

Determines the number of actigraph files located in the specified source path and updates the GUI's count display.

Parameters

this	Instance of PAController
outputPathname	(optional) Pathname of output directory (string)
text_outputLogs_h	Text graphic handle to write results to.

function PABatchTool::waitbarCancelCallback	(	in	this,
		in	hCancelBtn,
		in	eventData
	)

function PABatchTool::waitbarCloseRequestCallback	(	in	this,
		in	hWaitbar,
		in	ignoredArg
	)

---

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

• c_version_comments/PABatchTool.cpp