Abstract base class to define variables to be used for exporting code. More...

#include <export_data.hpp>

Inheritance diagram for ExportData:

Public Member Functions
	ExportData ()
virtual returnValue	exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
ExportStruct	getDataStruct () const
std::string	getDataStructString () const
virtual std::string	getDoc () const
std::string	getFullName () const
std::string	getName () const
std::string	getPrefix () const
ExportType	getType () const
std::string	getTypeString (const std::string &_realString="real_t", const std::string &_intString="int") const
virtual bool	isGiven ()
ExportDataInternal *	operator-> ()
const ExportDataInternal *	operator-> () const
returnValue	setDataStruct (ExportStruct _dataStruct)
virtual returnValue	setDoc (const std::string &_doc)
returnValue	setName (const std::string &_name)
returnValue	setPrefix (const std::string &_prefix)
returnValue	setType (ExportType _type)
virtual	~ExportData ()

Detailed Description

Abstract base class to define variables to be used for exporting code.

The class ExportData serves as an abstract base class to define variables to be used for exporting code.

Author:: Hans Joachim Ferreau, Boris Houska, Milan Vukov

Definition at line 55 of file export_data.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportData::ExportData ( )

Default constructor.

Definition at line 45 of file export_data.cpp.

ExportData::~ExportData ( ) [virtual]

Destructor.

Definition at line 48 of file export_data.cpp.

Member Function Documentation

returnValue ExportData::exportDataDeclaration	(	std::ostream &	stream,
		const std::string &	_realString = `"real_t"`,
		const std::string &	_intString = `"int"`,
		int	_precision = `16`
	)		const `[virtual]`

Exports declaration of the index variable. Its appearance can can be adjusted by various options.

Parameters:

[in]	stream	Name of file to be used to export function.
[in]	_realString	std::string to be used to declare real variables.
[in]	_intString	std::string to be used to declare integer variables.
[in]	_precision	Number of digits to be used for exporting real values.

Returns:: SUCCESSFUL_RETURN

Reimplemented in ExportArgument, and ExportIndex.

Definition at line 126 of file export_data.cpp.

ExportStruct ExportData::getDataStruct ( ) const

Returns the global data struct to which the data object belongs to.

Returns:: Global data struct to which the data object belongs to

Definition at line 109 of file export_data.cpp.

std::string ExportData::getDataStructString ( ) const

Returns a string containing the global data struct to which the data object belongs to.

Returns:: std::string containing the global data struct to which the data object belongs to.

Definition at line 115 of file export_data.cpp.

std::string ExportData::getDoc ( ) const [virtual]

Definition at line 146 of file export_data.cpp.

std::string ExportData::getFullName ( ) const

Returns the full name of the data object including the possible prefix of the global data struct.

Returns:: Full name of the data object

Definition at line 121 of file export_data.cpp.

std::string ExportData::getName ( ) const

Returns the name of the data object.

Returns:: Name of the data object

Definition at line 86 of file export_data.cpp.

std::string ExportData::getPrefix ( ) const

Returns a string which contains a prefix name.

Returns:: Prefix name

Definition at line 96 of file export_data.cpp.

ExportType ExportData::getType ( ) const

Returns the data type of the data object.

Returns:: Data type of the data object

Definition at line 91 of file export_data.cpp.

std::string ExportData::getTypeString	(	const std::string &	_realString = `"real_t"`,
		const std::string &	_intString = `"int"`
	)		const

Returns a string containing the data type of the data object.

Parameters:

[in]	_realString	std::string to be used to declare real variables.
[in]	_intString	std::string to be used to declare integer variables.

Returns:: std::string containing the data type of the data object.

Definition at line 101 of file export_data.cpp.

bool ExportData::isGiven ( ) [virtual]

Returns whether the index is set to a given value.

Returns:: true iff index is set to a given value,
false otherwise

Definition at line 135 of file export_data.cpp.

ExportDataInternal * ExportData::operator-> ( )

An operator for access to functions and members of the node

Reimplemented from CasADi::SharedObject.

Reimplemented in ExportVariable, ExportArgument, and ExportIndex.

Definition at line 51 of file export_data.cpp.

const ExportDataInternal * ExportData::operator-> ( ) const

An operator for const access to functions and members of the node

Reimplemented from CasADi::SharedObject.

Reimplemented in ExportVariable, ExportArgument, and ExportIndex.

Definition at line 56 of file export_data.cpp.

returnValue ExportData::setDataStruct ( ExportStruct _dataStruct )

Sets the global data struct to which the data object belongs to.

Parameters:

[in] _dataStruct New global data struct to which the data object belongs to.

Returns:: SUCCESSFUL_RETURN

Definition at line 80 of file export_data.cpp.

returnValue ExportData::setDoc ( const std::string & _doc ) [virtual]

Definition at line 140 of file export_data.cpp.

returnValue ExportData::setName ( const std::string & _name )

Sets the name of the data object.

Parameters:

[in] _name New name of the data object.

Returns:: SUCCESSFUL_RETURN

Definition at line 61 of file export_data.cpp.

returnValue ExportData::setPrefix ( const std::string & _prefix )

Sets the prefix which is placed before the structure name.

Parameters:

[in] _prefix Prefix name.

Returns:: SUCCESSFUL_RETURN

Definition at line 74 of file export_data.cpp.

returnValue ExportData::setType ( ExportType _type )

Sets the data type of the data object.

Parameters:

[in] _type New data type of the data object.

Returns:: SUCCESSFUL_RETURN

Definition at line 68 of file export_data.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation