|
Isis Developer Reference
|
Go to the documentation of this file.
153 Pipeline(
const QString &procAppName =
"");
161 void SetInputFile(
const char *inputParam,
const char *virtualBandsParam);
162 void SetInputFile(
const QString &inputParam,
const QString &virtualBandsParam);
177 return p_keepTemporary;
182 void AddToPipeline(
const QString &appname,
const QString &identifier);
193 return p_procAppName;
197 return (
int)p_apps.size();
208 return ((branch < p_originalInput.size()) ? p_originalInput[branch] :
"");
213 return p_originalInput.size();
225 if (p_originalBranches.size() > 0){
226 return p_originalBranches.size();
228 return p_inputBranches.size();
234 if (p_originalBranches.size() > 0){
235 return p_originalBranches;
237 return p_inputBranches;
240 QString
FinalOutput(
int branch = 0,
bool addModifiers =
true);
253 int size = (int)p_inputBranches.size();
255 p_originalBranches.push_back(branch);
258 for (
int i=0; i<size; i++) {
259 p_originalBranches.push_back(p_inputBranches[i] +
"." + branch);
277 QString p_procAppName;
278 std::vector<QString> p_originalInput;
279 std::vector<QString> p_inputBranches;
280 std::vector<QString> p_originalBranches;
281 std::vector<QString> p_finalOutput;
282 std::vector<QString> p_virtualBands;
283 bool p_keepTemporary;
285 std::vector< PipelineApplication * > p_apps;
286 std::vector< QString > p_appIdentifiers;
287 bool p_outputListNeedsModifiers;
void SetOutputFile(const char *outputParam)
This method is used to set the final output file.
Definition: Pipeline.cpp:441
void SetNext(PipelineApplication *next)
Link to the next application in the pipeline.
Definition: PipelineApplication.h:153
void SetLastApplication(const QString &appname)
This method disables all applications after to this one.
Definition: Pipeline.cpp:778
Definition: Application.h:101
This class represents one application in the pipeline.
Definition: PipelineApplication.h:46
PvlGroupIterator findGroup(const QString &name, PvlGroupIterator beg, PvlGroupIterator end)
Find a group with the specified name, within these indexes.
Definition: PvlObject.h:129
friend std::ostream & operator<<(std::ostream &os, Pipeline &pipeline)
QDebug operator<<(QDebug debug, const Hillshade &hillshade)
Print this class out to a QDebug object.
Definition: Hillshade.cpp:314
void print() const
Prints a string representation of this exception to stderr.
Definition: IException.cpp:445
QString GetAsString(const QString ¶mName) const
Allows the retrieval of a value for a parameter of any type.
Definition: IsisAml.cpp:537
void CheckStatus()
Checks and updates the status.
Definition: Progress.cpp:105
void KeepTemporaryFiles(bool keep)
Set whether or not to keep temporary files (files generated in the middle of the pipeline that are ne...
Definition: Pipeline.cpp:546
QString name() const
Returns the name of the file excluding the path and the attributes in the file name.
Definition: FileName.cpp:162
File name manipulation and expansion.
Definition: FileName.h:100
void write(FileName outputFileList)
writes to a FileName obj
Definition: FileList.cpp:158
void SetMaximumSteps(const int steps)
This sets the maximum number of steps in the process.
Definition: Progress.cpp:85
PipelineApplication * Previous() const
This returns the last enabled pipeline application or null.
Definition: PipelineApplication.h:177
Pipeline(const QString &procAppName="")
This is the one and only Pipeline constructor.
Definition: Pipeline.cpp:36
QString TemporaryFolder()
This method returns the user's temporary folder for temporary files.
Definition: Pipeline.cpp:882
QString GetFileName(const QString ¶mName, QString extension="") const
Allows the retrieval of a value for a parameter of type "filename".
Definition: IsisAml.cpp:607
void AddOriginalBranch(QString branch)
Start off the branches directly from the pipeline.
Definition: Pipeline.h:252
Container for cube-like labels.
Definition: Pvl.h:119
std::vector< QString > TemporaryFiles()
This method returns a list of the temporary files generated by this program.
Definition: PipelineApplication.cpp:799
QString OutputExtension()
This returns this application's output file name's extension.
Definition: PipelineApplication.h:140
QString FinalOutput(int branch=0, bool addModifiers=true)
This gets the final output for the specified branch; this is necessary for the PipelineApplications t...
Definition: Pipeline.cpp:805
QString toString(bool boolToConvert)
Global function to convert a boolean to a string.
Definition: IString.cpp:211
Isis::CubeAttributeInput & GetInputAttribute(const QString ¶mName)
Gets the attributes for an input cube.
Definition: IsisAml.cpp:1874
void SetFirstApplication(const QString &appname)
This method disables all applications up to this one.
Definition: Pipeline.cpp:748
static void RunIsisProgram(QString isisProgramName, QString arguments)
Executes the Isis program with the given arguments.
Definition: ProgramLauncher.cpp:37
void SetPrevious(PipelineApplication *prev)
Link to the previous application in the pipeline.
Definition: PipelineApplication.h:163
QString baseName() const
Returns the name of the file without the path and without extensions.
Definition: FileName.cpp:145
static UserInterface & GetUserInterface()
Returns the UserInterface object.
Definition: Application.cpp:463
std::vector< QString > OriginalBranches()
Returns the names of the original branches of the pipeline (input files * branches if any)
Definition: Pipeline.h:233
QString expanded() const
Returns a QString of the full file name including the file path, excluding the attributes.
Definition: FileName.cpp:196
void SetInputListFile(const char *inputParam)
This method is used to set the original input files.
Definition: Pipeline.cpp:339
bool KeepTemporaryFiles()
Returns true if temporary files will not be deleted, false if they will.
Definition: Pipeline.h:176
void SetContinue(bool pbFlag)
Set the continue flag.
Definition: Pipeline.h:271
const QString & Name() const
Get the name of this pipeline application.
Definition: PipelineApplication.h:78
void AddToPipeline(const QString &appname)
Add a new program to the pipeline.
Definition: Pipeline.cpp:643
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
void SetInputFile(const char *inputParam)
This method is used to set the original input file.
Definition: Pipeline.cpp:292
const std::vector< QString > & OutputBranches() const
Get the branches this program has as output.
Definition: PipelineApplication.h:90
QString Name() const
Returns the name of the pipeline.
Definition: Pipeline.h:192
void SetText(const QString &text)
Changes the value of the text string reported just before 0% processed.
Definition: Progress.cpp:61
QString OriginalInput(unsigned int branch)
Returns the initial input file for the pipeline.
Definition: Pipeline.h:207
int OriginalInputSize()
Returns the number of input files.
Definition: Pipeline.h:212
static QString Name()
Returns the name of the application.
Definition: Application.cpp:729
Isis exception class.
Definition: IException.h:91
void EnableAllApplications()
This method re-enables all applications.
Definition: Pipeline.cpp:896
Program progress reporter.
Definition: Progress.h:42
QString OutputNameModifier()
This returns this application's output name modifier.
Definition: PipelineApplication.h:136
const bool & Enabled() const
Returns true if this program will be run.
Definition: PipelineApplication.h:113
void Run()
This method executes the pipeline.
Definition: Pipeline.cpp:199
This class helps to call other Isis Applications in a Pipeline.
Definition: Pipeline.h:151
int Size() const
Returns the number of applications in the pipeline.
Definition: Pipeline.h:196
bool WasEntered(const QString ¶mName) const
Returns a true if the parameter has a value, and false if it does not.
Definition: IsisAml.cpp:1836
PipelineApplication & Application(const QString &identifier)
This is an accessor to get a specific PipelineApplication.
Definition: Pipeline.cpp:696
@ Programmer
This error is for when a programmer made an API call that was illegal.
Definition: IException.h:146
Namespace for the standard library.
Command Line and Xml loader, validation, and access.
Definition: UserInterface.h:140
const std::vector< QString > & ParamString() const
Get the parameters for running this program; one element in the vector per run.
Definition: PipelineApplication.h:82
void SetOutputListFile(const char *outputFileNameParam)
This method is used to set an output list file.
Definition: Pipeline.cpp:487
static Preference & Preferences(bool unitTest=false)
Definition: Preference.cpp:86
QString original() const
Returns the full file name including the file path.
Definition: FileName.cpp:212
void Prepare()
This method is the core of the pipeline class.
Definition: Pipeline.cpp:69
Internalizes a list of files.
Definition: FileList.h:54
~Pipeline()
This destroys the pipeline.
Definition: Pipeline.cpp:49
int OriginalBranchesSize()
Returns the total number of input branches Original branches = Number of input files * Number of bran...
Definition: Pipeline.h:224
QString path() const
Returns the path of the file name.
Definition: FileName.cpp:103
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
void AddPause()
Add a pause to the pipeline.
Definition: Pipeline.cpp:558