165 lines
4.7 KiB
C++
165 lines
4.7 KiB
C++
/*
|
|
* This file is part of ACADO Toolkit.
|
|
*
|
|
* ACADO Toolkit -- A Toolkit for Automatic Control and Dynamic Optimization.
|
|
* Copyright (C) 2008-2014 by Boris Houska, Hans Joachim Ferreau,
|
|
* Milan Vukov, Rien Quirynen, KU Leuven.
|
|
* Developed within the Optimization in Engineering Center (OPTEC)
|
|
* under supervision of Moritz Diehl. All rights reserved.
|
|
*
|
|
* ACADO Toolkit is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or (at your option) any later version.
|
|
*
|
|
* ACADO Toolkit is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with ACADO Toolkit; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
* \file include/acado/code_generation/export_statement.hpp
|
|
* \authors Hans Joachim Ferreau, Boris Houska, Milan Vukov
|
|
* \date 2010 - 2013
|
|
*/
|
|
|
|
|
|
#ifndef ACADO_TOOLKIT_EXPORT_STATEMENT_HPP
|
|
#define ACADO_TOOLKIT_EXPORT_STATEMENT_HPP
|
|
|
|
#include <acado/utils/acado_utils.hpp>
|
|
|
|
#include <memory>
|
|
|
|
BEGIN_NAMESPACE_ACADO
|
|
|
|
|
|
class ExportIndex;
|
|
class MemoryAllocator;
|
|
|
|
|
|
/**
|
|
* \brief Base class for all kind of statements to be exported by the code generation tool.
|
|
*
|
|
* \ingroup AuxiliaryFunctionality
|
|
*
|
|
* The class ExportStatement serves as a base class for all kind of statements to be exported
|
|
* by the code generation tool.
|
|
*
|
|
* \authors Hans Joachim Ferreau, Boris Houska, Milan Vukov
|
|
*/
|
|
class ExportStatement
|
|
{
|
|
//
|
|
// PUBLIC MEMBER FUNCTIONS:
|
|
//
|
|
public:
|
|
|
|
/** Shared pointer to a statement. */
|
|
typedef std::shared_ptr< ExportStatement > StatementPtr;
|
|
|
|
/** A vector of shared pointer statements. */
|
|
typedef std::vector< StatementPtr > StatementPtrArray;
|
|
|
|
/** Shared pointer to a memory allocator */
|
|
typedef std::shared_ptr< MemoryAllocator > MemoryAllocatorPtr;
|
|
|
|
/** Default constructor. */
|
|
ExportStatement( );
|
|
|
|
/** Copy constructor (deep copy).
|
|
*
|
|
* @param[in] arg Right-hand side object.
|
|
*/
|
|
ExportStatement( const ExportStatement& arg
|
|
);
|
|
|
|
/** Destructor. */
|
|
virtual ~ExportStatement( );
|
|
|
|
/** Assignment operator (deep copy).
|
|
*
|
|
* @param[in] arg Right-hand side object.
|
|
*/
|
|
ExportStatement& operator=( const ExportStatement& arg
|
|
);
|
|
|
|
/** Clone constructor (deep copy).
|
|
*
|
|
* \return Pointer to cloned object.
|
|
*/
|
|
virtual ExportStatement* clone( ) const = 0;
|
|
|
|
|
|
/** Exports data declaration of the statement into given file. Its appearance can
|
|
* can be adjusted by various options.
|
|
*
|
|
* @param[in] stream Name of file to be used to export statement.
|
|
* @param[in] _realString std::string to be used to declare real variables.
|
|
* @param[in] _intString std::string to be used to declare integer variables.
|
|
* @param[in] _precision Number of digits to be used for exporting real values.
|
|
*
|
|
* \return SUCCESSFUL_RETURN
|
|
*/
|
|
virtual returnValue exportDataDeclaration( std::ostream& stream,
|
|
const std::string& _realString = "real_t",
|
|
const std::string& _intString = "int",
|
|
int _precision = 16
|
|
) const;
|
|
|
|
/** Exports source code of the statement into given file. Its appearance can
|
|
* can be adjusted by various options.
|
|
*
|
|
* @param[in] stream Name of file to be used to export statement.
|
|
* @param[in] _realString std::string to be used to declare real variables.
|
|
* @param[in] _intString std::string to be used to declare integer variables.
|
|
* @param[in] _precision Number of digits to be used for exporting real values.
|
|
*
|
|
* \return SUCCESSFUL_RETURN
|
|
*/
|
|
virtual returnValue exportCode( std::ostream& stream,
|
|
const std::string& _realString = "real_t",
|
|
const std::string& _intString = "int",
|
|
int _precision = 16
|
|
) const = 0;
|
|
|
|
/** Acquire an index. */
|
|
virtual ExportStatement& acquire( ExportIndex& )
|
|
{
|
|
return *this;
|
|
}
|
|
|
|
/** Release an index. */
|
|
virtual ExportStatement& release( const ExportIndex& )
|
|
{
|
|
return *this;
|
|
}
|
|
|
|
/** Set a memory allocator. */
|
|
virtual ExportStatement& allocate( MemoryAllocatorPtr )
|
|
{
|
|
return *this;
|
|
}
|
|
|
|
|
|
public:
|
|
static std::string fcnPrefix;
|
|
static std::string varPrefix;
|
|
};
|
|
|
|
|
|
CLOSE_NAMESPACE_ACADO
|
|
|
|
|
|
#endif // ACADO_TOOLKIT_EXPORT_STATEMENT_HPP
|
|
|
|
// end of file.
|