---

rdCallback Class Reference

An abstract class for specifying a callback. More...

#include <rdCallback.h>

Inheritance diagram for rdCallback:

List of all members.

Public Member Functions
	rdCallback (rdModel *aModel)
	Default constructor.
virtual	~rdCallback ()
	Destructor.
void	setOn (bool aTrueFalse)
	Turn this callback on or off.
bool	getOn () const
	Get whether or not this analysis is on.
void	setStartTime (double aStartTime)
	Set the time at which to begin executing the callback.
double	getStartTime () const
	Get the time at which to begin executing the callback, expressed in real time time units, not normalized time units.
void	setEndTime (double aEndTime)
	Set the time at which to end executing the callback.
double	getEndTime () const
	Get the time at which to end executing the callback, expressed in real time time units, not normalized time units.
rdModel *	getModel () const
	Get a pointer to the model for which this callback has been set.
void	removeModel ()
	Remove the model (i.e., set the model pointer to NULL).
Protected Attributes
rdModel *	_model
	Model.
bool	_on
	On, off flag.
double	_startTime
	Start time for the callback in normalized time.
double	_endTime
	End time for the callback in normalized time.
Private Member Functions
void	setNull ()
	Set NULL values for member variables.

---

Detailed Description

An abstract class for specifying a callback.

Callbacks provide low-level access to aspects of an integration.

Author:

Frank C. Anderson

Version:

1.0

---

Constructor & Destructor Documentation

rdCallback::rdCallback (  rdModel *  aModel  )

Default constructor. Parameters: aModel  Model to which the callback mthods apply.

---

Member Function Documentation

double rdCallback::getEndTime (   )  const

Get the time at which to end executing the callback, expressed in real time time units, not normalized time units. Returns: End time expressed in real time units.

rdModel * rdCallback::getModel (   )  const

Get a pointer to the model for which this callback has been set. Returns: Pointer to the model.

bool rdCallback::getOn (   )  const

Get whether or not this analysis is on. Returns: True if on, false if off.

double rdCallback::getStartTime (   )  const

Get the time at which to begin executing the callback, expressed in real time time units, not normalized time units. Returns: Start time expressed in real time units.

void rdCallback::removeModel (   )

Remove the model (i.e., set the model pointer to NULL). This method should be called, for example, when the model is no longer valid (e.g., deleted). This method does not delete or alter the model, it just removes the model from this callback instance, which disables this callback. Once the model has been removed, there is no way to re-enable this callback; a new rdCallback with a new valid model must be constructed. Returns: Pointer to the model.

void rdCallback::setEndTime (  double  aEndTime  )

Set the time at which to end executing the callback. Note that the end time should be specified in real time units, not in normalized time units. Parameters: aEndTime  Time at which the callback should end execution in real time units.

void rdCallback::setOn (  bool  aTrueFalse  )

Turn this callback on or off. Parameters: aTureFalse  Turns analysis on if "true" and off if "false".

void rdCallback::setStartTime (  double  aStartTime  )

Set the time at which to begin executing the callback. Note that the start time should be specified in real time units, not in normalized time units. Parameters: aStartTime  Start time expressed in real time units.

---

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

• rdCallback.h
• rdCallback.cpp

---