#include <Batch.h>

Inheritance diagram for Batch:

Public Types
enum	EndTask { DO_NOTHING = 0 , CLOSE_PTBATCHERGUI = 1 , SHUTDOWN = 2 , SUSPEND = 3 , HIBERNATE = 4 }

Public Member Functions
	Batch (wxFrame *parent)
	Main constructor.

	~Batch ()
	destructor

void	AddAppToBatch (wxString app)
	Adds an application entry in the batch list.

void	AddProjectToBatch (wxString projectFile, wxString outputFile=wxEmptyString, wxString userDefinedSequence=wxEmptyString, Project::Target target=Project::STITCHING)
	Adds a project entry in the batch list.

bool	AllDone ()
	Returns true if there are no more projects pending execution.

void	AppendBatchFile (wxString file)
	Appends projects from file to batch list.

void	CancelBatch ()
	Stops batch run, failing projects in progress.

void	CancelProject (int index)
	Cancels project at index in batch, failing it.

void	ChangePrefix (int index, wxString newPrefix)
	Changes output prefix for project at index.

void	ChangeUserDefined (int index, wxString newUserDefined)
	Changes user defined sequence for project at index.

int	ClearBatch ()
	Clears batch list and returns 0 if succesful.

bool	CompareProjectsInLists (int stitchListIndex, int batchListIndex)
	Compares two project at indexes in both lists and returns true if they have identical project ids.

int	GetFirstAvailable ()
	Returns index of first waiting project in batch.

int	GetIndex (int id)
	Returns index of project with selected id.

Project *	GetProject (int index)
	Returns project at index.

int	GetProjectCount ()
	Returns number of projects in batch list.

int	GetProjectCountByPath (wxString path)
	Returns number of projects in batch list with the input file path.

int	GetRunningCount ()
	Returns number of projects currently in progress.

Project::Status	GetStatus (int index)
	Returns current status of project at index.

bool	IsRunning ()
	return true, if batch is running

bool	IsPaused ()
	Returns true if batch execution is currently paused.

int	LoadBatchFile (wxString file)
	Clears current batch list and loads projects from batch file.

int	LoadTemp ()
	Loads temporary batch file.

bool	NoErrors ()
	Returns true if there are no failed projects in batch.

void	OnProcessTerminate (wxProcessEvent &event)
	Called internally when all running processes have completed and need to be removed from running list.

bool	OnStitch (wxString scriptFile, wxString outname, wxString userDefinedOutput, int id)
	Called to start stitch of project with input scriptFile.

bool	OnDetect (wxString scriptFile, wxString userDefinedAssistant, int id)
	called to start detecting

void	PauseBatch ()
	Pauses and continues batch execution.

void	RemoveProject (int id)
	Removes project with id from batch list.

void	RemoveProjectAtIndex (int selIndex)
	Removes project at index from batch list.

void	RunBatch ()
	Starts batch execution.

void	RunNextInBatch ()
	Starts execution of next waiting project in batch.

void	SaveBatchFile (wxString file)
	Saves batch list to file.

wxString	GetBatchFilename ()
	returns the filename of the default queue file

void	SaveTemp ()
	Saves batch list to temporary file.

void	SetStatus (int index, Project::Status status)
	Used internally to set status of selected project.

void	SwapProject (int index)
	Swaps position in batch of project at index with project at index+1.

void	ShowOutput (bool isVisible=true)
	Set visibility of all running projects.

size_t	GetFailedProjectsCount ()
	returns number of failed projects

wxString	GetFailedProjectName (unsigned int i)
	returns project file name of failed project with index i

wxString	GetFailedProjectLog (unsigned int i)
	returns log file name of failed project with index i

Public Attributes
bool	deleteFiles

EndTask	atEnd

bool	overwrite

bool	verbose

bool	autostitch

bool	autoremove

bool	saveLog

Private Attributes
wxConfigBase *	m_config

ProjectArray	m_projList

FrameArray	m_stitchFrames

bool	m_cancelled

bool	m_paused

bool	m_running

bool	m_clearedInProgress

std::vector< FailedProject >	m_failedProjects

wxPowerResourceBlocker *	m_resBlocker

Detailed Description

Definition at line 46 of file Batch.h.

Member Enumeration Documentation

◆ EndTask

enum Batch::EndTask

Enumerator
DO_NOTHING
CLOSE_PTBATCHERGUI
SHUTDOWN
SUSPEND
HIBERNATE

Definition at line 49 of file Batch.h.

Constructor & Destructor Documentation

◆ Batch()

Batch::Batch ( wxFrame * parent )

explicit

Main constructor.

Definition at line 48 of file Batch.cpp.

References atEnd, autoremove, autostitch, deleteFiles, DO_NOTHING, m_cancelled, m_clearedInProgress, m_paused, m_resBlocker, m_running, OnProcessTerminate(), overwrite, saveLog, threshold(), and verbose.

◆ ~Batch()

Batch::~Batch ( )

destructor

Definition at line 66 of file Batch.cpp.

References m_resBlocker, and threshold().

Member Function Documentation

◆ AddAppToBatch()

void Batch::AddAppToBatch ( wxString app )

Adds an application entry in the batch list.

Definition at line 74 of file Batch.cpp.

References m_projList, and threshold().

Referenced by AppendBatchFile(), and BatchFrame::OnButtonAddCommand().

◆ AddProjectToBatch()

void Batch::AddProjectToBatch	(	wxString	projectFile,
		wxString	outputFile = `wxEmptyString`,
		wxString	userDefinedSequence = `wxEmptyString`,
		Project::Target	target = `Project::STITCHING`
	)

Adds a project entry in the batch list.

Definition at line 80 of file Batch.cpp.

References Project::DETECTING, m_projList, and threshold().

Referenced by BatchFrame::AddArrayToList(), BatchFrame::AddDirToList(), BatchFrame::AddToList(), AppendBatchFile(), and OnProcessTerminate().

◆ AllDone()

bool Batch::AllDone ( )

Returns true if there are no more projects pending execution.

Definition at line 100 of file Batch.cpp.

References m_projList, Project::PAUSED, Project::RUNNING, threshold(), and Project::WAITING.

Referenced by OnProcessTerminate(), and RunNextInBatch().

◆ AppendBatchFile()

void Batch::AppendBatchFile ( wxString file )

Appends projects from file to batch list.

Definition at line 114 of file Batch.cpp.

References AddAppToBatch(), AddProjectToBatch(), Project::DETECTING, Project::FAILED, Project::idGenerator, m_projList, Project::PAUSED, Project::RUNNING, threshold(), and Project::WAITING.

Referenced by LoadBatchFile(), and LoadTemp().

◆ CancelBatch()

void Batch::CancelBatch ( )

Stops batch run, failing projects in progress.

Definition at line 184 of file Batch.cpp.

References CancelProject(), GetRunningCount(), m_cancelled, m_resBlocker, m_running, and threshold().

Referenced by ClearBatch(), and BatchFrame::OnButtonCancel().

◆ CancelProject()

void Batch::CancelProject ( int index )

Cancels project at index in batch, failing it.

Definition at line 198 of file Batch.cpp.

References GetRunningCount(), m_paused, m_running, m_stitchFrames, and threshold().

Referenced by CancelBatch(), and BatchFrame::OnButtonSkip().

◆ ChangePrefix()

void Batch::ChangePrefix	(	int	index,
		wxString	newPrefix
	)

Changes output prefix for project at index.

Definition at line 211 of file Batch.cpp.

References m_projList, and threshold().

Referenced by BatchFrame::ChangePrefix().

◆ ChangeUserDefined()

void Batch::ChangeUserDefined	(	int	index,
		wxString	newUserDefined
	)

Changes user defined sequence for project at index.

Definition at line 216 of file Batch.cpp.

References m_projList, and threshold().

Referenced by BatchFrame::ChangeUserDefined(), and BatchFrame::OnButtonChangeUserDefinedSequence().

◆ ClearBatch()

int Batch::ClearBatch ( )

Clears batch list and returns 0 if succesful.

Definition at line 221 of file Batch.cpp.

References CancelBatch(), hugin_utils::HuginMessageBox(), Project::idGenerator, m_clearedInProgress, m_projList, m_stitchFrames, and threshold().

Referenced by LoadBatchFile(), BatchFrame::OnButtonClear(), and BatchFrame::OnClose().

◆ CompareProjectsInLists()

bool Batch::CompareProjectsInLists	(	int	stitchListIndex,
		int	batchListIndex
	)

Compares two project at indexes in both lists and returns true if they have identical project ids.

Definition at line 248 of file Batch.cpp.

References m_projList, m_stitchFrames, and threshold().

Referenced by BatchFrame::OnButtonSkip().

◆ GetBatchFilename()

wxString Batch::GetBatchFilename ( )

returns the filename of the default queue file

Definition at line 888 of file Batch.cpp.

References hugin_utils::GetUserAppDataDir(), and threshold().

Referenced by LoadTemp(), and SaveTemp().

◆ GetFailedProjectLog()

wxString Batch::GetFailedProjectLog ( unsigned int i )

returns log file name of failed project with index i

Definition at line 943 of file Batch.cpp.

References m_failedProjects, and threshold().

Referenced by FailedProjectsDialog::OnSelectProject().

◆ GetFailedProjectName()

wxString Batch::GetFailedProjectName ( unsigned int i )

returns project file name of failed project with index i

Definition at line 931 of file Batch.cpp.

References m_failedProjects, and threshold().

◆ GetFailedProjectsCount()

size_t Batch::GetFailedProjectsCount ( )

inline

returns number of failed projects

Definition at line 145 of file Batch.h.

References m_failedProjects.

Referenced by BatchFrame::OnBatchFailed().

◆ GetFirstAvailable()

int Batch::GetFirstAvailable ( )

Returns index of first waiting project in batch.

Definition at line 253 of file Batch.cpp.

References m_projList, threshold(), and Project::WAITING.

Referenced by RunNextInBatch().

◆ GetIndex()

int Batch::GetIndex ( int id )

Returns index of project with selected id.

Definition at line 278 of file Batch.cpp.

References m_projList, and threshold().

Referenced by OnProcessTerminate(), and RemoveProject().

◆ GetProject()

Project * Batch::GetProject ( int index )

Returns project at index.

Definition at line 290 of file Batch.cpp.

References m_projList.

Referenced by BatchFrame::AddArrayToList(), BatchFrame::AddDirToList(), BatchFrame::AddToList(), ProjectListBox::ChangePrefix(), ProjectListBox::ChangeUserDefined(), ProjectListBox::Fill(), BatchFrame::OnButtonAddCommand(), BatchFrame::OnButtonChangePrefix(), BatchFrame::OnButtonChangeUserDefinedSequence(), BatchFrame::OnButtonOpenWithHugin(), BatchFrame::OnButtonRemoveFromList(), BatchFrame::OnButtonReset(), ProjectListBox::OnContextMenu(), BatchFrame::OnRefillListBox(), and BatchFrame::OnUpdateListBox().

◆ GetProjectCount()

int Batch::GetProjectCount ( )

Returns number of projects in batch list.

Definition at line 295 of file Batch.cpp.

References m_projList.

Referenced by BatchFrame::AddArrayToList(), BatchFrame::AddDirToList(), BatchFrame::AddToList(), BatchFrame::ChangePrefix(), BatchFrame::ChangeUserDefined(), ProjectListBox::Fill(), BatchFrame::OnButtonAddCommand(), BatchFrame::OnClose(), and BatchFrame::OnUpdateListBox().

◆ GetProjectCountByPath()

int Batch::GetProjectCountByPath ( wxString path )

Returns number of projects in batch list with the input file path.

Definition at line 300 of file Batch.cpp.

References m_projList, and threshold().

◆ GetRunningCount()

int Batch::GetRunningCount ( )

Returns number of projects currently in progress.

Definition at line 313 of file Batch.cpp.

References m_stitchFrames.

Referenced by CancelBatch(), CancelProject(), BatchFrame::OnButtonPause(), BatchFrame::OnButtonResetAll(), BatchFrame::OnButtonSkip(), OnProcessTerminate(), BatchFrame::OnProcessTerminate(), and PauseBatch().

◆ GetStatus()

Project::Status Batch::GetStatus ( int index )

Returns current status of project at index.

Definition at line 318 of file Batch.cpp.

References hugin_utils::HuginMessageBox(), m_projList, Project::MISSING, Project::status, and threshold().

Referenced by BatchFrame::OnButtonRemoveComplete(), BatchFrame::OnButtonRemoveFromList(), BatchFrame::OnButtonReset(), BatchFrame::OnButtonSkip(), and BatchFrame::OnUpdateListBox().

◆ IsPaused()

bool Batch::IsPaused ( )

Returns true if batch execution is currently paused.

Definition at line 336 of file Batch.cpp.

References m_paused.

Referenced by BatchFrame::IsPaused(), BatchFrame::OnButtonPause(), BatchFrame::OnButtonRunBatch(), BatchFrame::UpdateTaskBarProgressBar(), and BatchFrame::UpdateTrayIcon().

◆ IsRunning()

bool Batch::IsRunning ( )

return true, if batch is running

Definition at line 331 of file Batch.cpp.

References m_running.

Referenced by BatchFrame::IsRunning(), and BatchFrame::UpdateTrayIcon().

◆ LoadBatchFile()

int Batch::LoadBatchFile ( wxString file )

Clears current batch list and loads projects from batch file.

Definition at line 341 of file Batch.cpp.

References AppendBatchFile(), ClearBatch(), hugin_utils::HuginMessageBox(), and threshold().

Referenced by BatchFrame::OnButtonOpenBatch().

◆ LoadTemp()

int Batch::LoadTemp ( )

Loads temporary batch file.

Definition at line 361 of file Batch.cpp.

References AppendBatchFile(), GetBatchFilename(), and threshold().

Referenced by BatchFrame::BatchFrame().

◆ NoErrors()

bool Batch::NoErrors ( )

Returns true if there are no failed projects in batch.

Definition at line 372 of file Batch.cpp.

References Project::FAILED, m_projList, and threshold().

Referenced by BatchFrame::OnButtonRemoveComplete(), and OnProcessTerminate().

◆ OnDetect()

bool Batch::OnDetect	(	wxString	scriptFile,
		wxString	userDefinedAssistant,
		int	id
	)

called to start detecting

Definition at line 667 of file Batch.cpp.

References m_stitchFrames, threshold(), and verbose.

Referenced by RunNextInBatch().

◆ OnProcessTerminate()

void Batch::OnProcessTerminate ( wxProcessEvent & event )

Called internally when all running processes have completed and need to be removed from running list.

Definition at line 384 of file Batch.cpp.

References AddProjectToBatch(), AllDone(), atEnd, autoremove, autostitch, CLOSE_PTBATCHERGUI, Project::DETECTING, DO_NOTHING, Project::FAILED, Project::FINISHED, GetIndex(), GetRunningCount(), HIBERNATE, m_cancelled, m_clearedInProgress, m_failedProjects, m_paused, m_projList, m_resBlocker, m_running, m_stitchFrames, NoErrors(), FailedProject::project, RemoveProjectAtIndex(), RunNextInBatch(), saveLog, SaveTemp(), SHUTDOWN, Project::STITCHING, SUSPEND, and threshold().

Referenced by Batch().

◆ OnStitch()

bool Batch::OnStitch	(	wxString	scriptFile,
		wxString	outname,
		wxString	userDefinedOutput,
		int	id
	)

Called to start stitch of project with input scriptFile.

Definition at line 584 of file Batch.cpp.

References m_stitchFrames, overwrite, threshold(), and verbose.

Referenced by RunNextInBatch().

◆ PauseBatch()

void Batch::PauseBatch ( )

Pauses and continues batch execution.

Definition at line 695 of file Batch.cpp.

References GetRunningCount(), m_paused, m_projList, m_stitchFrames, Project::PAUSED, Project::RUNNING, and threshold().

Referenced by BatchFrame::OnButtonPause().

◆ RemoveProject()

void Batch::RemoveProject ( int id )

Removes project with id from batch list.

Definition at line 729 of file Batch.cpp.

References GetIndex(), hugin_utils::HuginMessageBox(), RemoveProjectAtIndex(), and threshold().

◆ RemoveProjectAtIndex()

void Batch::RemoveProjectAtIndex ( int selIndex )

Removes project at index from batch list.

Definition at line 741 of file Batch.cpp.

References deleteFiles, Project::FINISHED, hugin_utils::HuginMessageBox(), Project::idGenerator, m_projList, and threshold().

Referenced by BatchFrame::OnButtonRemoveComplete(), BatchFrame::OnButtonRemoveFromList(), OnProcessTerminate(), and RemoveProject().

◆ RunBatch()

void Batch::RunBatch ( )

Starts batch execution.

Definition at line 764 of file Batch.cpp.

References m_failedProjects, m_resBlocker, m_running, RunNextInBatch(), and threshold().

Referenced by BatchFrame::RunBatch().

◆ RunNextInBatch()

void Batch::RunNextInBatch ( )

Starts execution of next waiting project in batch.

Definition at line 780 of file Batch.cpp.

References AllDone(), Project::FAILED, Project::FINISHED, GetFirstAvailable(), m_projList, m_running, Project::MISSING, OnDetect(), OnStitch(), Project::RUNNING, Project::STITCHING, and threshold().

Referenced by OnProcessTerminate(), and RunBatch().

◆ SaveBatchFile()

void Batch::SaveBatchFile ( wxString file )

Saves batch list to file.

Definition at line 851 of file Batch.cpp.

References Project::DETECTING, Project::idGenerator, m_projList, Project::STITCHING, and threshold().

Referenced by BatchFrame::OnButtonSaveBatch(), and SaveTemp().

◆ SaveTemp()

void Batch::SaveTemp ( )

◆ SetStatus()

void Batch::SetStatus	(	int	index,
		Project::Status	status
	)

Used internally to set status of selected project.

Definition at line 905 of file Batch.cpp.

References hugin_utils::HuginMessageBox(), m_projList, and threshold().

Referenced by BatchFrame::OnButtonReset(), BatchFrame::OnButtonResetAll(), BatchFrame::OnButtonSkip(), and BatchFrame::OnUpdateListBox().

◆ ShowOutput()

void Batch::ShowOutput ( bool isVisible = true )

Set visibility of all running projects.

Parameters

isVisible If true display the project output, otherwise hide it.

Definition at line 923 of file Batch.cpp.

References m_stitchFrames, and threshold().

Referenced by BatchFrame::OnCheckVerbose(), BatchFrame::OnMinimize(), and BatchFrame::UpdateBatchVerboseStatus().

◆ SwapProject()

void Batch::SwapProject ( int index )

Swaps position in batch of project at index with project at index+1.

Definition at line 917 of file Batch.cpp.

References m_projList.

Referenced by BatchFrame::SwapProject().

Member Data Documentation

◆ atEnd

EndTask Batch::atEnd

Definition at line 58 of file Batch.h.

Referenced by Batch(), BatchFrame::OnChoiceEnd(), OnProcessTerminate(), BatchFrame::PropagateDefaults(), and BatchFrame::SetCheckboxes().

◆ autoremove

bool Batch::autoremove

Definition at line 62 of file Batch.h.

Referenced by Batch(), BatchFrame::OnCheckAutoRemove(), OnProcessTerminate(), BatchFrame::PropagateDefaults(), and BatchFrame::SetCheckboxes().

◆ autostitch

bool Batch::autostitch

Definition at line 61 of file Batch.h.

Referenced by Batch(), BatchFrame::OnCheckAutoStitch(), OnProcessTerminate(), BatchFrame::PropagateDefaults(), and BatchFrame::SetCheckboxes().

◆ deleteFiles

bool Batch::deleteFiles

Definition at line 57 of file Batch.h.

Referenced by Batch(), and RemoveProjectAtIndex().

◆ m_cancelled

bool Batch::m_cancelled

private

Definition at line 163 of file Batch.h.

Referenced by Batch(), CancelBatch(), and OnProcessTerminate().

◆ m_clearedInProgress

bool Batch::m_clearedInProgress

private

Definition at line 166 of file Batch.h.

Referenced by Batch(), ClearBatch(), and OnProcessTerminate().

◆ m_config

wxConfigBase* Batch::m_config

private

Definition at line 156 of file Batch.h.

◆ m_failedProjects

std::vector<FailedProject> Batch::m_failedProjects

private

Definition at line 169 of file Batch.h.

Referenced by GetFailedProjectLog(), GetFailedProjectName(), GetFailedProjectsCount(), OnProcessTerminate(), and RunBatch().

◆ m_paused

bool Batch::m_paused

private

Definition at line 164 of file Batch.h.

Referenced by Batch(), CancelProject(), IsPaused(), OnProcessTerminate(), and PauseBatch().

◆ m_projList

ProjectArray Batch::m_projList

private

Definition at line 158 of file Batch.h.

Referenced by AddAppToBatch(), AddProjectToBatch(), AllDone(), AppendBatchFile(), ChangePrefix(), ChangeUserDefined(), ClearBatch(), CompareProjectsInLists(), GetFirstAvailable(), GetIndex(), GetProject(), GetProjectCount(), GetProjectCountByPath(), GetStatus(), NoErrors(), OnProcessTerminate(), PauseBatch(), RemoveProjectAtIndex(), RunNextInBatch(), SaveBatchFile(), SetStatus(), and SwapProject().

◆ m_resBlocker

wxPowerResourceBlocker* Batch::m_resBlocker

private

Definition at line 170 of file Batch.h.

Referenced by Batch(), CancelBatch(), OnProcessTerminate(), RunBatch(), and ~Batch().

◆ m_running

bool Batch::m_running

private

Definition at line 165 of file Batch.h.

Referenced by Batch(), CancelBatch(), CancelProject(), IsRunning(), OnProcessTerminate(), RunBatch(), and RunNextInBatch().

◆ m_stitchFrames

FrameArray Batch::m_stitchFrames

private

Definition at line 160 of file Batch.h.

Referenced by CancelProject(), ClearBatch(), CompareProjectsInLists(), GetRunningCount(), OnDetect(), OnProcessTerminate(), OnStitch(), PauseBatch(), and ShowOutput().

◆ overwrite

bool Batch::overwrite

Definition at line 59 of file Batch.h.

Referenced by Batch(), BatchFrame::OnCheckOverwrite(), OnStitch(), BatchFrame::PropagateDefaults(), and BatchFrame::SetCheckboxes().

◆ saveLog

bool Batch::saveLog

Definition at line 63 of file Batch.h.

Referenced by Batch(), BatchFrame::OnCheckSaveLog(), OnProcessTerminate(), and BatchFrame::SetCheckboxes().

◆ verbose

bool Batch::verbose

Definition at line 60 of file Batch.h.

Referenced by Batch(), BatchFrame::OnCheckVerbose(), OnDetect(), BatchFrame::OnMinimize(), OnStitch(), BatchFrame::PropagateDefaults(), BatchFrame::SetCheckboxes(), BatchFrame::SetInternalVerbose(), and BatchFrame::UpdateBatchVerboseStatus().

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

hugin1/ptbatcher/Batch.h
hugin1/ptbatcher/Batch.cpp

Public Types

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EndTask

Constructor & Destructor Documentation

◆ Batch()

◆ ~Batch()

Member Function Documentation

◆ AddAppToBatch()

◆ AddProjectToBatch()

◆ AllDone()

◆ AppendBatchFile()

◆ CancelBatch()

◆ CancelProject()

◆ ChangePrefix()

◆ ChangeUserDefined()

◆ ClearBatch()

◆ CompareProjectsInLists()

◆ GetBatchFilename()

◆ GetFailedProjectLog()

◆ GetFailedProjectName()

◆ GetFailedProjectsCount()

◆ GetFirstAvailable()

◆ GetIndex()

◆ GetProject()

◆ GetProjectCount()

◆ GetProjectCountByPath()

◆ GetRunningCount()

◆ GetStatus()

◆ IsPaused()

◆ IsRunning()

◆ LoadBatchFile()

◆ LoadTemp()

◆ NoErrors()

◆ OnDetect()

◆ OnProcessTerminate()

◆ OnStitch()

◆ PauseBatch()

◆ RemoveProject()

◆ RemoveProjectAtIndex()

◆ RunBatch()

◆ RunNextInBatch()

◆ SaveBatchFile()

◆ SaveTemp()

◆ SetStatus()

◆ ShowOutput()

◆ SwapProject()

Member Data Documentation

◆ atEnd

◆ autoremove

◆ autostitch

◆ deleteFiles

◆ m_cancelled

◆ m_clearedInProgress

◆ m_config

◆ m_failedProjects

◆ m_paused

◆ m_projList

◆ m_resBlocker

◆ m_running

◆ m_stitchFrames

◆ overwrite

◆ saveLog

◆ verbose