Public Member Functions | Private Attributes
ExportIndexNode Class Reference

#include <export_index_node.hpp>

Inheritance diagram for ExportIndexNode:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ExportIndexNodeclone () const
 Make a deep copy of the instance.
virtual returnValue exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
 ExportIndexNode (const std::string &_name, const std::string &_prefix, const int _factor=1, const int _offset=0)
 ExportIndexNode (const int _value)
 ExportIndexNode (ExportStatementOperator _op, const ExportIndex &_arg1, const ExportIndex &_arg2)
const std::string get () const
 Returns a string containing the value of the index.
const int getFactor () const
const int getGivenValue () const
const int getOffset () const
bool isBinary () const
virtual bool isGiven () const
bool isVariable () const
virtual ~ExportIndexNode ()

Private Attributes

int factor
ExportIndex left
int offset
int op
ExportIndex right
int value
ExportVariableType varType

Detailed Description

Definition at line 50 of file export_index_node.hpp.


Constructor & Destructor Documentation

ExportIndexNode::ExportIndexNode ( const std::string &  _name,
const std::string &  _prefix,
const int  _factor = 1,
const int  _offset = 0 
) [inline]

Definition at line 53 of file export_index_node.hpp.

ExportIndexNode::ExportIndexNode ( const int  _value) [inline, explicit]

Definition at line 77 of file export_index_node.hpp.

ExportIndexNode::ExportIndexNode ( ExportStatementOperator  _op,
const ExportIndex _arg1,
const ExportIndex _arg2 
) [inline]

Definition at line 82 of file export_index_node.hpp.

virtual ExportIndexNode::~ExportIndexNode ( ) [inline, virtual]

Definition at line 91 of file export_index_node.hpp.


Member Function Documentation

virtual ExportIndexNode* ExportIndexNode::clone ( ) const [inline, virtual]

Make a deep copy of the instance.

Implements ExportDataInternal.

Definition at line 94 of file export_index_node.hpp.

returnValue ExportIndexNode::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]fileName of file to be used to export function.
[in]_realStringstd::string to be used to declare real variables.
[in]_intStringstd::string to be used to declare integer variables.
[in]_precisionNumber of digits to be used for exporting real values.
Returns:
SUCCESSFUL_RETURN

Implements ExportDataInternal.

Definition at line 33 of file export_index_node.cpp.

const std::string ExportIndexNode::get ( ) const

Returns a string containing the value of the index.

Definition at line 50 of file export_index_node.cpp.

const int ExportIndexNode::getFactor ( ) const [inline]

Definition at line 139 of file export_index_node.hpp.

const int ExportIndexNode::getGivenValue ( ) const

Returns the given value of the index (if defined).

Returns:
Given value of the index or 0 in case the index is undefined.

Definition at line 105 of file export_index_node.cpp.

const int ExportIndexNode::getOffset ( ) const [inline]

Definition at line 144 of file export_index_node.hpp.

bool ExportIndexNode::isBinary ( ) const [inline]

Definition at line 123 of file export_index_node.hpp.

bool ExportIndexNode::isGiven ( ) const [virtual]

Returns whether the index is set to a given value.

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

Implements ExportDataInternal.

Definition at line 136 of file export_index_node.cpp.

bool ExportIndexNode::isVariable ( ) const [inline]

Definition at line 131 of file export_index_node.hpp.


Member Data Documentation

int ExportIndexNode::factor [private]

Definition at line 152 of file export_index_node.hpp.

Definition at line 156 of file export_index_node.hpp.

int ExportIndexNode::offset [private]

Definition at line 153 of file export_index_node.hpp.

int ExportIndexNode::op [private]

Definition at line 155 of file export_index_node.hpp.

Definition at line 157 of file export_index_node.hpp.

int ExportIndexNode::value [private]

Definition at line 151 of file export_index_node.hpp.

Definition at line 150 of file export_index_node.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:24