---

rdIntegCallbackSet Class Reference

A class for holding and managing a set of integration callbacks for a model. More...

#include <rdIntegCallbackSet.h>

Inheritance diagram for rdIntegCallbackSet:

List of all members.

Public Member Functions
	rdIntegCallbackSet (rdModel *aModel)
	Construct an empty callback set for a model.
virtual	~rdIntegCallbackSet ()
	Destructor.
rdIntegCallback *	getIntegCallback (int aIndex) const
	Get the callback at an index.
virtual void	begin (int aStep, double aDT, double aT, double *aX, double *aY, void *aClientData=NULL)
	Call the begin method for all integration callbacks.
virtual void	step (double *aXPrev, double *aYPrev, int aStep, double aDT, double aT, double *aX, double *aY, void *aClientData=NULL)
	Call the step method for all integration callbacks.
virtual void	end (int aStep, double aDT, double aT, double *aX, double *aY, void *aClientData=NULL)
	Call the end method for all integration callbacks.
Private Member Functions
void	setNull ()
	Set the data members of this actuator to their null values.

---

Detailed Description

A class for holding and managing a set of integration callbacks for a model.

Author:

Frank C. Anderson

Version:

1.0

---

Constructor & Destructor Documentation

rdIntegCallbackSet::~rdIntegCallbackSet (   )  [virtual]

Destructor. Note that the individual callbacks are not deleted by this destructor. To delete the callbacks, the caller must do so individually, or the method rdCallback::deleteCallbacks() may be called.

---

Member Function Documentation

void rdIntegCallbackSet::begin (  int  aStep, double  aDT, double  aT, double *  aX, double *  aY, void *  aClientData = NULL )  [virtual]

Call the begin method for all integration callbacks. This method is called at the beginning of an integration and is intended to be used for any initializations that are necessary. Parameters: aStep  Number of integrations steps that have been completed. aDT  Size of the integration time step that will be attempted. aT  Current time in the integration. aX  Current control values. aY  Current states. aClientData  General use pointer for sending in client data.

void rdIntegCallbackSet::end (  int  aStep, double  aDT, double  aT, double *  aX, double *  aY, void *  aClientData = NULL )  [virtual]

Call the end method for all integration callbacks. This method is called after an integration has been completed and is intended to be used for performing any finalizations necessary. Parameters: aStep  Number of integrations steps that have been completed. aDT  Size of the time step that WAS just completed. aT  Current time in the integration. aX  Current control values. aY  Current states. aClientData  General use pointer for sending in client data.

rdIntegCallback * rdIntegCallbackSet::getIntegCallback (  int  aIndex  )  const

Get the callback at an index. This method uses the method rdArray::get() and casts the returned void pointer as an rdIntegCallback. Parameters: aIndex  Array index of the callback to be returned. Returns: Callback at index aIndex.

void rdIntegCallbackSet::step (  double *  aXPrev, double *  aYPrev, int  aStep, double  aDT, double  aT, double *  aX, double *  aY, void *  aClientData = NULL )  [virtual]

Call the step method for all integration callbacks. This method is called after each successful integration time step and is intended to be used for conducting analyses, driving animations, etc. Parameters: aXPrev  Control values at the previous time step. aYPrev  State values at the previous time step. aStep  Number of integrations steps that have been completed. aDT  Size of the time step that WAS just completed. aT  Current time in the integration. aX  Current control values. aY  Current states. aClientData  General use pointer for sending in client data.

---

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

• rdIntegCallbackSet.h
• rdIntegCallbackSet.cpp

---