openfluid::waresdev::WareSrcContainer Class Reference

#include <waresdev/WareSrcContainer.hpp>

Inheritance diagram for openfluid::waresdev::WareSrcContainer:

Collaboration diagram for openfluid::waresdev::WareSrcContainer:

Public Types
enum	ConfigMode { ConfigMode::CONFIG_DEBUG, ConfigMode::CONFIG_RELEASE }
enum	BuildMode { BuildMode::BUILD_WITHINSTALL, BuildMode::BUILD_NOINSTALL }

Signals
void	processLaunched ()
void	processFinished ()
void	configureProcessLaunched (openfluid::ware::WareType Type, const QString &ID)
void	configureProcessFinished (openfluid::ware::WareType Type, const QString &ID)
void	buildProcessLaunched (openfluid::ware::WareType Type, const QString &ID)
void	buildProcessFinished (openfluid::ware::WareType Type, const QString &ID)

Public Member Functions
	WareSrcContainer (const QString &AbsolutePath, openfluid::ware::WareType Type, const QString &WareID)
	~WareSrcContainer ()
void	update ()
QStringList	getDefaultFilesPaths ()
QString	getAbsolutePath () const
QString	getBuildDirPath () const
openfluid::ware::WareType	getType () const
QString	getID () const
QString	getTypeSubDir () const
QString	getMainCppPath () const
QString	getUiParamCppPath () const
QString	getCMakeConfigPath () const
QString	getCMakeListsPath () const
QString	getJsonPath () const
std::map< QString, QString >	getConfigureVariables () const
QString	getConfigureGenerator () const
QString	getConfigureExtraOptions () const
QProcessEnvironment	getConfigureEnvironment () const
QProcessEnvironment	getBuildEnvironment () const
QString	getBuildTarget () const
void	prepareBuildDirectory () const
void	setMsgStream (openfluid::waresdev::WareSrcMsgStream &Stream)
void	setConfigMode (ConfigMode Mode)
void	setBuildMode (BuildMode Mode)
void	configure ()
void	build ()
QList< WareSrcMsgParser::WareSrcMsg >	getMessages ()
bool	isProcessRunning () const

Static Public Member Functions
static QString	searchMainCppFileName (const QString &CMakeFileContent)
static QString	searchUiParamCppFileName (const QString &CMakeFileContent)

Member Enumeration Documentation

BuildMode

enum openfluid::waresdev::WareSrcContainer::BuildMode

strong

Enumerator
BUILD_WITHINSTALL
BUILD_NOINSTALL

ConfigMode

enum openfluid::waresdev::WareSrcContainer::ConfigMode

strong

Enumerator
CONFIG_DEBUG
CONFIG_RELEASE

Constructor & Destructor Documentation

WareSrcContainer()

openfluid::waresdev::WareSrcContainer::WareSrcContainer	(	const QString &	AbsolutePath,
		openfluid::ware::WareType	Type,
		const QString &	WareID
	)

~WareSrcContainer()

openfluid::waresdev::WareSrcContainer::~WareSrcContainer

(

)

Member Function Documentation

build()

void openfluid::waresdev::WareSrcContainer::build

(

)

buildProcessFinished

void openfluid::waresdev::WareSrcContainer::buildProcessFinished ( openfluid::ware::WareType  Type, const QString &  ID  )

signal

buildProcessLaunched

void openfluid::waresdev::WareSrcContainer::buildProcessLaunched ( openfluid::ware::WareType  Type, const QString &  ID  )

signal

configure()

void openfluid::waresdev::WareSrcContainer::configure

(

)

configureProcessFinished

void openfluid::waresdev::WareSrcContainer::configureProcessFinished ( openfluid::ware::WareType  Type, const QString &  ID  )

signal

configureProcessLaunched

void openfluid::waresdev::WareSrcContainer::configureProcessLaunched ( openfluid::ware::WareType  Type, const QString &  ID  )

signal

getAbsolutePath()

QString openfluid::waresdev::WareSrcContainer::getAbsolutePath

(

)

const

getBuildDirPath()

QString openfluid::waresdev::WareSrcContainer::getBuildDirPath

(

)

const

getBuildEnvironment()

QProcessEnvironment openfluid::waresdev::WareSrcContainer::getBuildEnvironment

(

)

const

getBuildTarget()

QString openfluid::waresdev::WareSrcContainer::getBuildTarget

(

)

const

getCMakeConfigPath()

QString openfluid::waresdev::WareSrcContainer::getCMakeConfigPath

(

)

const

Returns the absolute path of the CMake config file, if this file exists, otherwise an empty string

getCMakeListsPath()

QString openfluid::waresdev::WareSrcContainer::getCMakeListsPath

(

)

const

Returns the absolute path of the CMakeLists.txt file, if this file exists, otherwise an empty string

getConfigureEnvironment()

QProcessEnvironment openfluid::waresdev::WareSrcContainer::getConfigureEnvironment

(

)

const

getConfigureExtraOptions()

QString openfluid::waresdev::WareSrcContainer::getConfigureExtraOptions

(

)

const

getConfigureGenerator()

QString openfluid::waresdev::WareSrcContainer::getConfigureGenerator

(

)

const

getConfigureVariables()

std::map<QString,QString> openfluid::waresdev::WareSrcContainer::getConfigureVariables

(

)

const

getDefaultFilesPaths()

QStringList openfluid::waresdev::WareSrcContainer::getDefaultFilesPaths

(

)

Return the absolute paths of:

• the CMake config file if it exists on disk,
• the main .cpp file as set in the CMakeLists.txt, if this .cpp exists on disk. If no .cpp file was found (because it doesn't exists, it wasn't found in CMake file, or CMake file doesn't exist):
• the first .cpp file found in this ware directory (not recursive).

  Returns

  a list of existing absolute paths into this ware directory. It can be empty.

getID()

QString openfluid::waresdev::WareSrcContainer::getID

(

)

const

getJsonPath()

QString openfluid::waresdev::WareSrcContainer::getJsonPath

(

)

const

Returns the absolute path of the wareshub.json file, if this file exists, otherwise an empty string

getMainCppPath()

QString openfluid::waresdev::WareSrcContainer::getMainCppPath

(

)

const

Returns the absolute path of the main .cpp as set in the CMake config file, if this .cpp file exists, otherwise an empty string

getMessages()

QList<WareSrcMsgParser::WareSrcMsg> openfluid::waresdev::WareSrcContainer::getMessages

(

)

getType()

openfluid::ware::WareType openfluid::waresdev::WareSrcContainer::getType

(

)

const

getTypeSubDir()

QString openfluid::waresdev::WareSrcContainer::getTypeSubDir

(

)

const

getUiParamCppPath()

QString openfluid::waresdev::WareSrcContainer::getUiParamCppPath

(

)

const

Returns the absolute path of the ui-parameterization .cpp as set in the CMake config file, if this .cpp file exists, otherwise an empty string

isProcessRunning()

bool openfluid::waresdev::WareSrcContainer::isProcessRunning

(

)

const

prepareBuildDirectory()

void openfluid::waresdev::WareSrcContainer::prepareBuildDirectory

(

)

const

processFinished

void openfluid::waresdev::WareSrcContainer::processFinished ( )

signal

processLaunched

void openfluid::waresdev::WareSrcContainer::processLaunched ( )

signal

searchMainCppFileName()

static QString openfluid::waresdev::WareSrcContainer::searchMainCppFileName ( const QString &  CMakeFileContent )

static

searchUiParamCppFileName()

static QString openfluid::waresdev::WareSrcContainer::searchUiParamCppFileName ( const QString &  CMakeFileContent )

static

setBuildMode()

void openfluid::waresdev::WareSrcContainer::setBuildMode

(

BuildMode

Mode

)

setConfigMode()

void openfluid::waresdev::WareSrcContainer::setConfigMode

(

ConfigMode

Mode

)

setMsgStream()

void openfluid::waresdev::WareSrcContainer::setMsgStream

(

openfluid::waresdev::WareSrcMsgStream &

Stream

)

update()

void openfluid::waresdev::WareSrcContainer::update

(

)

---

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

• waresdev/WareSrcContainer.hpp