Documentation for OpenFLUID 2.2.0
Static Public Member Functions | Static Public Attributes | List of all members
openfluid::utils::CMakeProxy Class Reference

#include <utils/CMakeProxy.hpp>

Static Public Member Functions

static bool isAvailable ()
 
static std::string getBuildDir (const std::string &BuildType=DefaultBuildType)
 
static Process::Command getConfigureCommand (const std::string &BuildDir, const std::string &SrcDir, const std::map< std::string, std::string > &Variables={}, const std::string &Generator="", const std::vector< std::string > &Options={})
 
static Process::Command getBuildCommand (const std::string &BuildDir, const std::string &Target="", const unsigned int Jobs=0, const std::vector< std::string > &CMakeOptions={}, const std::vector< std::string > &OtherOptions={})
 
static Process::Command getTarCompressCommand (const std::string &WorkDir, const std::string &TarFilePath, const std::vector< std::string > &RelativePathsToCompress, const std::string &Options="")
 
static Process::Command getTarUncompressCommand (const std::string &WorkDir, const std::string &TarFilePath, const std::string &Options="")
 
- Static Public Member Functions inherited from openfluid::utils::ProgramProxy< CMakeProxy >
static bool isAvailable ()
 
static std::string getVersion ()
 
static std::string getExecutablePath ()
 

Static Public Attributes

static const std::string DefaultBuildType
 

Additional Inherited Members

- Static Protected Attributes inherited from openfluid::utils::ProgramProxy< CMakeProxy >
static std::string m_ExecutablePath
 
static std::string m_Version
 
Inheritance diagram for openfluid::utils::CMakeProxy:
Inheritance graph
[legend]
Collaboration diagram for openfluid::utils::CMakeProxy:
Collaboration graph
[legend]

Member Function Documentation

◆ getBuildCommand()

static Process::Command openfluid::utils::CMakeProxy::getBuildCommand ( const std::string &  BuildDir,
const std::string &  Target = "",
const unsigned int  Jobs = 0,
const std::vector< std::string > &  CMakeOptions = {},
const std::vector< std::string > &  OtherOptions = {} 
)
static

Returns a build command prepared using the given arguments

Parameters
[in]BuildDirthe directory where the build will be performed
[in]Targetthe target to build (empty by default)
[in]Jobsthe number of parallel jobs to use, 0 means that parallel build is not active (0 by default)
[in]CMakeOptionsa string of options passed to CMake (empty by default)
[in]OtherOptionsa string of options passed to the build tool (empty by default)

◆ getBuildDir()

static std::string openfluid::utils::CMakeProxy::getBuildDir ( const std::string &  BuildType = DefaultBuildType)
static

◆ getConfigureCommand()

static Process::Command openfluid::utils::CMakeProxy::getConfigureCommand ( const std::string &  BuildDir,
const std::string &  SrcDir,
const std::map< std::string, std::string > &  Variables = {},
const std::string &  Generator = "",
const std::vector< std::string > &  Options = {} 
)
static

◆ getTarCompressCommand()

static Process::Command openfluid::utils::CMakeProxy::getTarCompressCommand ( const std::string &  WorkDir,
const std::string &  TarFilePath,
const std::vector< std::string > &  RelativePathsToCompress,
const std::string &  Options = "" 
)
static

◆ getTarUncompressCommand()

static Process::Command openfluid::utils::CMakeProxy::getTarUncompressCommand ( const std::string &  WorkDir,
const std::string &  TarFilePath,
const std::string &  Options = "" 
)
static

◆ isAvailable()

static bool openfluid::utils::CMakeProxy::isAvailable ( )
static

Member Data Documentation

◆ DefaultBuildType

const std::string openfluid::utils::CMakeProxy::DefaultBuildType
inlinestatic
The documentation for this class was generated from the following file: