FFaAppInfo Class Reference

Class to store information about the application. More...

#include <FFaAppInfo.H>

Public Member Functions
	FFaAppInfo ()
	The constructor gets meta information of this application. More...

Static Public Member Functions
static void	openConsole (bool withGUI=false)
	Sets this to be a console application, optionally with GUI too. More...
static void	closeConsole (bool acknowledge=true)
	Closes the current console window. More...
static bool	isConsole ()
	Returns true if this is a console-only application. More...
static bool	haveConsole ()
	Returns true if this application has a console windows. More...
static void	init (const char *program)
	Initializes the program path. More...
static const std::string &	getProgramPath ()
	Returns the program path. More...
static bool	isInCwd ()
	Returns whether this program is in current working dir or not. More...
static std::string	getCWD ()
	Returns the current working directory of the program. More...
static std::string	getProgramPath (const std::string &program, bool fnutts=true)
	Returns full path of a program, or blank if not existing. More...
static std::string	checkProgramPath (const std::string &program)
	Returns path of a program, or blank if not existing. More...

Public Attributes
std::string	version
	Current program version. More...
std::string	user
	User name of running process. More...
std::string	date
	Current date and time. More...

Static Private Attributes
static char	consoleFlag = 0
	0: no console, 1: only console, 2: console+GUI More...
static int	runInConsole = -1
	If positive, the executable is run from console. More...
static bool	iAmInCwd = false
	If true, the executable is in current work dir. More...
static std::string	programPath
	Absolute path of this executable. More...

Detailed Description

Class to store information about the application.

E.g. UI-type (console, GUI), version number, user data, etc.

Constructor & Destructor Documentation

FFaAppInfo()

FFaAppInfo::FFaAppInfo

(

)

The constructor gets meta information of this application.

Member Function Documentation

checkProgramPath()

std::string FFaAppInfo::checkProgramPath ( const std::string &  program )

static

Returns path of a program, or blank if not existing.

closeConsole()

void FFaAppInfo::closeConsole ( bool  acknowledge = true )

static

Closes the current console window.

getCWD()

std::string FFaAppInfo::getCWD ( )

static

Returns the current working directory of the program.

getProgramPath() [1/2]

static const std::string& FFaAppInfo::getProgramPath ( )

inlinestatic

Returns the program path.

getProgramPath() [2/2]

std::string FFaAppInfo::getProgramPath ( const std::string &  program, bool  fnutts = true  )

static

Returns full path of a program, or blank if not existing.

haveConsole()

static bool FFaAppInfo::haveConsole ( )

inlinestatic

Returns true if this application has a console windows.

init()

void FFaAppInfo::init ( const char *  program )

static

Initializes the program path.

isConsole()

static bool FFaAppInfo::isConsole ( )

inlinestatic

Returns true if this is a console-only application.

isInCwd()

static bool FFaAppInfo::isInCwd ( )

inlinestatic

Returns whether this program is in current working dir or not.

openConsole()

void FFaAppInfo::openConsole ( bool  withGUI = false )

static

Sets this to be a console application, optionally with GUI too.

Member Data Documentation

consoleFlag

char FFaAppInfo::consoleFlag = 0

staticprivate

0: no console, 1: only console, 2: console+GUI

date

std::string FFaAppInfo::date

Current date and time.

iAmInCwd

bool FFaAppInfo::iAmInCwd = false

staticprivate

If true, the executable is in current work dir.

programPath

std::string FFaAppInfo::programPath

staticprivate

Absolute path of this executable.

runInConsole

int FFaAppInfo::runInConsole = -1

staticprivate

If positive, the executable is run from console.

user

std::string FFaAppInfo::user

User name of running process.

version

std::string FFaAppInfo::version

Current program version.

---

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

• fedem-foundation/src/FFaLib/FFaDefinitions/FFaAppInfo.H
• fedem-foundation/src/FFaLib/FFaDefinitions/FFaAppInfo.C