acado_io_utils.hpp File Reference

#include <cstdlib>
#include <cstring>
#include <string>
#include <sstream>
#include <fstream>
#include <vector>
#include <iterator>
#include <acado/utils/acado_message_handling.hpp>

Include dependency graph for acado_io_utils.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	std::IoFormatter
Namespaces
namespace	std
Functions
returnValue	acadoCopyFile (const std::string &source, const std::string &destination, const std::string &commentString, bool printCodegenNotice=false)
returnValue	acadoCopyTemplateFile (const std::string &source, const std::string &destination, const std::string &commentString, bool printCodegenNotice=false)
returnValue	acadoCreateFolder (const std::string &name)
double	acadoGetTime ()
returnValue	acadoPrintAutoGenerationNotice (std::ofstream &stream, const std::string &commentString)
returnValue	acadoPrintCopyrightNotice ()
returnValue	acadoPrintCopyrightNotice (const std::string &subpackage)
returnValue	getGlobalStringDefinitions (PrintScheme _printScheme, char **_startString, char **_endString, uint &_width, uint &_precision, char **_colSeparator, char **_rowSeparator)
template<class T >
ostream &	std::operator<< (ostream &stream, vector< T > &array)
template<class T >
ostream &	std::operator<< (ostream &stream, vector< vector< T > > &array)
template<class T >
istream &	std::operator>> (istream &stream, vector< T > &array)
template<class T >
istream &	std::operator>> (istream &stream, vector< vector< T > > &array)
template<typename T >
string	std::toString (T const &value)
Variables
const char	DEFAULT_COL_SEPARATOR [2] = { '\t', '\0' }
const char	DEFAULT_END_STRING [4] = { '\t', ']' , '\n', '\0' }
const char	DEFAULT_LABEL [1] = { '\0' }
const uint	DEFAULT_PRECISION = 16
const char	DEFAULT_ROW_SEPARATOR [6] = { '\t', ']' , '\n', '[', '\t', '\0' }
const char	DEFAULT_START_STRING [3] = { '[' , '\t', '\0' }
const uint	DEFAULT_WIDTH = 22
BEGIN_NAMESPACE_ACADO const char	LINE_SEPARATOR = '\n'
const char	NOT_A_NUMBER [3] = { 'n', 'a', 'n' }
const char	TEXT_SEPARATOR = ' '

---

Function Documentation

returnValue acadoCopyFile	(	const std::string &	source,
		const std::string &	destination,
		const std::string &	commentString,
		bool	printCodegenNotice = false
	)

A function for file copying.

Definition at line 184 of file acado_io_utils.cpp.

returnValue acadoCopyTemplateFile	(	const std::string &	source,
		const std::string &	destination,
		const std::string &	commentString,
		bool	printCodegenNotice = false
	)

A function for copying of template files.

Definition at line 230 of file acado_io_utils.cpp.

returnValue acadoCreateFolder

(

const std::string &

name

)

A function to create a folder.

Definition at line 263 of file acado_io_utils.cpp.

double acadoGetTime

(

)

Returns the current system time.

Returns:

current system time

Definition at line 364 of file acado_io_utils.cpp.

returnValue acadoPrintAutoGenerationNotice	(	std::ofstream &	stream,
		const std::string &	commentString
	)

Prints ACADO Toolkit's copyright notice for auto generated code.

Returns:

SUCCESSFUL_RETURN

Definition at line 333 of file acado_io_utils.cpp.

returnValue acadoPrintCopyrightNotice

(

)

Prints ACADO Toolkit's copyright notice.

Returns:

SUCCESSFUL_RETURN

returnValue acadoPrintCopyrightNotice

(

const std::string &

subpackage

)

Prints ACADO Toolkit's copyright notice for sub-packages.

Returns:

SUCCESSFUL_RETURN

Definition at line 303 of file acado_io_utils.cpp.

returnValue getGlobalStringDefinitions	(	PrintScheme	_printScheme,
		char **	_startString,
		char **	_endString,
		uint &	_width,
		uint &	_precision,
		char **	_colSeparator,
		char **	_rowSeparator
	)

Get global string definitions.

Definition at line 96 of file acado_io_utils.cpp.

---

Variable Documentation

const char DEFAULT_COL_SEPARATOR[2] = { '\t', '\0' }

Definition at line 74 of file acado_io_utils.hpp.

const char DEFAULT_END_STRING[4] = { '\t', ']' , '\n', '\0' }

Definition at line 71 of file acado_io_utils.hpp.

const char DEFAULT_LABEL[1] = { '\0' }

Definition at line 69 of file acado_io_utils.hpp.

const uint DEFAULT_PRECISION = 16

Definition at line 73 of file acado_io_utils.hpp.

const char DEFAULT_ROW_SEPARATOR[6] = { '\t', ']' , '\n', '[', '\t', '\0' }

Definition at line 75 of file acado_io_utils.hpp.

const char DEFAULT_START_STRING[3] = { '[' , '\t', '\0' }

Definition at line 70 of file acado_io_utils.hpp.

const uint DEFAULT_WIDTH = 22

Definition at line 72 of file acado_io_utils.hpp.

BEGIN_NAMESPACE_ACADO const char LINE_SEPARATOR = '\n'

Global definition of the default line separation symbol. This constant should be used for all text-file interaction.

Definition at line 57 of file acado_io_utils.hpp.

const char NOT_A_NUMBER[3] = { 'n', 'a', 'n' }

Global definition of the default text separation symbol. This constant should be used for all text-files interactions.

Definition at line 67 of file acado_io_utils.hpp.

const char TEXT_SEPARATOR = ' '

Global definition of the default text separation symbol. This constant should be used for all text-files interactions.

Definition at line 62 of file acado_io_utils.hpp.