Isis 3 Programmer Reference
Isis::PipelineApplication Class Reference

This class represents one application in the pipeline. More...

#include <PipelineApplication.h>

Collaboration diagram for Isis::PipelineApplication:
Collaboration graph

Public Types

enum  NameModifierType { ConstantStrings }
 This is used for branches. More...
 
enum  CustomParameterValue { LastOutput, LastAppOutputList, LastAppOutputListNoMerge }
 This is used to set custom values that must be calculated on the fly. More...
 

Public Member Functions

 PipelineApplication (QString appName, Pipeline *pipe)
 Constructs the first pipeline application. More...
 
 PipelineApplication (QString appName, PipelineApplication *previous)
 Constructs subsequent pipeline applications. More...
 
 ~PipelineApplication ()
 This is the destructor. More...
 
const QString & Name () const
 Get the name of this pipeline application. More...
 
const std::vector< QString > & ParamString () const
 Get the parameters for running this program; one element in the vector per run. More...
 
const std::vector< QString > & InputBranches () const
 Get the branches this program expects as input. More...
 
const std::vector< QString > & OutputBranches () const
 Get the branches this program has as output. More...
 
void Enable ()
 This method enables this program to be run. More...
 
void Disable ()
 This method disables this program, causing it to be ignored. More...
 
const bool & Enabled () const
 Returns true if this program will be run. More...
 
void SetInputParameter (const QString &inputParamName, bool supportsVirtualBands)
 Set the input parameter for this application and whether or not this application supports the virtual bands functionality. More...
 
void SetInputParameter (const QString &inputParamName, CustomParameterValue value, bool supportsVirtualBands)
 Set the input parameter for this application and whether or not this application supports the virtual bands functionality. More...
 
void SetOutputParameter (const QString &outputParamName, const QString &outNameModifier, const QString &outFileExtension="cub")
 Set the output parameter for this application and it's naming convention. More...
 
void SetOutputParameter (const QString &branch, const QString &outputParamName, const QString &outNameModifier, const QString &outFileExtension)
 Set the output parameter for a branch of this application and it's naming convention. More...
 
void AddBranch (const QString &modString, NameModifierType type)
 This method adds branch to this program. More...
 
void AddParameter (const QString &inputParamName, const QString &appParamName)
 This method adds knowledge of a parameter to the application. More...
 
void AddParameter (const QString &branch, const QString &inputParamName, const QString &appParamName)
 This method adds knowledge of a parameter to this application, that will only affect the specified branch. More...
 
void AddConstParameter (const QString &appParamName, const QString &appParamValue)
 This method adds a parameter to this application with a known value (does not get it from the user interface, must be specified). More...
 
void AddConstParameter (const QString &branch, const QString &appParamName, const QString &appParamValue)
 This method adds a parameter to this application with a known value (does not get it from the user interface, must be specified) that only affects a single branch. More...
 
void AddParameter (const QString &appParamName, CustomParameterValue value)
 This method adds a parameter with a calculated value (special) to this application. More...
 
void AddParameter (const QString &branch, const QString &appParamName, CustomParameterValue value)
 This method adds a parameter with a calculated value (special) to this application that only affects the specified branch. More...
 
QString OutputNameModifier ()
 This returns this application's output name modifier. More...
 
QString OutputExtension ()
 This returns this application's output file name's extension. More...
 
std::vector< QString > & GetOutputs ()
 This returns this application's output files. Only valid after BuildParamString is called. More...
 
std::vector< QString > TemporaryFiles ()
 This method returns a list of the temporary files generated by this program. More...
 
void SetNext (PipelineApplication *next)
 Link to the next application in the pipeline. More...
 
void SetPrevious (PipelineApplication *prev)
 Link to the previous application in the pipeline. More...
 
void BuildParamString ()
 This method calculates the inputs, outputs and necessary calls to this program for the pipeline. More...
 
PipelineApplicationNext () const
 This returns the next enabled pipeline application or null. More...
 
PipelineApplicationPrevious () const
 This returns the last enabled pipeline application or null. More...
 
PipelineApplicationPreviousOutputer () const
 This returns the previous enabled pipeline application that makes output or null. More...
 
bool SupportsVirtualBands ()
 Returns true if virtual bands are supported. More...
 
void SetVirtualBands (std::vector< QString > bands)
 Set the virtual bands that this application is to apply. More...
 
void EnableBranch (QString branch, bool flag)
 Enable/Disable Branch given the branch name. More...
 
bool BranchEnabled (int branch)
 Check whether a branch is enabled given branch index. More...
 
void SetContinue (bool pbFlag)
 Set the continue flag status. More...
 
bool Continue (void)
 Get the continue flag status. More...
 

Private Member Functions

bool FutureOutputFileCreated ()
 Returns true if a future application creates output. More...
 
bool LastApplicationWithOutput ()
 Returns true if this is the last application with output. More...
 
PipelineGetPipeline ()
 Returns the pipeline. More...
 
bool Branches ()
 Return true is this application does branch (one input branch, multiple output) More...
 
bool Merges ()
 Returns true if this application does merge branches (multiple input branches, one output) More...
 
bool StringStartsWith (QString from, QString compare)
 String comparison helper, returns true if from starts with compare bool. More...
 
QString CalculateInputFile (int branch)
 This method calculates the input file for the specified branch. More...
 
QString CalculateOutputFile (int branch)
 This method calculates the output file for the specified branch. More...
 
QString GetRealLastOutput (bool skipOne=false)
 This method is used to calculate the value for CustomParameterValue::LastOutput. More...
 
PipelineParameterGetInputParameter (int branch)
 This gets the input parameter for the specified branch. More...
 
int FindBranch (QString name, bool input=true)
 The method, given a string, finds the index of a branch. More...
 

Private Attributes

bool p_continue
 Continue the pipeline execution even if an error is encountered by this app. More...
 
bool p_enabled
 This application enabled? More...
 
bool p_supportsVirtualBands
 This application supports virtual bands? More...
 
QString p_name
 Name of this application. More...
 
std::vector< QString > p_outputs
 Actual output files. More...
 
std::vector< QString > p_tempFiles
 Actial temporary files. More...
 
std::vector< QString > p_paramString
 Built parameter strings. More...
 
std::vector< QString > p_inBranches
 Input branches. More...
 
std::vector< QString > p_outBranches
 Output branches. More...
 
std::vector< bool > p_enableBranch
 Branch enabled/disabled. More...
 
std::vector< PipelineParameterp_output
 Output parameters. More...
 
QString p_outputMod
 Output file name modifier. More...
 
QString p_outputExtension
 Output file name extension. More...
 
std::vector< QString > p_virtualBands
 Virtual bands string to add (empty if none) More...
 
std::vector< PipelineParameterp_input
 Input parameters. More...
 
std::vector< PipelineParameterp_params
 Regular parameters. More...
 
PipelineApplicationp_previous
 Previous pipeline application. More...
 
PipelineApplicationp_next
 Next pipeline application. More...
 
Pipelinep_pipeline
 The pipeline. More...
 

Detailed Description

This class represents one application in the pipeline.

This contains methods for setting application-specific parameters, such as application inputs and outputs. Only pipeline should be instantiating these!

The applications work as a doubly-linked list in order to calculate inputs and outputs correctly. Calling SetNext or SetPrevious is not recommended.

Author
2008-08-04 Steven Lambright
History:

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

2008-09-26 Steven Lambright Fixed introduced bug where input data was not being found when no previous programs in the pipeline generated output (needed to go back to original input).

2008-09-26 Steven Lambright Changed CalculateOutputFile(...) to work in more cases. Pipeline::FinalOutput is relied upon more heavily now to do the right thing.

2010-12-20 Sharmila Prasad - Added the ability to enable/disable a branch.

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

Definition at line 62 of file PipelineApplication.h.

Member Enumeration Documentation

◆ CustomParameterValue

This is used to set custom values that must be calculated on the fly.

Enumerator
LastOutput 

The very last output file. Do not use this for input parameters if it's not necessary, that is done automatically.

LastAppOutputList 

A list of files from the last run application's output.

LastAppOutputListNoMerge 

A list of files from the last run application's output.

Definition at line 82 of file PipelineApplication.h.

◆ NameModifierType

This is used for branches.

Right now, only known strings can be used to specify each branch.

Enumerator
ConstantStrings 

Known strings.

Definition at line 74 of file PipelineApplication.h.

Constructor & Destructor Documentation

◆ PipelineApplication() [1/2]

Isis::PipelineApplication::PipelineApplication ( QString  appName,
Pipeline pipe 
)

Constructs the first pipeline application.

Parameters
appNameThe name of this application
pipeThe pipeline
History:
2010-12-20 Sharmila Prasad Initialise & enable the branches

Definition at line 19 of file PipelineApplication.cpp.

References Isis::Pipeline::OriginalBranches().

◆ PipelineApplication() [2/2]

Isis::PipelineApplication::PipelineApplication ( QString  appName,
PipelineApplication previous 
)

Constructs subsequent pipeline applications.

Parameters
appNameThe name of this application
previousThe previously last pipeline application
History:
2010-12-20 Sharmila Prasad Initialise & enable the branches

Definition at line 49 of file PipelineApplication.cpp.

References GetPipeline().

◆ ~PipelineApplication()

Isis::PipelineApplication::~PipelineApplication ( )
inline

This is the destructor.

Definition at line 68 of file PipelineApplication.h.

Member Function Documentation

◆ AddBranch()

void Isis::PipelineApplication::AddBranch ( const QString &  modString,
NameModifierType  type 
)

This method adds branch to this program.

A branch means with one input, multiple outputs are automatically created.

Example:

thm2isis from=input.img to=output.cub

In this code, thm2isis could actually create output.even.cub and output.odd.cub. The branches are then "even" and "odd". This is used only for the case where the program outputs multiple images based upon one "TO" parameter.

Parameters
modStringBranch name
typeModifier type; currently only supports constant strings
History:
2010-12-20 Sharmila Prasad Enable the branch at the time of creation

Definition at line 157 of file PipelineApplication.cpp.

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

◆ AddConstParameter() [1/2]

void Isis::PipelineApplication::AddConstParameter ( const QString &  appParamName,
const QString &  appParamValue 
)

This method adds a parameter to this application with a known value (does not get it from the user interface, must be specified).

Parameters
appParamNameName of the parameter
appParamValueValue of the parameter

Definition at line 238 of file PipelineApplication.cpp.

◆ AddConstParameter() [2/2]

void Isis::PipelineApplication::AddConstParameter ( const QString &  branch,
const QString &  appParamName,
const QString &  appParamValue 
)

This method adds a parameter to this application with a known value (does not get it from the user interface, must be specified) that only affects a single branch.

Parameters
branchBranch this parameter affects
appParamNameName of the parameter
appParamValueValue of the parameter

Definition at line 264 of file PipelineApplication.cpp.

◆ AddParameter() [1/4]

void Isis::PipelineApplication::AddParameter ( const QString &  inputParamName,
const QString &  appParamName 
)

This method adds knowledge of a parameter to the application.

The parameter value is taken directly from the user interface.

Parameters
inputParamNameParameter in the proc program
appParamNameParameter in this application

Definition at line 204 of file PipelineApplication.cpp.

References IsisAml::GetAsString(), Isis::Application::GetUserInterface(), and IsisAml::WasEntered().

◆ AddParameter() [2/4]

void Isis::PipelineApplication::AddParameter ( const QString &  branch,
const QString &  inputParamName,
const QString &  appParamName 
)

This method adds knowledge of a parameter to this application, that will only affect the specified branch.

The parameter value is taken directly from the user interface; internal defaults are supported by not using the parameter.

Parameters
branchThe branch this parameter affects
inputParamNameParameter in the proc program
appParamNameParameter in the this application

Definition at line 222 of file PipelineApplication.cpp.

References IsisAml::GetAsString(), Isis::Application::GetUserInterface(), and IsisAml::WasEntered().

◆ AddParameter() [3/4]

void Isis::PipelineApplication::AddParameter ( const QString &  appParamName,
CustomParameterValue  value 
)

This method adds a parameter with a calculated value (special) to this application.

Parameters
appParamNameParameter name
valueValue type

Definition at line 276 of file PipelineApplication.cpp.

◆ AddParameter() [4/4]

void Isis::PipelineApplication::AddParameter ( const QString &  branch,
const QString &  appParamName,
CustomParameterValue  value 
)

This method adds a parameter with a calculated value (special) to this application that only affects the specified branch.

Parameters
branchBranch this parameter affects
appParamNameParameter name
valueValue type

Definition at line 289 of file PipelineApplication.cpp.

◆ BranchEnabled()

bool Isis::PipelineApplication::BranchEnabled ( int  branch)
inline

Check whether a branch is enabled given branch index.

Author
Sharmila Prasad (12/20/2010)
Parameters
branch- index into the branch
Returns
bool - true/false

Definition at line 234 of file PipelineApplication.h.

References p_enableBranch.

Referenced by BuildParamString(), and CalculateInputFile().

◆ Branches()

bool Isis::PipelineApplication::Branches ( )
inlineprivate

Return true is this application does branch (one input branch, multiple output)

Definition at line 271 of file PipelineApplication.h.

References p_inBranches, and p_outBranches.

Referenced by CalculateInputFile().

◆ BuildParamString()

void Isis::PipelineApplication::BuildParamString ( )

This method calculates the inputs, outputs and necessary calls to this program for the pipeline.

This should only be used by Pipeline.

History:
2010-12-20 Sharmila Prasad Set appropriate inputs to the branch taking into consideration whether the previous branch was enabled/disabled. Also set the input list accordingly if needlist is true

Definition at line 302 of file PipelineApplication.cpp.

References _FILEINFO_, Isis::FileName::baseName(), BranchEnabled(), GetOutputs(), Isis::IsSpecial(), Isis::PipelineParameter::IsSpecial(), Name(), OutputBranches(), Previous(), Isis::IException::Programmer, and Isis::PipelineParameter::Special().

◆ CalculateInputFile()

QString Isis::PipelineApplication::CalculateInputFile ( int  branch)
private

This method calculates the input file for the specified branch.

Parameters
branchBranch this input file affects
Returns
QString Input filename
History:
2010-12-20 Sharmila Prasad Get the right input for this branch if previous branch is disabled.

Definition at line 513 of file PipelineApplication.cpp.

References _FILEINFO_, BranchEnabled(), Branches(), GetOutputs(), Previous(), and Isis::IException::Programmer.

◆ CalculateOutputFile()

QString Isis::PipelineApplication::CalculateOutputFile ( int  branch)
private

This method calculates the output file for the specified branch.

Parameters
branchBranch this output file is for
Returns
QString The output file

Definition at line 584 of file PipelineApplication.cpp.

References Isis::FileName::baseName(), and Isis::FileName::path().

◆ Continue()

bool Isis::PipelineApplication::Continue ( void  )
inline

Get the continue flag status.

Author
Sharmila Prasad (2/9/2011)
Returns
bool - return continue status

Definition at line 258 of file PipelineApplication.h.

References p_continue.

◆ Disable()

void Isis::PipelineApplication::Disable ( )
inline

This method disables this program, causing it to be ignored.

Definition at line 124 of file PipelineApplication.h.

References p_enabled.

◆ Enable()

void Isis::PipelineApplication::Enable ( )
inline

This method enables this program to be run.

Definition at line 119 of file PipelineApplication.h.

References p_enabled.

◆ EnableBranch()

void Isis::PipelineApplication::EnableBranch ( QString  branch,
bool  flag 
)
inline

Enable/Disable Branch given the branch name.

Author
Sharmila Prasad (12/20/2010)
Parameters
branch- branch name
flag- true/false

Definition at line 218 of file PipelineApplication.h.

References p_enableBranch, and p_inBranches.

◆ Enabled()

const bool& Isis::PipelineApplication::Enabled ( ) const
inline

Returns true if this program will be run.

Definition at line 129 of file PipelineApplication.h.

References p_enabled.

Referenced by Isis::Pipeline::FinalOutput(), Next(), Isis::operator<<(), OutputBranches(), Previous(), and PreviousOutputer().

◆ FindBranch()

int Isis::PipelineApplication::FindBranch ( QString  name,
bool  input = true 
)
private

The method, given a string, finds the index of a branch.

Parameters
nameBranch name
inputTrue if input branch, false if output branch
Returns
int Branch index

Definition at line 753 of file PipelineApplication.cpp.

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

◆ FutureOutputFileCreated()

bool Isis::PipelineApplication::FutureOutputFileCreated ( )
private

Returns true if a future application creates output.

Returns
bool Future application creates output

Definition at line 707 of file PipelineApplication.cpp.

◆ GetInputParameter()

PipelineParameter & Isis::PipelineApplication::GetInputParameter ( int  branch)
private

This gets the input parameter for the specified branch.

Parameters
branchBranch the input parameter is for
Returns
PipelineParameter& The input parameter

Definition at line 727 of file PipelineApplication.cpp.

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

◆ GetOutputs()

vector< QString > & Isis::PipelineApplication::GetOutputs ( )

This returns this application's output files. Only valid after BuildParamString is called.

Definition at line 855 of file PipelineApplication.cpp.

Referenced by BuildParamString(), and CalculateInputFile().

◆ GetPipeline()

Pipeline* Isis::PipelineApplication::GetPipeline ( )
inlineprivate

Returns the pipeline.

Definition at line 266 of file PipelineApplication.h.

References p_pipeline.

Referenced by PipelineApplication().

◆ GetRealLastOutput()

QString Isis::PipelineApplication::GetRealLastOutput ( bool  skipOne = false)
private

This method is used to calculate the value for CustomParameterValue::LastOutput.

Parameters
skipOneSkip the very last output; this is used to skip the output of the current run
Returns
QString The last output file

Definition at line 819 of file PipelineApplication.cpp.

◆ InputBranches()

const std::vector<QString>& Isis::PipelineApplication::InputBranches ( ) const
inline

Get the branches this program expects as input.

Definition at line 102 of file PipelineApplication.h.

References p_inBranches.

◆ LastApplicationWithOutput()

bool Isis::PipelineApplication::LastApplicationWithOutput ( )
private

Returns true if this is the last application with output.

Returns
bool False if another application later on creates output

Definition at line 688 of file PipelineApplication.cpp.

◆ Merges()

bool Isis::PipelineApplication::Merges ( )
inlineprivate

Returns true if this application does merge branches (multiple input branches, one output)

Definition at line 277 of file PipelineApplication.h.

References p_inBranches, and p_outBranches.

◆ Name()

const QString& Isis::PipelineApplication::Name ( ) const
inline

Get the name of this pipeline application.

Definition at line 94 of file PipelineApplication.h.

References p_name.

Referenced by BuildParamString(), and Isis::operator<<().

◆ Next()

PipelineApplication* Isis::PipelineApplication::Next ( ) const
inline

This returns the next enabled pipeline application or null.

Definition at line 186 of file PipelineApplication.h.

References Enabled(), Next(), and p_next.

Referenced by Next().

◆ OutputBranches()

const std::vector<QString>& Isis::PipelineApplication::OutputBranches ( ) const
inline

Get the branches this program has as output.

Definition at line 106 of file PipelineApplication.h.

References Enabled(), OutputBranches(), p_inBranches, p_outBranches, and Previous().

Referenced by BuildParamString(), Isis::Pipeline::FinalOutput(), and OutputBranches().

◆ OutputExtension()

QString Isis::PipelineApplication::OutputExtension ( )
inline

This returns this application's output file name's extension.

Definition at line 156 of file PipelineApplication.h.

References OutputExtension(), p_outputExtension, and Previous().

Referenced by Isis::Pipeline::FinalOutput(), and OutputExtension().

◆ OutputNameModifier()

QString Isis::PipelineApplication::OutputNameModifier ( )
inline

This returns this application's output name modifier.

Definition at line 152 of file PipelineApplication.h.

References OutputNameModifier(), p_outputMod, and Previous().

Referenced by Isis::Pipeline::FinalOutput(), and OutputNameModifier().

◆ ParamString()

const std::vector<QString>& Isis::PipelineApplication::ParamString ( ) const
inline

Get the parameters for running this program; one element in the vector per run.

Definition at line 98 of file PipelineApplication.h.

References p_paramString.

Referenced by Isis::operator<<().

◆ Previous()

PipelineApplication* Isis::PipelineApplication::Previous ( ) const
inline

This returns the last enabled pipeline application or null.

Definition at line 193 of file PipelineApplication.h.

References Enabled(), p_previous, and Previous().

Referenced by BuildParamString(), CalculateInputFile(), Isis::Pipeline::FinalOutput(), OutputBranches(), OutputExtension(), OutputNameModifier(), Previous(), and PreviousOutputer().

◆ PreviousOutputer()

PipelineApplication* Isis::PipelineApplication::PreviousOutputer ( ) const
inline

This returns the previous enabled pipeline application that makes output or null.

Definition at line 200 of file PipelineApplication.h.

References Enabled(), p_output, p_previous, and Previous().

◆ SetContinue()

void Isis::PipelineApplication::SetContinue ( bool  pbFlag)
inline

Set the continue flag status.

Author
Sharmila Prasad (2/9/2011)
Parameters
pbFlag- true/false

Definition at line 247 of file PipelineApplication.h.

References p_continue.

◆ SetInputParameter() [1/2]

void Isis::PipelineApplication::SetInputParameter ( const QString &  inputParamName,
bool  supportsVirtualBands 
)

Set the input parameter for this application and whether or not this application supports the virtual bands functionality.

It supports the virtual bands functionality if the input is an Isis 3 cube.

Parameters
inputParamNameName of the input parameter, typically "FROM"
supportsVirtualBandsTrue if this application supports virtual bands

Definition at line 73 of file PipelineApplication.cpp.

◆ SetInputParameter() [2/2]

void Isis::PipelineApplication::SetInputParameter ( const QString &  inputParamName,
CustomParameterValue  value,
bool  supportsVirtualBands 
)

Set the input parameter for this application and whether or not this application supports the virtual bands functionality.

It supports the virtual bands functionality if the input is an Isis 3 cube.

Parameters
inputParamNameName of the input parameter, typically "FROM"
valueCustom parameter value; Recommended to use an alternate SetInputParameter instead of specifying LastOutput
supportsVirtualBandsTrue if this application supports virtual bands

Definition at line 90 of file PipelineApplication.cpp.

◆ SetNext()

void Isis::PipelineApplication::SetNext ( PipelineApplication next)
inline

Link to the next application in the pipeline.

Parameters
nextThe next pipeline application

Definition at line 169 of file PipelineApplication.h.

References p_next.

Referenced by Isis::Pipeline::AddToPipeline().

◆ SetOutputParameter() [1/2]

void Isis::PipelineApplication::SetOutputParameter ( const QString &  outputParamName,
const QString &  outNameModifier,
const QString &  outFileExtension = "cub" 
)

Set the output parameter for this application and it's naming convention.

Parameters
outputParamNameName of the output parameter
outNameModifierModifier to add to the cube name, such as "lev1"
outFileExtensionExtension of the output file (usually "cub" for cube)

Definition at line 131 of file PipelineApplication.cpp.

◆ SetOutputParameter() [2/2]

void Isis::PipelineApplication::SetOutputParameter ( const QString &  branch,
const QString &  outputParamName,
const QString &  outNameModifier,
const QString &  outFileExtension 
)

Set the output parameter for a branch of this application and it's naming convention.

This is meant for an application that splits the input into two output files via two output parameters.

Parameters
branchBranch this output parameter applies to
outputParamNameName of the output parameter
outNameModifierModifier to add to the cube name, such as "lev1"
outFileExtensionExtension of the output file (usually "cub" for cube)

Definition at line 116 of file PipelineApplication.cpp.

◆ SetPrevious()

void Isis::PipelineApplication::SetPrevious ( PipelineApplication prev)
inline

Link to the previous application in the pipeline.

Parameters
prevThe previous pipeline application

Definition at line 179 of file PipelineApplication.h.

References p_previous.

Referenced by Isis::Pipeline::AddToPipeline().

◆ SetVirtualBands()

void Isis::PipelineApplication::SetVirtualBands ( std::vector< QString >  bands)

Set the virtual bands that this application is to apply.

Empty for none.

Parameters
bandsThe virtual bands string, excluding the "+". For example, "2,4-5,8"

Definition at line 850 of file PipelineApplication.cpp.

◆ StringStartsWith()

bool Isis::PipelineApplication::StringStartsWith ( QString  from,
QString  compare 
)
inlineprivate

String comparison helper, returns true if from starts with compare bool.

Parameters
fromLonger string ("abcdef")
compareString to compare against ("abc")

Definition at line 289 of file PipelineApplication.h.

◆ SupportsVirtualBands()

bool Isis::PipelineApplication::SupportsVirtualBands ( )

Returns true if virtual bands are supported.

Returns
bool Virtual bands supported

Definition at line 838 of file PipelineApplication.cpp.

◆ TemporaryFiles()

vector< QString > Isis::PipelineApplication::TemporaryFiles ( )

This method returns a list of the temporary files generated by this program.

Returns
vector<QString> The temporary files

Definition at line 793 of file PipelineApplication.cpp.

Referenced by Isis::operator<<().

Member Data Documentation

◆ p_continue

bool Isis::PipelineApplication::p_continue
private

Continue the pipeline execution even if an error is encountered by this app.

Definition at line 305 of file PipelineApplication.h.

Referenced by Continue(), and SetContinue().

◆ p_enableBranch

std::vector<bool> Isis::PipelineApplication::p_enableBranch
private

Branch enabled/disabled.

Definition at line 314 of file PipelineApplication.h.

Referenced by BranchEnabled(), and EnableBranch().

◆ p_enabled

bool Isis::PipelineApplication::p_enabled
private

This application enabled?

Definition at line 306 of file PipelineApplication.h.

Referenced by Disable(), Enable(), and Enabled().

◆ p_inBranches

std::vector<QString> Isis::PipelineApplication::p_inBranches
private

Input branches.

Definition at line 312 of file PipelineApplication.h.

Referenced by Branches(), EnableBranch(), InputBranches(), Merges(), and OutputBranches().

◆ p_input

std::vector<PipelineParameter> Isis::PipelineApplication::p_input
private

Input parameters.

Definition at line 321 of file PipelineApplication.h.

◆ p_name

QString Isis::PipelineApplication::p_name
private

Name of this application.

Definition at line 308 of file PipelineApplication.h.

Referenced by Name().

◆ p_next

PipelineApplication* Isis::PipelineApplication::p_next
private

Next pipeline application.

Definition at line 325 of file PipelineApplication.h.

Referenced by Next(), and SetNext().

◆ p_outBranches

std::vector<QString> Isis::PipelineApplication::p_outBranches
private

Output branches.

Definition at line 313 of file PipelineApplication.h.

Referenced by Branches(), Merges(), and OutputBranches().

◆ p_output

std::vector<PipelineParameter> Isis::PipelineApplication::p_output
private

Output parameters.

Definition at line 316 of file PipelineApplication.h.

Referenced by PreviousOutputer().

◆ p_outputExtension

QString Isis::PipelineApplication::p_outputExtension
private

Output file name extension.

Definition at line 318 of file PipelineApplication.h.

Referenced by OutputExtension().

◆ p_outputMod

QString Isis::PipelineApplication::p_outputMod
private

Output file name modifier.

Definition at line 317 of file PipelineApplication.h.

Referenced by OutputNameModifier().

◆ p_outputs

std::vector<QString> Isis::PipelineApplication::p_outputs
private

Actual output files.

Definition at line 309 of file PipelineApplication.h.

◆ p_params

std::vector<PipelineParameter> Isis::PipelineApplication::p_params
private

Regular parameters.

Definition at line 322 of file PipelineApplication.h.

◆ p_paramString

std::vector<QString> Isis::PipelineApplication::p_paramString
private

Built parameter strings.

Definition at line 311 of file PipelineApplication.h.

Referenced by ParamString().

◆ p_pipeline

Pipeline* Isis::PipelineApplication::p_pipeline
private

The pipeline.

Definition at line 326 of file PipelineApplication.h.

Referenced by GetPipeline().

◆ p_previous

PipelineApplication* Isis::PipelineApplication::p_previous
private

Previous pipeline application.

Definition at line 324 of file PipelineApplication.h.

Referenced by Previous(), PreviousOutputer(), and SetPrevious().

◆ p_supportsVirtualBands

bool Isis::PipelineApplication::p_supportsVirtualBands
private

This application supports virtual bands?

Definition at line 307 of file PipelineApplication.h.

◆ p_tempFiles

std::vector<QString> Isis::PipelineApplication::p_tempFiles
private

Actial temporary files.

Definition at line 310 of file PipelineApplication.h.

◆ p_virtualBands

std::vector<QString> Isis::PipelineApplication::p_virtualBands
private

Virtual bands string to add (empty if none)

Definition at line 319 of file PipelineApplication.h.


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