This class helps to call other Isis Applications in a Pipeline. More...

#include <Pipeline.h>

Collaboration diagram for Isis::Pipeline:

Public Member Functions
	Pipeline (const QString &procAppName="")
	This is the one and only Pipeline constructor.

	~Pipeline ()
	This destroys the pipeline.

void	Prepare ()
	This method is the core of the pipeline class.

void	Run ()
	This method executes the pipeline.

void	SetInputFile (const char *inputParam)
	This method is used to set the original input file.

void	SetInputFile (const QString &inputParam)
	This method is used to set the original input file.

void	SetInputFile (const char inputParam, const char virtualBandsParam)
	This method is used to set the original input file.

void	SetInputFile (const QString &inputParam, const QString &virtualBandsParam)
	This method is used to set the original input file.

void	SetInputListFile (const char *inputParam)
	This method is used to set the original input files.

void	SetInputListFile (const QString &inputParam)
	This method is used to set the original input files.

void	SetInputFile (const FileName &inputFileName)
	This method is used to set the original input file.

void	SetInputListFile (const FileName &inputFileName)
	This method is used to set the original input files.

void	SetOutputFile (const char *outputParam)
	This method is used to set the final output file.

void	SetOutputFile (const QString &outputParam)
	This method is used to set the final output file.

void	SetOutputFile (const FileName &outputFile)
	This method is used to set the final output file.

void	SetOutputListFile (const char *outputFileNameParam)
	This method is used to set an output list file.

void	SetOutputListFile (const QString &outputFileNameParam)
	This method is used to set an output list file.

void	SetOutputListFile (const FileName &outputFileNameList)
	This method is used to set an output list file.

void	KeepTemporaryFiles (bool keep)
	Set whether or not to keep temporary files (files generated in the middle of the pipeline that are neither the original input nor the final output).

bool	KeepTemporaryFiles ()
	Returns true if temporary files will not be deleted, false if they will.

void	AddPause ()
	Add a pause to the pipeline.

void	AddToPipeline (const QString &appname)
	Add a new program to the pipeline.

void	AddToPipeline (const QString &appname, const QString &identifier)
	Add a new program to the pipeline.

PipelineApplication &	Application (const QString &identifier)
	This is an accessor to get a specific PipelineApplication.

PipelineApplication &	Application (const int &index)
	This is an accessor to get a specific PipelineApplication.

void	SetFirstApplication (const QString &appname)
	This method disables all applications up to this one.

void	SetLastApplication (const QString &appname)
	This method disables all applications after to this one.

QString	Name () const
	Returns the name of the pipeline.

int	Size () const
	Returns the number of applications in the pipeline.

QString	OriginalInput (unsigned int branch)
	Returns the initial input file for the pipeline.

int	OriginalInputSize ()
	Returns the number of input files.

int	OriginalBranchesSize ()
	Returns the total number of input branches Original branches = Number of input files * Number of branches.

std::vector< QString >	OriginalBranches ()
	Returns the names of the original branches of the pipeline (input files * branches if any)

QString	FinalOutput (int branch=0, bool addModifiers=true)
	This gets the final output for the specified branch; this is necessary for the PipelineApplications to calculate the correct outputs to use.

QString	TemporaryFolder ()
	This method returns the user's temporary folder for temporary files.

void	EnableAllApplications ()
	This method re-enables all applications.

void	AddOriginalBranch (QString branch)
	Start off the branches directly from the pipeline.

void	SetContinue (bool pbFlag)
	Set the continue flag.

Private Attributes
int	p_pausePosition

QString	p_procAppName
	The name of the pipeline.

std::vector< QString >	p_originalInput
	The original input file.

std::vector< QString >	p_inputBranches
	Branches for input list.

std::vector< QString >	p_originalBranches
	The input file(s) + original branches from pipeline.

std::vector< QString >	p_finalOutput
	The final output file (empty if needs calculated)

std::vector< QString >	p_virtualBands
	The virtual bands string.

bool	p_keepTemporary
	True if keeping temporary files.

bool	p_addedCubeatt
	True if the "cubeatt" program was added.

std::vector< PipelineApplication * >	p_apps
	The pipeline applications.

std::vector< QString >	p_appIdentifiers
	The strings to identify the pipeline applications.

bool	p_outputListNeedsModifiers

bool	p_continue
	continue the execution even if exception is encountered.

Friends
std::ostream &	operator<< (std::ostream &os, Pipeline &pipeline)

Detailed Description

This class helps to call other Isis Applications in a Pipeline.

This object works by creating a Pipeline and setting the initial input, final output of the Pipeline which are got from the user interface. Applications are added to the Pipeline and parameters relevant to the application are set using relevant APIs'.

The Pipeline will control the flow of calls to the different applications in the Pipeline in First In First Out fashion. Also the first and last application in the Pipeline can be explicitly set. Pipeline automatically calculates the input to an application from the output of the previous application.

The Pipeline branches automatically for a list file with multiple input files or user can explicitly create branches from the Pipeline directly or from any application in the Pipeline. The branches are required when an application generates multiple outputs. Branches may be disabled / enabled and the Pipeline will figure out the input for an application whose previous app in the same branch was disabled.

Parameters for an application in a branch can be set commonly for all branches or explicitly for a branch by specifiying the branch name.

Option continue allows the pipeline to proceed with the execution inspite of any exceptions encountered while running an application in the pipeline. If continue is not enabled, then on encountering an exception the pipeline exits.

Temporary files are created and will be deleted when explicitly set by the user.

The Pipeline calls cubeatt app inherently if virtual bands are true.

It is suggested that you "cout" this object in order to debug you're usage of the class.

Refer to Applications thmproc, mocproc, hidestripe, hiproc, hinoise2 for Pipeline usage.

Here's an example usage of this class:

UserInterface &ui = Application::GetUserInterface();
Pipeline p("YourAppName");
 
p.SetInputFile("FROM", "BANDS");
p.SetOutputFile("TO");
 
p.KeepTemporaryFiles(!ui.GetBoolean("REMOVE"));
 
// The app "thm2isis" generates multiple outputs for a single input.
// Hence the branches have to be created to process the outputs odd, even.
p.AddToPipeline("thm2isis");
p.Application("thm2isis").SetInputParameter("FROM", false);
p.Application("thm2isis").SetOutputParameter("TO", "raw");
p.Application("thm2isis").AddBranch("even", PipelineApplication::ConstantStrings);
p.Application("thm2isis").AddBranch("odd", PipelineApplication::ConstantStrings);
 
p.AddToPipeline("spiceinit");
p.Application("spiceinit").SetInputParameter("FROM", false);
p.Application("spiceinit").AddParameter("PCK", "PCK");
p.Application("spiceinit").AddParameter("CK", "CK");
 
p.AddToPipeline("cam2map");
p.Application("cam2map").SetInputParameter("FROM", true);
p.Application("cam2map").SetOutputParameter("TO", "lev2");
p.Application("cam2map").AddParameter("even", "MAP", "MAP");
p.Application("cam2map").AddParameter("even", "PIXRES", "RESOLUTION");
 
if(ui.WasEntered("PIXRES")) {
  p.Application("cam2map").AddConstParameter("even", "PIXRES", "MPP");
}
 
p.Application("cam2map").AddParameter("odd", "MAP", PipelineApplication::LastOutput);
p.Application("cam2map").AddConstParameter("odd", "PIXRES", "MAP");
p.Application("cam2map").AddConstParameter("odd", "DEFAULTRANGE", "MAP");
 
if(ui.WasEntered("PIXRES")) {
  p.Application("cam2map").AddConstParameter("PIXRES", "MPP");
}
 
if(ui.GetBoolean("INGESTION")) {
  p.SetFirstApplication("thm2isis");
}
else{
  p.SetFirstApplication("spiceinit");
}
 
if(ui.GetBoolean("MAPPING")) {
  p.SetLastApplication("cam2map");
}
else {
  p.SetLastApplication("spiceinit");
}
 
p.Run();

Author: 2008-08-04 Steven Lambright

History

2008-09-25 Unknown - Added features: Application identifiers other than the application names, branched original input, branching from branches, partial branch merging (discontinuing branches*)

2008-10-28 Unknown - The input no longer has to have virtual bands if the SetInputFile(QString,QString) has an empty parameter name for the virtual bands parameter. SetInputListFile(...) method added.

2008-12-19 Unknown - List files are now fully supported, along with output list files.

2010-12-20 Sharmila Prasad - Added ability to add branches right off of the Pipeline

2010-12-21 Sharmila Prasad - Added documentation and ignore temp files from disabled branches

2011-02-09 Sharmila Prasad - Added option continue to proceed with execution even if an application in the pipeline encounters an exception.

2011-08-15 Debbie A. Cook - Added member p_pausePosition and method AddPause and modified method Run to allow the pipeline to be stopped temporarily and resumed. When AddPause is used, Run will need to be called an additional time for each AddPause included in the pipeline to resume the execution of the pipeline.

2012-11-21 Jeannie Backer - Added Progress output to indicate which application is running. Added padding to control statements. References # 795.

2016-08-28 Kelvin Rodriguez - Removed useless if statement comparing a reference variable to Null. Part of porting to OS X 10.11.

2021-17-03 Adam Paquette - Update SetInputListFile to use the FileList object rather than the TextFile object. Also updated SetInputListFile isisparameter function to chain into the SetInputListFile FileName function.

Definition at line 151 of file Pipeline.h.

Constructor & Destructor Documentation

◆ Pipeline()

Isis::Pipeline::Pipeline ( const QString & procAppName = "" )

This is the one and only Pipeline constructor.

This will initialize a pipeline object.

Parameters

procAppName This is an option parameter that gives the pipeline a name

History: 2011-08-15 Debbie A. Cook Added initialization for new member p_pausePosition

Definition at line 36 of file Pipeline.cpp.

References p_addedCubeatt, p_continue, and p_procAppName.

◆ ~Pipeline()

Isis::Pipeline::~Pipeline ( )

This destroys the pipeline.

Definition at line 49 of file Pipeline.cpp.

References p_apps.

Member Function Documentation

◆ AddOriginalBranch()

void Isis::Pipeline::AddOriginalBranch ( QString branch )

inline

Start off the branches directly from the pipeline.

Author: Sharmila Prasad (12/20/2010)

Parameters

branch - Branch name to be added

Definition at line 252 of file Pipeline.h.

References p_inputBranches, and p_originalBranches.

◆ AddPause()

void Isis::Pipeline::AddPause ( )

Add a pause to the pipeline.

History: 2011-08-15 Debbie A. Cook Original version

Definition at line 558 of file Pipeline.cpp.

References p_appIdentifiers, and p_apps.

◆ AddToPipeline() [1/2]

void Isis::Pipeline::AddToPipeline ( const QString & appname )

Add a new program to the pipeline.

This method must be called before calling Pipeline::Application(...) to access it. The string used to access this program will be the program's name.

Parameters

appname The name of the new application

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps

Definition at line 643 of file Pipeline.cpp.

References p_addedCubeatt, p_appIdentifiers, p_apps, Isis::IException::Programmer, and Isis::PipelineApplication::SetNext().

Referenced by Prepare().

◆ AddToPipeline() [2/2]

void Isis::Pipeline::AddToPipeline	(	const QString &	appname,
		const QString &	identifier )

Add a new program to the pipeline.

This method must be called before calling Pipeline::Application(...) to access it. The string identifier will access this program.

Parameters

appname	The name of the new application
identifier	The program's identifier for when calling Pipeline::Application

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps

Definition at line 581 of file Pipeline.cpp.

References p_addedCubeatt, p_appIdentifiers, p_apps, Isis::IException::Programmer, and Isis::PipelineApplication::SetNext().

◆ Application() [1/2]

PipelineApplication & Isis::Pipeline::Application ( const int & index )

This is an accessor to get a specific PipelineApplication.

This accessor is mainly in place for the output operator; it is not recommended.

Parameters

index The index of the pipeline application

Returns: PipelineApplication& The pipeline application

Definition at line 726 of file Pipeline.cpp.

References p_apps, Isis::IException::Programmer, and Size().

◆ Application() [2/2]

PipelineApplication & Isis::Pipeline::Application ( const QString & identifier )

This is an accessor to get a specific PipelineApplication.

This is the recommended accessor.

Parameters

identifier The identifier (usually name) of the application to access, such as "spiceinit"

Returns: PipelineApplication& The application's representation in the pipeline

Definition at line 696 of file Pipeline.cpp.

References p_appIdentifiers, p_apps, Isis::IException::Programmer, and Size().

Referenced by Prepare(), and Run().

◆ EnableAllApplications()

void Isis::Pipeline::EnableAllApplications ( )

This method re-enables all applications.

This resets the effects of PipelineApplication::Disable, SetFirstApplication and SetLastApplication.

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps

Definition at line 896 of file Pipeline.cpp.

References p_apps, and Size().

◆ FinalOutput()

QString Isis::Pipeline::FinalOutput	(	int	branch = 0,
		bool	addModifiers = true )

This gets the final output for the specified branch; this is necessary for the PipelineApplications to calculate the correct outputs to use.

Parameters

branch	Branch index to get the final output for
addModifiers	Whether or not to add the last name modifier

Returns: QString The final output string

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps

Definition at line 805 of file Pipeline.cpp.

References Isis::FileName::baseName(), p_apps, p_finalOutput, p_originalInput, Isis::FileName::path(), Isis::PipelineApplication::Previous(), and Isis::IException::Programmer.

Referenced by Isis::PipelineApplication::CalculateOutputFile().

◆ KeepTemporaryFiles() [1/2]

bool Isis::Pipeline::KeepTemporaryFiles ( )

inline

Returns true if temporary files will not be deleted, false if they will.

Definition at line 176 of file Pipeline.h.

References p_keepTemporary.

Referenced by Run().

◆ KeepTemporaryFiles() [2/2]

void Isis::Pipeline::KeepTemporaryFiles ( bool keep )

Set whether or not to keep temporary files (files generated in the middle of the pipeline that are neither the original input nor the final output).

Parameters

keep	True means don't delete, false means delete.

Definition at line 546 of file Pipeline.cpp.

References p_keepTemporary.

◆ Name()

QString Isis::Pipeline::Name ( ) const

inline

Returns the name of the pipeline.

Definition at line 192 of file Pipeline.h.

References p_procAppName.

Referenced by Run().

◆ OriginalBranches()

std::vector< QString > Isis::Pipeline::OriginalBranches ( )

inline

Returns the names of the original branches of the pipeline (input files * branches if any)

Definition at line 233 of file Pipeline.h.

References p_inputBranches, and p_originalBranches.

Referenced by Isis::PipelineApplication::PipelineApplication(), and Prepare().

◆ OriginalBranchesSize()

int Isis::Pipeline::OriginalBranchesSize ( )

inline

Returns the total number of input branches Original branches = Number of input files * Number of branches.

Author: Sharmila Prasad (12/20/2010)

Returns: int - Total number of branches

Definition at line 224 of file Pipeline.h.

References p_inputBranches, and p_originalBranches.

Referenced by Isis::PipelineApplication::CalculateInputFile().

◆ OriginalInput()

QString Isis::Pipeline::OriginalInput ( unsigned int branch )

inline

Returns the initial input file for the pipeline.

Parameters

branch Branch of the original input to get the filename from

Returns: QString Name of the original input file

Definition at line 207 of file Pipeline.h.

References p_originalInput.

Referenced by Isis::PipelineApplication::CalculateInputFile().

◆ OriginalInputSize()

int Isis::Pipeline::OriginalInputSize ( )

inline

Returns the number of input files.

Definition at line 212 of file Pipeline.h.

References p_originalInput.

Referenced by Isis::PipelineApplication::CalculateInputFile().

◆ Prepare()

void Isis::Pipeline::Prepare ( )

This method is the core of the pipeline class.

This method tells each PipelineApplication to learn about itself and calculate necessary filenames, execution calls, etc... Pipeline error checking happens in here, so if a Pipeline is invalid this method will throw the IException.

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps vector since a [ause is added as a NULL pointer.

Definition at line 69 of file Pipeline.cpp.

References AddToPipeline(), Application(), OriginalBranches(), p_addedCubeatt, p_appIdentifiers, p_apps, p_virtualBands, Isis::IException::Programmer, Isis::PipelineApplication::SetInputParameter(), and Isis::PipelineApplication::SetOutputParameter().

Referenced by Run().

◆ Run()

void Isis::Pipeline::Run ( )

This method executes the pipeline.

When you're ready to start your proc program, call this method.

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps vector since a pause is added as a NULL pointer. Also adjusted application loops for potential pauses.

Definition at line 199 of file Pipeline.cpp.

References Application(), Isis::PipelineApplication::Enabled(), KeepTemporaryFiles(), Name(), Isis::PipelineApplication::Name(), p_apps, p_continue, p_procAppName, Isis::PipelineApplication::ParamString(), Prepare(), Isis::ProgramLauncher::RunIsisProgram(), Isis::Progress::SetText(), Size(), Isis::PipelineApplication::TemporaryFiles(), and Isis::FileList::write().

◆ SetContinue()

void Isis::Pipeline::SetContinue ( bool pbFlag )

inline

Set the continue flag.

Author: Sharmila Prasad (2/9/2011)

Parameters

pbFlag - true/false

Definition at line 271 of file Pipeline.h.

References p_continue.

◆ SetFirstApplication()

void Isis::Pipeline::SetFirstApplication ( const QString & appname )

This method disables all applications up to this one.

Effectively, the application specified becomes the first application. This is not a guarantee that the application specified is enabled, it only guarantees no applications before it will be run.

Parameters

appname The program to start with

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps

Definition at line 748 of file Pipeline.cpp.

References p_apps, and Isis::IException::Programmer.

◆ SetInputFile() [1/5]

void Isis::Pipeline::SetInputFile ( const char * inputParam )

This method is used to set the original input file.

This file is the first program's input, and the virtual bands will be taken directly from this parameter.

Parameters

inputParam The parameter to get from the user interface that contains the input file

Definition at line 292 of file Pipeline.cpp.

References SetInputFile().

Referenced by SetInputFile(), and SetInputFile().

◆ SetInputFile() [2/5]

void Isis::Pipeline::SetInputFile	(	const char *	inputParam,
		const char *	virtualBandsParam )

This method is used to set the original input file.

This file is the first program's input.

Parameters

inputParam	The parameter to get from the user interface that contains the input file
virtualBandsParam	The parameter to get from the user interface that contains the virtual bands list; internal default is supported. Empty string if no virtual bands parameter exists.

Definition at line 400 of file Pipeline.cpp.

References SetInputFile().

◆ SetInputFile() [3/5]

void Isis::Pipeline::SetInputFile ( const FileName & inputFile )

This method is used to set the original input file.

No virtual bands will be read, and the inputFile parameter will be read as a path to a file instead of as a parameter.

Parameters

inputParam A filename object containing the location of the input file

History: 2010-12-20 Sharmila Prasad - Changed p_originalBranches array to p_inputBranches

Definition at line 324 of file Pipeline.cpp.

References p_inputBranches, p_originalInput, and p_virtualBands.

◆ SetInputFile() [4/5]

void Isis::Pipeline::SetInputFile ( const QString & inputParam )

This method is used to set the original input file.

This file is the first program's input, and the virtual bands will be taken directly from this parameter.

Parameters

inputParam The parameter to get from the user interface that contains the input file

History: 2010-12-20 Sharmila Prasad - Changed p_originalBranches array to p_inputBranches

Definition at line 307 of file Pipeline.cpp.

References Isis::Application::GetUserInterface(), p_inputBranches, p_originalInput, and p_virtualBands.

◆ SetInputFile() [5/5]

void Isis::Pipeline::SetInputFile	(	const QString &	inputParam,
		const QString &	virtualBandsParam )

This method is used to set the original input file.

This file is the first program's input.

Parameters

inputParam	The parameter to get from the user interface that contains the input file
virtualBandsParam	The parameter to get from the user interface that contains the virtual bands list; internal default is supported. Empty string if no virtual bands parameter exists.

History: 2010-12-20 Sharmila Prasad - Changed p_originalBranches array to p_inputBranches

Definition at line 418 of file Pipeline.cpp.

References Isis::Application::GetUserInterface(), p_inputBranches, p_originalInput, and p_virtualBands.

◆ SetInputListFile() [1/3]

void Isis::Pipeline::SetInputListFile ( const char * inputParam )

This method is used to set the original input files.

These files are the first program's input, a branch will be added for every line in the file, and the virtual bands will be taken directly from this parameter.

Parameters

inputParam The parameter to get from the user interface that contains the input file

Definition at line 339 of file Pipeline.cpp.

References SetInputListFile().

Referenced by SetInputListFile(), and SetInputListFile().

◆ SetInputListFile() [2/3]

void Isis::Pipeline::SetInputListFile ( const FileName & inputFileName )

This method is used to set the original input files.

These files are the first program's input, a branch will be added for every line in the file.

Parameters

inputParam The filename of the list file contains the input files

History: 2010-12-20 Sharmila Prasad - Changed p_originalBranches array to p_inputBranches

Definition at line 370 of file Pipeline.cpp.

References Isis::FileName::expanded(), Isis::FileName::name(), p_finalOutput, p_inputBranches, p_originalInput, p_virtualBands, and Isis::toString().

◆ SetInputListFile() [3/3]

void Isis::Pipeline::SetInputListFile ( const QString & inputParam )

This method is used to set the original input files.

These files are the first program's input, a branch will be added for every line in the file, and the virtual bands will be taken directly from this parameter.

Parameters

inputParam The parameter to get from the user interface that contains the input file

History: 2010-12-20 Sharmila Prasad - Changed p_originalBranches array to p_inputBranches

Definition at line 354 of file Pipeline.cpp.

References Isis::Application::GetUserInterface(), and SetInputListFile().

◆ SetLastApplication()

void Isis::Pipeline::SetLastApplication ( const QString & appname )

This method disables all applications after to this one.

Effectively, the application specified becomes the last application. This is not a guarantee that the application specified is enabled, it only guarantees no applications after it will be run.

Parameters

appname The program to end with

History: 2011-08-15 Debbie A. Cook Added check for NULL pointers in p_apps

Definition at line 778 of file Pipeline.cpp.

References p_apps, and Isis::IException::Programmer.

◆ SetOutputFile() [1/3]

void Isis::Pipeline::SetOutputFile ( const char * outputParam )

This method is used to set the final output file.

If no programs generate output, the final output file will not be used. If the output file was not entered, one will be generated automatically and placed into the current working folder.

Parameters

outputParam The parameter to get from the user interface that contains the output file; internal default is supported.

Definition at line 441 of file Pipeline.cpp.

References SetOutputFile().

Referenced by SetOutputFile().

◆ SetOutputFile() [2/3]

void Isis::Pipeline::SetOutputFile ( const FileName & outputFile )

This method is used to set the final output file.

If no programs generate output, the final output file will not be used. If the output file was not entered, one will be generated automatically and placed into the current working folder.

Parameters

outputFile The filename of the output file; NOT the parameter name.

Definition at line 473 of file Pipeline.cpp.

References p_finalOutput.

◆ SetOutputFile() [3/3]

void Isis::Pipeline::SetOutputFile ( const QString & outputParam )

This method is used to set the final output file.

If no programs generate output, the final output file will not be used. If the output file was not entered, one will be generated automatically and placed into the current working folder.

Parameters

outputParam The parameter to get from the user interface that contains the output file; internal default is supported.

Definition at line 455 of file Pipeline.cpp.

References Isis::Application::GetUserInterface(), and p_finalOutput.

◆ SetOutputListFile() [1/3]

void Isis::Pipeline::SetOutputListFile ( const char * outputFileNameParam )

This method is used to set an output list file.

Basically, this means the output filenames are specified in the list file. Internal defaults/automatic name calculations are supported.

Parameters

outputFileNameList Parameter name containing the path to the output list file

Definition at line 487 of file Pipeline.cpp.

References SetOutputListFile().

Referenced by SetOutputListFile(), and SetOutputListFile().

◆ SetOutputListFile() [2/3]

void Isis::Pipeline::SetOutputListFile ( const FileName & outputFileNameList )

This method is used to set an output list file.

Basically, this means the output filenames are specified in the list file.

Parameters

outputFileNameList List file with output cube names

Definition at line 525 of file Pipeline.cpp.

References p_finalOutput.

◆ SetOutputListFile() [3/3]

void Isis::Pipeline::SetOutputListFile ( const QString & outputFileNameParam )

This method is used to set an output list file.

Basically, this means the output filenames are specified in the list file. Internal defaults/automatic name calculations are supported.

Parameters

outputFileNameList Parameter name containing the path to the output list file

Definition at line 500 of file Pipeline.cpp.

References Isis::Application::GetUserInterface(), p_finalOutput, p_originalInput, and SetOutputListFile().

◆ Size()

int Isis::Pipeline::Size ( ) const

inline

Returns the number of applications in the pipeline.

Definition at line 196 of file Pipeline.h.

References p_apps.

Referenced by Application(), Application(), EnableAllApplications(), and Run().

◆ TemporaryFolder()

QString Isis::Pipeline::TemporaryFolder ( )

This method returns the user's temporary folder for temporary files.

It's simply a conveinient accessor to the user's preferences.

Returns: QString The temporary folder

Definition at line 882 of file Pipeline.cpp.

Referenced by Isis::PipelineApplication::BuildParamString(), and Isis::PipelineApplication::CalculateOutputFile().

Member Data Documentation

◆ p_addedCubeatt

bool Isis::Pipeline::p_addedCubeatt

private

True if the "cubeatt" program was added.

Definition at line 284 of file Pipeline.h.

Referenced by AddToPipeline(), AddToPipeline(), Pipeline(), and Prepare().

◆ p_appIdentifiers

std::vector< QString > Isis::Pipeline::p_appIdentifiers

private

The strings to identify the pipeline applications.

Definition at line 286 of file Pipeline.h.

Referenced by AddPause(), AddToPipeline(), AddToPipeline(), Application(), and Prepare().

◆ p_apps

std::vector< PipelineApplication * > Isis::Pipeline::p_apps

private

The pipeline applications.

Definition at line 285 of file Pipeline.h.

Referenced by AddPause(), AddToPipeline(), AddToPipeline(), Application(), Application(), EnableAllApplications(), FinalOutput(), Prepare(), Run(), SetFirstApplication(), SetLastApplication(), Size(), and ~Pipeline().

◆ p_continue

bool Isis::Pipeline::p_continue

private

continue the execution even if exception is encountered.

Definition at line 288 of file Pipeline.h.

Referenced by Pipeline(), Run(), and SetContinue().

◆ p_finalOutput

std::vector<QString> Isis::Pipeline::p_finalOutput

private

The final output file (empty if needs calculated)

Definition at line 281 of file Pipeline.h.

Referenced by FinalOutput(), SetInputListFile(), SetOutputFile(), SetOutputFile(), SetOutputListFile(), and SetOutputListFile().

◆ p_inputBranches

std::vector<QString> Isis::Pipeline::p_inputBranches

private

Branches for input list.

Definition at line 279 of file Pipeline.h.

Referenced by AddOriginalBranch(), OriginalBranches(), OriginalBranchesSize(), SetInputFile(), SetInputFile(), SetInputFile(), and SetInputListFile().

◆ p_keepTemporary

bool Isis::Pipeline::p_keepTemporary

private

True if keeping temporary files.

Definition at line 283 of file Pipeline.h.

Referenced by KeepTemporaryFiles(), and KeepTemporaryFiles().

◆ p_originalBranches

std::vector<QString> Isis::Pipeline::p_originalBranches

private

The input file(s) + original branches from pipeline.

Definition at line 280 of file Pipeline.h.

Referenced by AddOriginalBranch(), OriginalBranches(), and OriginalBranchesSize().

◆ p_originalInput

std::vector<QString> Isis::Pipeline::p_originalInput

private

The original input file.

Definition at line 278 of file Pipeline.h.

Referenced by FinalOutput(), OriginalInput(), OriginalInputSize(), SetInputFile(), SetInputFile(), SetInputFile(), SetInputListFile(), and SetOutputListFile().

◆ p_outputListNeedsModifiers

bool Isis::Pipeline::p_outputListNeedsModifiers

private

Definition at line 287 of file Pipeline.h.

◆ p_pausePosition

int Isis::Pipeline::p_pausePosition

private

Definition at line 276 of file Pipeline.h.

◆ p_procAppName

QString Isis::Pipeline::p_procAppName

private

The name of the pipeline.

Definition at line 277 of file Pipeline.h.

Referenced by Name(), Pipeline(), and Run().

◆ p_virtualBands

std::vector<QString> Isis::Pipeline::p_virtualBands

private

The virtual bands string.

Definition at line 282 of file Pipeline.h.

Referenced by Prepare(), SetInputFile(), SetInputFile(), SetInputFile(), and SetInputListFile().

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

src/base/objs/Pipeline/Pipeline.h
src/base/objs/Pipeline/Pipeline.cpp

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Pipeline()

◆ ~Pipeline()

Member Function Documentation

◆ AddOriginalBranch()

◆ AddPause()

◆ AddToPipeline() [1/2]

◆ AddToPipeline() [2/2]

◆ Application() [1/2]

◆ Application() [2/2]

◆ EnableAllApplications()

◆ FinalOutput()

◆ KeepTemporaryFiles() [1/2]

◆ KeepTemporaryFiles() [2/2]

◆ Name()

◆ OriginalBranches()

◆ OriginalBranchesSize()

◆ OriginalInput()

◆ OriginalInputSize()

◆ Prepare()

◆ Run()

◆ SetContinue()

◆ SetFirstApplication()

◆ SetInputFile() [1/5]

◆ SetInputFile() [2/5]

◆ SetInputFile() [3/5]

◆ SetInputFile() [4/5]

◆ SetInputFile() [5/5]

◆ SetInputListFile() [1/3]

◆ SetInputListFile() [2/3]

◆ SetInputListFile() [3/3]

◆ SetLastApplication()

◆ SetOutputFile() [1/3]

◆ SetOutputFile() [2/3]

◆ SetOutputFile() [3/3]

◆ SetOutputListFile() [1/3]

◆ SetOutputListFile() [2/3]

◆ SetOutputListFile() [3/3]

◆ Size()

◆ TemporaryFolder()

Member Data Documentation

◆ p_addedCubeatt

◆ p_appIdentifiers

◆ p_apps

◆ p_continue

◆ p_finalOutput

◆ p_inputBranches

◆ p_keepTemporary

◆ p_originalBranches

◆ p_originalInput

◆ p_outputListNeedsModifiers

◆ p_pausePosition

◆ p_procAppName

◆ p_virtualBands