ExportDataDeclaration Class Reference

Allows to export code containing variable declarations. More...

#include <export_data_declaration.hpp>

Inheritance diagram for ExportDataDeclaration:

Public Member Functions
virtual ExportStatement *	clone () const
virtual returnValue	exportCode (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
	ExportDataDeclaration ()
	ExportDataDeclaration (const ExportVariable &_data)
	ExportDataDeclaration (const ExportIndex &_data)
	ExportDataDeclaration (const ExportDataDeclaration &arg)
ExportDataDeclaration &	operator= (const ExportDataDeclaration &arg)
virtual	~ExportDataDeclaration ()
Public Member Functions inherited from ExportStatement
virtual ExportStatement &	acquire (ExportIndex &)
virtual ExportStatement &	allocate (MemoryAllocatorPtr)
virtual returnValue	exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
	ExportStatement ()
	ExportStatement (const ExportStatement &arg)
ExportStatement &	operator= (const ExportStatement &arg)
virtual ExportStatement &	release (const ExportIndex &)
virtual	~ExportStatement ()

Protected Attributes
ExportData	data

Additional Inherited Members
Public Types inherited from ExportStatement
typedef std::shared_ptr< MemoryAllocator >	MemoryAllocatorPtr
typedef std::shared_ptr< ExportStatement >	StatementPtr
typedef std::vector< StatementPtr >	StatementPtrArray
Static Public Attributes inherited from ExportStatement
static std::string	fcnPrefix = "acado"
static std::string	varPrefix = "ACADO"

Detailed Description

Allows to export code containing variable declarations.

The class ExportDataDeclaration allows to export code containing variable declarations of different data types.

Author

Hans Joachim Ferreau, Boris Houska

Definition at line 60 of file export_data_declaration.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportDataDeclaration::ExportDataDeclaration

(

)

Default constructor.

Definition at line 44 of file export_data_declaration.cpp.

ExportDataDeclaration::ExportDataDeclaration

(

const ExportVariable &

_data

)

Constructor taking the variable to be declared.

@param[in] _data    Variable to be declared.

Definition at line 48 of file export_data_declaration.cpp.

ExportDataDeclaration::ExportDataDeclaration

(

const ExportIndex &

_data

)

Constructor taking the index variable to be declared.

@param[in] _data    Index Variable to be declared.

Definition at line 55 of file export_data_declaration.cpp.

ExportDataDeclaration::ExportDataDeclaration

(

const ExportDataDeclaration &

arg

)

Copy constructor (deep copy).

@param[in] arg              Right-hand side object.

Definition at line 62 of file export_data_declaration.cpp.

ExportDataDeclaration::~ExportDataDeclaration ( )

virtual

Destructor.

Definition at line 69 of file export_data_declaration.cpp.

Member Function Documentation

ExportStatement * ExportDataDeclaration::clone ( ) const

virtual

Clone constructor (deep copy).

\return Pointer to cloned object.

Implements ExportStatement.

Definition at line 86 of file export_data_declaration.cpp.

returnValue ExportDataDeclaration::exportCode ( std::ostream &  stream, const std::string &  _realString = "real_t", const std::string &  _intString = "int", int  _precision = 16  ) const

virtual

Exports source code of the statement into given file. Its appearance can can be adjusted by various options.

@param[in] file                             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

Implements ExportStatement.

Definition at line 94 of file export_data_declaration.cpp.

ExportDataDeclaration & ExportDataDeclaration::operator=

(

const ExportDataDeclaration &

arg

)

Assignment operator (deep copy).

@param[in] arg              Right-hand side object.

Definition at line 73 of file export_data_declaration.cpp.

Member Data Documentation

ExportData ExportDataDeclaration::data

protected

Variable to be declared.

Definition at line 136 of file export_data_declaration.hpp.

---

The documentation for this class was generated from the following files:

• export_data_declaration.hpp
• export_data_declaration.cpp