Bpp/Standard Environment | C++ |
|  |
This module provides facilities to access general information about the program and the library. It also provides facilities to display messages. This section allows you to access the C++ source files of the module. This module is part of Bpp/Standard . The files listed below are included in the interface part of the module. So any module dependent of this module is also dependent of the files listed here. The files listed below are needed by the implementation part of the module. But a module dependent of this module is not necessary dependent of the files listed here. <bpp/license.hpp>
<bpp/modules.hpp>
The namespaces listed below are integrated in this module. That means any element declared in one of those namespaces can now be directly used by or from this module. The macrocommands listed below can be used without specifying the namespace where they have been defined. That means you can not define an element by your own that have the same name. Here are listed the types defined in the module. To use one of them, you have to specify the namespace of the module. type std_map(private_area::clString,private_area::clString) clParameterS List of parameters with their value.
enumeration { success, failure } tyProgramResult Program result (success or failure ).
Here are listed the constants provided by the module. To use one of them, you have to specify the namespace of the module. tcString copyright() Copyright of the program.
tcString compiler() Compiler used to make the program.
tcString lastUpdate() Last update of the program.
tcString operatingSystem() Operating system the program is designed for.
tcString programmerEmail() Programmer's e-mail.
tcString programmerName() Programmer's name.
tcString programmerURL() Programmer's URL.
tcString programName() Name of the program.
clParameterS parameters() Parameters given to the program through the initialization file.
tyInteger startingClock() Value of the computer clock at the start of the program.
tyBoolean informationDisplayed() Indicates if information messages can be displayed.
Here are listed the functions provided by the module. To use one of them, you have to specify the namespace of the module. inline const private_area::tyString randomSeed(void) Returns the seed of the default random number generator.
inline const private_area::tyString startingDate(void) Returns the date of the start of the program.
inline private_area::ctString & dataLocation(void) Returns the location of the data files of the program.
inline private_area::ctString & temporaryLocation(void) Returns the location of the temporary folder used by the program.
inline private_area::ctString & parameter(private_area::ctString & agVariable) Returns the value of a given parameter of the initialization file.
inline private_area::ctString & testingLocation(void) Returns the location where the testing results are stored. This function exists only in the testing mode.
inline void nextLine(void) Jumps to the next line in the display.
inline void inform(private_area::tcString agMessage,private_area::tyBoolean agNextLine) Displays a message as a main information. The second argument orders to jump to the next line (default = true ).
inline void informAutoTesting(private_area::tcString agModuleName) Informs that an auto-testing is processed.
inline void informInitialization(private_area::tcString agModuleName) Informs that a module is initialized.
inline void informTermination(private_area::tcString agModuleName) Informs that a module is terminated.
inline void informTesting(private_area::tcString agModuleName) Informs that a module is tested.
inline void showProgression(private_area::tyCardinal agCurrent,private_area::tyCardinal agNumber,private_area::tyCardinal agStep) Shows the progression of a process.
inline void warn(private_area::tcString agMessage,private_area::tyBoolean agNextLine) Displays a message as a warning.
inline tyInteger currentClock(void) Returns the current value of the computer clock.
template <class prKey,class prElement> inline std::pair<const prKey,prElement> make_map_pair(const prKey & agKey,const prElement & agElement) For efficiency reasons, the make_pair of the STL is rewritten. This version is adapted to pairs for the STL map structure (where the first element's type is constant). Do not use this function directly, instead you should use the std_make_pair keyword.
template <class prObject> void out(const prObject & agObject,private_area::tyBoolean agNextLine,private_area::tyBoolean agTabulation) Displays an object. The second argument orders to jump to the next line (default = false ). The third argument orders to place a tabulation at the beginning (default = false ).
function tyReturn quit(tyProgramResult agResult) Quits the program.
function void outContext(void) Displays the context of the library.
function void outContext(private_area::clOutStream & agStream) Writes the context of the library into a stream.
function void outFlags(void) Displays the compilation flags of the library.
function void outFlags(private_area::clOutStream & agStream) Writes the compilation flags of the library into a stream.
function void outInformation(void) Displays general information about the program.
function void outInformation(private_area::clOutStream & agStream) Writes general information about the program into a stream.
function void outLicense(void) Displays the license of the library and the program.
function void outLicense(private_area::clOutStream & agStream) Writes the license of the library and the program into a stream.
function void warnAutoTestingFailure(private_area::tcString agModuleName,private_area::tcString agBugFileName) Displays a warning of auto-testing failure.
function void terminate(void) Informs that the library terminates abnormally.
| | Copyright (c) 1999-2016 - Bruno Bachelet - bruno@nawouak.net - http://www.nawouak.net | Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. See this license for more details (http://www.gnu.org). |
|
| |