otbWrapperCommandLineLauncher.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbWrapperCommandLineLauncher_h
#define otbWrapperCommandLineLauncher_h
 
 
#include "otbWrapperApplication.h"
#include "otbWrapperParameter.h"
#include "itksys/SystemTools.hxx"
#include "otbWrapperCommandLineParser.h"
 
#include "itkStdStreamLogOutput.h"
 
#include "otbStandardOneLineFilterWatcher.h"
 
#include "itkCommand.h"
 
#include <vector>
#include <string>
 
namespace otb
{
namespace Wrapper
{
 
class ITK_ABI_EXPORT CommandLineLauncher : public itk::Object
{
public:
  typedef CommandLineLauncher           Self;
  typedef itk::Object                   Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(CommandLineLauncher, itk::Object);
 
  typedef CommandLineParser::ParseResultType ParseResultType;
  typedef enum { OKPARAM, MISSINGMANDATORYPARAMETER, MISSINGPARAMETERVALUE, WRONGPARAMETERVALUE, INVALIDNUMBEROFVALUE, DEFAULT } ParamResultType;
 
  typedef std::vector<StandardOneLineFilterWatcher<>*> WatcherListType;
 
  typedef itk::MemberCommand<Self> AddProcessCommandType;
 
  bool Load();
 
  bool Load(const std::vector<std::string>& vexp);
 
  bool Execute();
 
  bool ExecuteAndWriteOutput();
 
  bool BeforeExecute();
 
  void DisplayHelp(bool longHelp = false);
 
  void LoadTestEnv();
 
protected:
  CommandLineLauncher();
 
  ~CommandLineLauncher() override;
 
  bool LoadPath();
 
  bool LoadApplication();
 
  CommandLineLauncher::ParamResultType LoadParameters();
 
  std::string DisplayParameterHelp(const Parameter::Pointer& param, const std::string paramKey, bool longHelp = false);
 
  bool CheckUnicity();
 
  bool CheckParametersPrefix();
 
  bool CheckKeyValidity(std::string& key);
 
  void DisplayOutputParameters();
 
  void LinkWatchers(itk::Object* caller, const itk::EventObject& event);
 
  void DeleteWatcherList();
 
  unsigned int GetMaxKeySize() const;
 
private:
  bool CheckMissingMandatoryParameter(const std::string& paramKey) const;
 
  void CheckUnusedParameter(const std::string& paramKey) const;
 
  bool CheckOutputPathsValidity(const std::string& paramKey) const;
 
  CommandLineLauncher(const CommandLineLauncher&) = delete;
  void operator=(const CommandLineLauncher&) = delete;
 
  bool ExecuteAndWriteOutputNoCatch();
 
 
  std::string m_Path;
 
  Application::Pointer m_Application;
  // std::string                       m_Expression;
  std::vector<std::string>   m_VExpression;
  CommandLineParser::Pointer m_Parser;
 
  WatcherListType m_WatcherList;
 
  itk::StdStreamLogOutput::Pointer m_LogOutput;
 
  AddProcessCommandType::Pointer m_AddProcessCommand;
  bool                           m_ReportProgress;
 
}; // end class
 
} // end namespace Wrapper
} // end namespace otb
 
#endif // otbWrapperCommandLineLauncher_h_