openfluid::waresdev::WareSrcContainer Class Reference

#include <waresdev/WareSrcContainer.hpp>

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

Public Member Functions
	WareSrcContainer (const std::string &AbsolutePath, openfluid::ware::WareType Type, const std::string &WareID)
virtual	~WareSrcContainer ()
void	update ()
std::string	getAbsolutePath () const
openfluid::ware::WareType	getType () const
openfluid::ware::WareID_t	getID () const
std::string	searchMainCppFileName (const std::string &CMakeConfigContent)
std::vector< std::string >	getDefaultFilesPaths ()
std::string	getBuildDirPath () const
std::string	getMainCppPath () const
std::string	getUiParamCppPath () const
std::string	getCMakeListsPath () const
std::string	getJsonPath () const
std::map< std::string, std::string >	getConfigureVariables () const
std::string	getConfigureGenerator () const
std::string	getConfigureExtraOptions () const
std::string	getBuildTarget () const
std::string	getGenerateDocTarget () const
unsigned int	getBuildJobs () const
void	prepareBuildDirectory () const
void	setConfigMode (ConfigMode Mode)
void	setBuildMode (BuildMode Mode)
void	setBuildJobs (unsigned int Jobs)

Protected Member Functions
void	findCMake ()

Protected Attributes
std::string	m_AbsolutePath
openfluid::ware::WareType	m_Type
openfluid::ware::WareID_t	m_ID
std::string	m_AbsoluteMainCppPath
std::string	m_AbsoluteUiParamCppPath
std::string	m_AbsoluteCMakeMainPath
std::string	m_AbsoluteJsonPath
ConfigMode	m_ConfigMode
BuildMode	m_BuildMode
unsigned int	m_BuildJobs
std::string	m_BuildDirPath
std::string	m_OFVersion

Inheritance diagram for openfluid::waresdev::WareSrcContainer:

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 std::string &	AbsolutePath,
		openfluid::ware::WareType	Type,
		const std::string &	WareID
	)

~WareSrcContainer()

virtual openfluid::waresdev::WareSrcContainer::~WareSrcContainer ( )

virtual

Member Function Documentation

findCMake()

void openfluid::waresdev::WareSrcContainer::findCMake ( )

protected

Exceptions

openfluid::base::FrameworkException

getAbsolutePath()

std::string openfluid::waresdev::WareSrcContainer::getAbsolutePath ( ) const

inline

getBuildDirPath()

std::string openfluid::waresdev::WareSrcContainer::getBuildDirPath

(

)

const

getBuildJobs()

unsigned int openfluid::waresdev::WareSrcContainer::getBuildJobs

(

)

const

getBuildTarget()

std::string openfluid::waresdev::WareSrcContainer::getBuildTarget

(

)

const

getCMakeListsPath()

std::string openfluid::waresdev::WareSrcContainer::getCMakeListsPath

(

)

const

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

getConfigureExtraOptions()

std::string openfluid::waresdev::WareSrcContainer::getConfigureExtraOptions

(

)

const

getConfigureGenerator()

std::string openfluid::waresdev::WareSrcContainer::getConfigureGenerator

(

)

const

getConfigureVariables()

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

(

)

const

getDefaultFilesPaths()

std::vector<std::string> 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.

getGenerateDocTarget()

std::string openfluid::waresdev::WareSrcContainer::getGenerateDocTarget

(

)

const

getID()

openfluid::ware::WareID_t openfluid::waresdev::WareSrcContainer::getID ( ) const

inline

getJsonPath()

std::string openfluid::waresdev::WareSrcContainer::getJsonPath

(

)

const

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

getMainCppPath()

std::string 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

getType()

openfluid::ware::WareType openfluid::waresdev::WareSrcContainer::getType ( ) const

inline

getUiParamCppPath()

std::string 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

prepareBuildDirectory()

void openfluid::waresdev::WareSrcContainer::prepareBuildDirectory

(

)

const

searchMainCppFileName()

std::string openfluid::waresdev::WareSrcContainer::searchMainCppFileName

(

const std::string &

CMakeConfigContent

)

setBuildJobs()

void openfluid::waresdev::WareSrcContainer::setBuildJobs

(

unsigned int

Jobs

)

setBuildMode()

void openfluid::waresdev::WareSrcContainer::setBuildMode

(

BuildMode

Mode

)

setConfigMode()

void openfluid::waresdev::WareSrcContainer::setConfigMode

(

ConfigMode

Mode

)

update()

void openfluid::waresdev::WareSrcContainer::update

(

)

Member Data Documentation

m_AbsoluteCMakeMainPath

std::string openfluid::waresdev::WareSrcContainer::m_AbsoluteCMakeMainPath

protected

Absolute path of the CMake config file if it exists, otherwise an empty string

m_AbsoluteJsonPath

std::string openfluid::waresdev::WareSrcContainer::m_AbsoluteJsonPath

protected

Absolute path of the openfluid-ware.json file if it exists, otherwise an empty string

m_AbsoluteMainCppPath

std::string openfluid::waresdev::WareSrcContainer::m_AbsoluteMainCppPath

protected

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

m_AbsolutePath

std::string openfluid::waresdev::WareSrcContainer::m_AbsolutePath

protected

m_AbsoluteUiParamCppPath

std::string openfluid::waresdev::WareSrcContainer::m_AbsoluteUiParamCppPath

protected

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

m_BuildDirPath

std::string openfluid::waresdev::WareSrcContainer::m_BuildDirPath

protected

m_BuildJobs

unsigned int openfluid::waresdev::WareSrcContainer::m_BuildJobs

protected

m_BuildMode

BuildMode openfluid::waresdev::WareSrcContainer::m_BuildMode

protected

m_ConfigMode

ConfigMode openfluid::waresdev::WareSrcContainer::m_ConfigMode

protected

m_ID

openfluid::ware::WareID_t openfluid::waresdev::WareSrcContainer::m_ID

protected

m_OFVersion

std::string openfluid::waresdev::WareSrcContainer::m_OFVersion

protected

m_Type

openfluid::ware::WareType openfluid::waresdev::WareSrcContainer::m_Type

protected

---

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

• waresdev/WareSrcContainer.hpp