openfluid::waresdev::WareSrcChecker Class Reference

Detailed Description

Class to check wares source code

#include <waresdev/WareSrcChecker.hpp>

Public Types
using	ReportingData = openfluid::utils::ReportingData< std::string, std::string >
using	ChecksList = std::vector< std::string >

Public Member Functions
	CPPCLASS_DELETE_FIVE (WareSrcChecker)
	WareSrcChecker (const std::string &SrcPath, const ChecksList &IgnoredChecks={})
ReportingData	performCheck (bool Pedantic=false)

Static Public Member Functions
static unsigned int	tryDetectWareSrcVersion (const openfluid::tools::FilesystemPath &PathObj)

Member Typedef Documentation

ChecksList

using openfluid::waresdev::WareSrcChecker::ChecksList = std::vector<std::string>

ReportingData

using openfluid::waresdev::WareSrcChecker::ReportingData = openfluid::utils::ReportingData<std::string,std::string>

Constructor & Destructor Documentation

WareSrcChecker()

openfluid::waresdev::WareSrcChecker::WareSrcChecker	(	const std::string &	SrcPath,
		const ChecksList &	IgnoredChecks = {}
	)

Constructs a checker

Parameters

[in]	SrcPath	The path to the sources to check
[in]	IgnoredChecks	A list of checks to ignore (none by default)

Member Function Documentation

CPPCLASS_DELETE_FIVE()

openfluid::waresdev::WareSrcChecker::CPPCLASS_DELETE_FIVE

(

WareSrcChecker

)

performCheck()

ReportingData openfluid::waresdev::WareSrcChecker::performCheck

(

bool

Pedantic = false

)

Perform the checks

Parameters

[in]

Pedantic

Enables pedantic supplementary checks

Returns

The report of the performed checks

tryDetectWareSrcVersion()

static unsigned int openfluid::waresdev::WareSrcChecker::tryDetectWareSrcVersion ( const openfluid::tools::FilesystemPath &  PathObj )

static

Tries to detect the OpenFLUID compatibility version of the sources. Currently, it tries to distinguish version 2.2.x from versions below.

Parameters

[in]

PathObj

The path to the sources to detect

Returns

The numeric representation of the detected OpenFLUID version (see below), 0 if version cannot be detected.

Returned value	OpenFLUID version
202000	2.2.0
201000	2.1.x or below

---

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

• waresdev/WareSrcChecker.hpp