#include <market/MarketPackage.hpp>

Inheritance diagram for openfluid::market::MarketPackage:

[legend]

Public Member Functions
	MarketPackage (const openfluid::ware::WareID_t &ID, const std::string &PackageURL)

virtual	~MarketPackage ()

openfluid::ware::WareID_t	getID () const

virtual MetaPackageInfo::SelectionType	getFormat () const =0

virtual std::string	getInstallPath () const =0

virtual PackageInfo::PackageType	getPackageType () const =0

virtual void	process ()=0

void	download ()

Static Public Member Functions
static void	initialize (bool EnableLog)

static void	setWorksDirs (const std::string &TempDir, const std::string &MarketBagSimulatorDir, const std::string &MarketBagObserverDir, const std::string &MarketBagBuilderextDir, const std::string &MarketBagDatasetDir, const std::string &MarketBagBinSubDir, const std::string &MarketBagSrcSubDir)

static std::string	getMarketBagSimulatorDir ()

static std::string	getMarketBagObserverDir ()

static std::string	getMarketBagBuilderextDir ()

static std::string	getMarketBagDatasetDir ()

static std::string	getMarketBagBinSubDir ()

static std::string	getMarketBagSrcSubDir ()

static std::string	getTempDir ()

static std::string	getTempBuildsDir ()

static std::string	getTempDownloadsDir ()

static std::string	getLogFile ()

static std::string	getCommonBuildOptions (const PackageInfo::PackageType &Type)

static void	setCommonBuildOptions (const PackageInfo::PackageType &Type, const std::string &BuildOptions)

static std::string	composeFullBuildOptions (const PackageInfo::PackageType &Type, const std::string &BuildOptions)

Static Protected Member Functions
static void	resetLogFile ()

static void	appendToLogFile (const std::string &PackageName, const PackageInfo::PackageType &Type, const std::string &Action, const std::string &Str)

static void	appendToLogFile (const std::string &Str)

Protected Attributes
openfluid::ware::WareID_t	m_ID

std::string	m_PackageURL

std::string	m_PackageFilename

std::string	m_PackageDest

bool	m_Downloaded

Static Protected Attributes
static const std::string	BUILDS_SUBDIR

static const std::string	DLOADS_SUBDIR

static const std::string	LOG_FILENAME

static std::string	m_TempDir

static std::string	m_TempBuildsDir

static std::string	m_TempDownloadsDir

static std::string	m_MarketBagSimulatorDir

static std::string	m_MarketBagObserverDir

static std::string	m_MarketBagBuilderextDir

static std::string	m_MarketBagDatasetDir

static std::string	m_MarketBagBinSubDir

static std::string	m_MarketBagSrcSubDir

static std::string	m_SimulatorBuildConfigOptions

static std::string	m_ObserverBuildConfigOptions

static std::string	m_BuilderextBuildConfigOptions

static std::string	m_LogFile

static bool	m_IsLogEnabled

static bool	m_Initialized

Constructor & Destructor Documentation

◆ MarketPackage()

openfluid::market::MarketPackage::MarketPackage	(	const openfluid::ware::WareID_t &	ID,
		const std::string &	PackageURL
	)

◆ ~MarketPackage()

virtual openfluid::market::MarketPackage::~MarketPackage ( )

virtual

Member Function Documentation

◆ appendToLogFile() [1/2]

static void openfluid::market::MarketPackage::appendToLogFile	(	const std::string &	PackageName,
		const PackageInfo::PackageType &	Type,
		const std::string &	Action,
		const std::string &	Str
	)

staticprotected

◆ appendToLogFile() [2/2]

static void openfluid::market::MarketPackage::appendToLogFile ( const std::string & Str )

staticprotected

◆ composeFullBuildOptions()

static std::string openfluid::market::MarketPackage::composeFullBuildOptions	(	const PackageInfo::PackageType &	Type,
		const std::string &	BuildOptions
	)

static

Adds BuildOptions to options of package type

Returns: Common build options of package type with BuildOptions

Parameters

Type	of package
BuildOptions	to add

◆ download()

void openfluid::market::MarketPackage::download ( )

◆ getCommonBuildOptions()

static std::string openfluid::market::MarketPackage::getCommonBuildOptions ( const PackageInfo::PackageType & Type )

static

Returns: build options of package type passed as parameter

Parameters

Type	of options

◆ getFormat()

virtual MetaPackageInfo::SelectionType openfluid::market::MarketPackage::getFormat ( ) const

pure virtual

Implemented in openfluid::market::MarketSrcPackage, openfluid::market::MarketDatasetPackage, and openfluid::market::MarketBinPackage.

◆ getID()

openfluid::ware::WareID_t openfluid::market::MarketPackage::getID ( ) const

inline

◆ getInstallPath()

virtual std::string openfluid::market::MarketPackage::getInstallPath ( ) const

pure virtual

Returns: the market-bag path directory for the package type class

Implemented in openfluid::market::MarketSrcObserverPackage, openfluid::market::MarketSrcSimulatorPackage, openfluid::market::MarketBinBuilderextPackage, openfluid::market::MarketBinObserverPackage, openfluid::market::MarketBinSimulatorPackage, openfluid::market::MarketDatasetPackage, and openfluid::market::MarketSrcBuilderextPackage.

◆ getLogFile()

static std::string openfluid::market::MarketPackage::getLogFile ( )

inlinestatic

◆ getMarketBagBinSubDir()

static std::string openfluid::market::MarketPackage::getMarketBagBinSubDir ( )

inlinestatic

◆ getMarketBagBuilderextDir()

static std::string openfluid::market::MarketPackage::getMarketBagBuilderextDir ( )

inlinestatic

◆ getMarketBagDatasetDir()

static std::string openfluid::market::MarketPackage::getMarketBagDatasetDir ( )

inlinestatic

◆ getMarketBagObserverDir()

static std::string openfluid::market::MarketPackage::getMarketBagObserverDir ( )

inlinestatic

◆ getMarketBagSimulatorDir()

static std::string openfluid::market::MarketPackage::getMarketBagSimulatorDir ( )

inlinestatic

◆ getMarketBagSrcSubDir()

static std::string openfluid::market::MarketPackage::getMarketBagSrcSubDir ( )

inlinestatic

◆ getPackageType()

virtual PackageInfo::PackageType openfluid::market::MarketPackage::getPackageType ( ) const

pure virtual

Returns: type of current package

Implemented in openfluid::market::MarketSrcObserverPackage, openfluid::market::MarketSrcSimulatorPackage, openfluid::market::MarketBinBuilderextPackage, openfluid::market::MarketBinObserverPackage, openfluid::market::MarketBinSimulatorPackage, openfluid::market::MarketDatasetPackage, and openfluid::market::MarketSrcBuilderextPackage.

◆ getTempBuildsDir()

static std::string openfluid::market::MarketPackage::getTempBuildsDir ( )

inlinestatic

◆ getTempDir()

static std::string openfluid::market::MarketPackage::getTempDir ( )

inlinestatic

◆ getTempDownloadsDir()

static std::string openfluid::market::MarketPackage::getTempDownloadsDir ( )

inlinestatic

◆ initialize()

static void openfluid::market::MarketPackage::initialize ( bool EnableLog )

static

◆ process()

virtual void openfluid::market::MarketPackage::process ( )

pure virtual

Implemented in openfluid::market::MarketSrcPackage, openfluid::market::MarketDatasetPackage, and openfluid::market::MarketBinPackage.

◆ resetLogFile()

static void openfluid::market::MarketPackage::resetLogFile ( )

staticprotected

◆ setCommonBuildOptions()

static void openfluid::market::MarketPackage::setCommonBuildOptions	(	const PackageInfo::PackageType &	Type,
		const std::string &	BuildOptions
	)

static

Sets build options of package type passed as parameter with BuildOptions

Parameters

Type	of options
BuildOptions	options to store

◆ setWorksDirs()

static void openfluid::market::MarketPackage::setWorksDirs	(	const std::string &	TempDir,
		const std::string &	MarketBagSimulatorDir,
		const std::string &	MarketBagObserverDir,
		const std::string &	MarketBagBuilderextDir,
		const std::string &	MarketBagDatasetDir,
		const std::string &	MarketBagBinSubDir,
		const std::string &	MarketBagSrcSubDir
	)

static

Set directory paths attributes with paths passed as parameter

Member Data Documentation

◆ BUILDS_SUBDIR

const std::string openfluid::market::MarketPackage::BUILDS_SUBDIR

staticprotected

◆ DLOADS_SUBDIR

const std::string openfluid::market::MarketPackage::DLOADS_SUBDIR

staticprotected

◆ LOG_FILENAME

const std::string openfluid::market::MarketPackage::LOG_FILENAME

staticprotected

◆ m_BuilderextBuildConfigOptions

std::string openfluid::market::MarketPackage::m_BuilderextBuildConfigOptions

staticprotected

Common build options for builder extensions

◆ m_Downloaded

bool openfluid::market::MarketPackage::m_Downloaded

protected

◆ m_ID

openfluid::ware::WareID_t openfluid::market::MarketPackage::m_ID

protected

◆ m_Initialized

bool openfluid::market::MarketPackage::m_Initialized

staticprotected

◆ m_IsLogEnabled

bool openfluid::market::MarketPackage::m_IsLogEnabled

staticprotected

◆ m_LogFile

std::string openfluid::market::MarketPackage::m_LogFile

staticprotected

◆ m_MarketBagBinSubDir

std::string openfluid::market::MarketPackage::m_MarketBagBinSubDir

staticprotected

Market-bag subdir for binary packages of current type

◆ m_MarketBagBuilderextDir

std::string openfluid::market::MarketPackage::m_MarketBagBuilderextDir

staticprotected

Market-bag dir for builder extensions

◆ m_MarketBagDatasetDir

std::string openfluid::market::MarketPackage::m_MarketBagDatasetDir

staticprotected

Market-bag dir for datasets

◆ m_MarketBagObserverDir

std::string openfluid::market::MarketPackage::m_MarketBagObserverDir

staticprotected

Market-bag dir for observers

◆ m_MarketBagSimulatorDir

std::string openfluid::market::MarketPackage::m_MarketBagSimulatorDir

staticprotected

Market-bag dir for simulators

◆ m_MarketBagSrcSubDir

std::string openfluid::market::MarketPackage::m_MarketBagSrcSubDir

staticprotected

Market-bag subdir for source packages of current type

◆ m_ObserverBuildConfigOptions

std::string openfluid::market::MarketPackage::m_ObserverBuildConfigOptions

staticprotected

Common build options for observers

◆ m_PackageDest

std::string openfluid::market::MarketPackage::m_PackageDest

protected

◆ m_PackageFilename

std::string openfluid::market::MarketPackage::m_PackageFilename

protected

◆ m_PackageURL

std::string openfluid::market::MarketPackage::m_PackageURL

protected

◆ m_SimulatorBuildConfigOptions

std::string openfluid::market::MarketPackage::m_SimulatorBuildConfigOptions

staticprotected

Common build options for simulators

◆ m_TempBuildsDir

std::string openfluid::market::MarketPackage::m_TempBuildsDir

staticprotected

Temporary dir for building packages

◆ m_TempDir

std::string openfluid::market::MarketPackage::m_TempDir

staticprotected

◆ m_TempDownloadsDir

std::string openfluid::market::MarketPackage::m_TempDownloadsDir

staticprotected

Temporary dir for downloaded packages

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

market/MarketPackage.hpp

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ MarketPackage()

◆ ~MarketPackage()

Member Function Documentation

◆ appendToLogFile() [1/2]

◆ appendToLogFile() [2/2]

◆ composeFullBuildOptions()

◆ download()

◆ getCommonBuildOptions()

◆ getFormat()

◆ getID()

◆ getInstallPath()

◆ getLogFile()

◆ getMarketBagBinSubDir()

◆ getMarketBagBuilderextDir()

◆ getMarketBagDatasetDir()

◆ getMarketBagObserverDir()

◆ getMarketBagSimulatorDir()

◆ getMarketBagSrcSubDir()

◆ getPackageType()

◆ getTempBuildsDir()

◆ getTempDir()

◆ getTempDownloadsDir()

◆ initialize()

◆ process()

◆ resetLogFile()

◆ setCommonBuildOptions()

◆ setWorksDirs()

Member Data Documentation

◆ BUILDS_SUBDIR

◆ DLOADS_SUBDIR

◆ LOG_FILENAME

◆ m_BuilderextBuildConfigOptions

◆ m_Downloaded

◆ m_ID

◆ m_Initialized

◆ m_IsLogEnabled

◆ m_LogFile

◆ m_MarketBagBinSubDir

◆ m_MarketBagBuilderextDir

◆ m_MarketBagDatasetDir

◆ m_MarketBagObserverDir

◆ m_MarketBagSimulatorDir

◆ m_MarketBagSrcSubDir

◆ m_ObserverBuildConfigOptions

◆ m_PackageDest

◆ m_PackageFilename

◆ m_PackageURL

◆ m_SimulatorBuildConfigOptions

◆ m_TempBuildsDir

◆ m_TempDir

◆ m_TempDownloadsDir