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.

Defines
#define	AUTOGEN_NOTICE_LENGTH   23
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]

---

Define Documentation

#define AUTOGEN_NOTICE_LENGTH   23

Definition at line 60 of file acado_io_utils.cpp.

---

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

(

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.

static uint getStringLength

(

const char *

string

)

[static]

Definition at line 88 of file acado_io_utils.cpp.

---

Variable Documentation

const char* autogenerationNotice[AUTOGEN_NOTICE_LENGTH] [static]

Initial value:

{
                "This file was auto-generated by ACADO Code Generation Tool.\n",
                "\n",
                "ACADO Code Generation tool is a sub-package of ACADO toolkit --\n",
                "A Toolkit for Automatic Control and Dynamic Optimization.\n",
                "Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,\n",
                "Milan Vukov, Rien Quirynen, KU Leuven.\n",
                "Developed within the Optimization in Engineering Center (OPTEC)\n",
                "under supervision of Moritz Diehl. All rights reserved.\n",
                "\n",
                "ACADO Toolkit is free software; you can redistribute it and/or\n",
                "modify it under the terms of the GNU Lesser General Public\n",
                "License as published by the Free Software Foundation; either\n",
                "version 3 of the License, or (at your option) any later version.\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.  See the GNU\n",
                "Lesser General Public License for more details.\n",
                "\n",
                "You should have received a copy of the GNU Lesser General Public\n",
                "License along with ACADO Toolkit; if not, write to the Free Software\n",
                "Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA\n",
                "\n"
}

Definition at line 61 of file acado_io_utils.cpp.