acado_io_utils.cpp File Reference

#include <acado/utils/acado_types.hpp>
#include <acado/utils/acado_constants.hpp>
#include <acado/utils/acado_io_utils.hpp>
#include <acado/code_generation/templates/templates.hpp>

Include dependency graph for acado_io_utils.cpp:

Go to the source code of this file.

Macros
#define	AUTOGEN_NOTICE_LENGTH   15

Functions
returnValue	acadoCopyFile (const std::string &source, const std::string &destination, const std::string &commentString, bool printCodegenNotice)
returnValue	acadoCopyTemplateFile (const std::string &source, const std::string &destination, const std::string &commentString, bool printCodegenNotice)
returnValue	acadoCreateFolder (const std::string &name)
double	acadoGetTime ()
returnValue	acadoPrintAutoGenerationNotice (std::ofstream &stream, const std::string &commentString)
returnValue	acadoPrintCopyrightNotice (const std::string &subpackage)
returnValue	getGlobalStringDefinitions (PrintScheme _printScheme, char **_startString, char **_endString, uint &_width, uint &_precision, char **_colSeparator, char **_rowSeparator)
static uint	getStringLength (const char *string)

Variables
static const char *	autogenerationNotice [AUTOGEN_NOTICE_LENGTH]

Macro Definition Documentation

AUTOGEN_NOTICE_LENGTH

#define AUTOGEN_NOTICE_LENGTH   15

Definition at line 60 of file acado_io_utils.cpp.

Function Documentation

acadoCopyFile()

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 176 of file acado_io_utils.cpp.

acadoCopyTemplateFile()

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 222 of file acado_io_utils.cpp.

acadoCreateFolder()

returnValue acadoCreateFolder

(

const std::string &

name

)

A function to create a folder.

Definition at line 255 of file acado_io_utils.cpp.

acadoGetTime()

double acadoGetTime

(

)

Returns the current system time.

Returns

current system time

Definition at line 356 of file acado_io_utils.cpp.

acadoPrintAutoGenerationNotice()

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 325 of file acado_io_utils.cpp.

acadoPrintCopyrightNotice()

returnValue acadoPrintCopyrightNotice

(

const std::string &

subpackage

)

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

Returns

SUCCESSFUL_RETURN

Definition at line 295 of file acado_io_utils.cpp.

getGlobalStringDefinitions()

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

Get global string definitions.

Definition at line 88 of file acado_io_utils.cpp.

getStringLength()

static uint getStringLength ( const char *  string )

static

Definition at line 80 of file acado_io_utils.cpp.

Variable Documentation

autogenerationNotice

const char* autogenerationNotice[AUTOGEN_NOTICE_LENGTH]

static

Initial value:

=
{
                "This file was auto-generated using the ACADO Toolkit.\n",
                "\n",
                "While ACADO Toolkit is free software released under the terms of\n",
                "the GNU Lesser General Public License (LGPL), the generated code\n",
                "as such remains the property of the user who used ACADO Toolkit\n",
                "to generate this code. In particular, user dependent data of the code\n",
                "do not inherit the GNU LGPL license. On the other hand, parts of the\n",
                "generated code that are a direct copy of source code from the\n",
                "ACADO Toolkit or the software tools it is based on, remain, as derived\n",
                "work, automatically covered by the LGPL license.\n",
                "\n",
                "ACADO Toolkit is distributed in the hope that it will be useful,\n",
                "but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
                "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n",
                "\n"
}

Definition at line 61 of file acado_io_utils.cpp.