cfl_helper.h File Reference

Helper functions. More...

#include "cfl_definitions.h"
#include "cfl_platform.h"
#include "cfl_exception.h"

Go to the source code of this file.

Classes
class	faudes::ConsoleOut
	Console Out. More...
class	faudes::ObjectCount
	Debugging counter. More...

Namespaces
	faudes
	libFAUDES resides within the namespace faudes.

Macros
#define	FAUDES_TEST_DUMP(mes, dat)
	Test protocol record macro ("mangle" filename for platform independance) More...
#define	FAUDES_TEST_DIFF()
	Test protocol diff macro. More...

Functions
std::string	faudes::ToStringInteger (Int number)
	integer to string More...
std::string	faudes::ToStringInteger16 (Int number)
	integer to string base 16 More...
std::string	faudes::ToStringFloat (Float number)
	float to string More...
std::string	faudes::ExpandString (const std::string &rString, unsigned int len)
	Fill string with spaces up to a given length if length of the string is smaller than given length parameter. More...
std::string	faudes::CollapsString (const std::string &rString, unsigned int len=FD_MAXCONTAINERNAME)
	Limit length of string, return head and tail of string. More...
Idx	faudes::ToIdx (const std::string &rString)
	Convert a string to Idx. More...
std::string	faudes::StringSubstitute (const std::string &rString, const std::string &rFrom, const std::string &rTo)
	Substitute in string. More...
std::string	faudes::VersionString ()
	Return FAUDES_VERSION as std::string. More...
std::string	faudes::PluginsString ()
	Return FAUDES_PLUGINS as std::string. More...
std::string	faudes::ContributorsString ()
	Return contributors as std::string. More...
void	faudes::ProcessDot (const std::string &rDotFile, const std::string &rOutFile, const std::string &rOutFormat="", const std::string &rDotExec="dot")
	Convenience function: process dot file to graphics output. More...
std::string	faudes::CreateTempFile (void)
	Create a temp file, length 0. More...
bool	faudes::RemoveFile (const std::string &rFileName)
	Delete a file. More...
FAUDES_API const std::string &	faudes::PathSeparator (void)
	Std dir-separator. More...
std::string	faudes::ExtractDirectory (const std::string &rFullPath)
	Extract directory from full path. More...
std::string	faudes::ExtractFilename (const std::string &rFullName)
	Extract file name from full path. More...
std::string	faudes::ExtractBasename (const std::string &rFullName)
	Extract file name from full path. More...
std::string	faudes::ExtractExtension (const std::string &rFullName)
	Extract file name from full path. More...
std::string	faudes::PrependDirectory (const std::string &rDirectory, const std::string &rFileName)
	Construct full path from directory and filename. More...
bool	faudes::FileExists (const std::string &rFilename)
	Test existence of file. More...
bool	faudes::FileDelete (const std::string &rFilename)
	Delete file. More...
bool	faudes::FileCopy (const std::string &rFromFile, const std::string &rToFile)
	Copy file. More...
bool	faudes::DirectoryExists (const std::string &rDirectory)
	Test existence of directory. More...
std::set< std::string >	faudes::ReadDirectory (const std::string &rDirectory)
	Read the contents of the specified directors. More...
std::string	faudes::TestProtocol (const std::string &rSource)
	Test Protocol. More...
void	faudes::TestProtocol (const std::string &rMessage, const Type &rData, bool core=false)
	Test Protocol. More...
void	faudes::TestProtocol (const std::string &rMessage, bool data)
	Test Protocol. More...
void	faudes::TestProtocol (const std::string &rMessage, long int data)
	Test Protocol. More...
void	faudes::TestProtocol (const std::string &rMessage, const std::string &data)
	Test Protocol. More...
bool	faudes::TestProtocol (void)
	Test Protocol. More...
FAUDES_API void	faudes::LoopCallback (bool(*pBreakFnct)(void))
	Algorithm loop callback. More...
void	faudes::LoopCallback (void)
	Algorithm loop callback. More...

Detailed Description

Helper functions.

Definition in file cfl_helper.h.

Macro Definition Documentation

FAUDES_TEST_DIFF

#define FAUDES_TEST_DIFF

(

)

Value:

    { if(!TestProtocol()) { \
    FAUDES_WRITE_CONSOLE("FAUDES_TEST_DIFF: sensed test case error in " << __FILE__); exit(1);} }

Test protocol diff macro.

Definition at line 493 of file cfl_helper.h.

FAUDES_TEST_DUMP

#define FAUDES_TEST_DUMP	(		mes,
			dat
	)

Value:

  { \
  TestProtocol(__FILE__); \
  std::string fname= __FILE__; \
  std::replace(fname.begin(),fname.end(),'\\','/'); \
  fname=ExtractFilename(fname); \
  std::stringstream sstr; \
  sstr << mes << " [at " << fname << ":" << __LINE__ << "]" ; \
  TestProtocol(sstr.str(),dat); }

Test protocol record macro ("mangle" filename for platform independance)

Definition at line 483 of file cfl_helper.h.