YANE-Framework 1.1.0
Public Member Functions

yane::MPC::ModelShootingData Class Reference

Class for utilizing shooting nodes within a class yane::MPC::MPC object.

List of all members.

Public Member Functions

virtual void applyShootingData (int horizont, double *t, double *x, double *sdatavalues)=0
 Function to define the shooting node values.
virtual int maxShootingDataLength (int maxhorizont)=0
 Function to return the maximal number of shooting nodes for the maximal horizon.
 ModelShootingData ()
 Constructor.
virtual void shootingDataInfo (int horizont, T_SHOOTINGDATA *sdata)=0
 Function to define the shooting data values.
virtual int shootingDataLength (int horizont)=0
 Function to return the number of shooting nodes for a given horizon.
virtual ~ModelShootingData ()

Constructor & Destructor Documentation

LIB_EXPORT yane::MPC::ModelShootingData::~ModelShootingData ( ) [virtual]

Destructor


Member Function Documentation

virtual void yane::MPC::ModelShootingData::applyShootingData ( int  horizont,
double *  t,
double *  x,
double *  sdatavalues 
) [pure virtual]

Function to define the shooting node values. This function is called before each start of the optimization within the class yane::MPC::MPC object and allows to reset shooting values.

Parameters:
horizontLength of the horizon
tTime grid
xState vector
sdatavaluesArray of shooting data values
virtual int yane::MPC::ModelShootingData::maxShootingDataLength ( int  maxhorizont) [pure virtual]

Function to return the maximal number of shooting nodes for the maximal horizon. This function is used by the class yane::MPC::MPC object to allocate its internal memory for storing the shooting data values.

Parameters:
maxhorizontMaximal horizon length
Returns:
Number of shooting nodes
virtual void yane::MPC::ModelShootingData::shootingDataInfo ( int  horizont,
T_SHOOTINGDATA sdata 
) [pure virtual]

Function to define the shooting nodes

Parameters:
sdataArray of shooting nodes where data can be stored
horizontLength of the horizon
virtual int yane::MPC::ModelShootingData::shootingDataLength ( int  horizont) [pure virtual]

Function to return the number of shooting nodes for a given horizon

Parameters:
horizontLength of the horizon
Returns:
Number of shooting nodes