Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   Related Pages  

rdController Class Reference

An abstract class for specifying the interface for controlling an rdModel. More...

#include <rdController.h>

Inheritance diagram for rdController:

rdDynamicFilter suTrackController List of all members.

Public Member Functions

 rdController (rdModel *aModel)
 Default constructor.

virtual ~rdController ()
 Destructor.

void setNull ()
 Set NULL values for all member variables.

rdModelgetModel ()
 Get a pointer to the model on which this analysis is being performed.

void setOn (bool aTrueFalse)
 Turn this analysis on or off.

bool getOn ()
 Get whether or not this analysis is on.

void setName (const char *aName)
 Set the name of this controller.

const char * getName ()
 Get the name of this controller.

void setDescription (const char *aDescrip)
 Set the description of this controller.

const char * getDescription ()
 Get the description of this controller.

virtual void computeControls (double &rDT, double aT, const double *aY, rdControlSet &rX)=0

Static Public Attributes

const int NAME_LENGTH = rdController_NAME_LENGTH
const int DESCRIP_LENGTH = rdController_DESCRIP_LENGTH

Protected Attributes

rdModel_model
 Model.

bool _on
 Flag to indicate on or off state.

char _name [rdController_NAME_LENGTH]
 Name.

char _descrip [rdController_DESCRIP_LENGTH]
 Description.


Detailed Description

An abstract class for specifying the interface for controlling an rdModel.

Author:
Frank C. Anderson
Version:
1.0


Constructor & Destructor Documentation

rdController::rdController rdModel aModel  ) 
 

Default constructor.

Parameters:
aModel Model that is to be controlled.


Member Function Documentation

const char * rdController::getDescription  ) 
 

Get the description of this controller.

Returns:
Description.

rdModel * rdController::getModel  ) 
 

Get a pointer to the model on which this analysis is being performed.

Returns:
Pointer to the model.

const char * rdController::getName  ) 
 

Get the name of this controller.

Returns:
Name.

bool rdController::getOn  ) 
 

Get whether or not this analysis is on.

Returns:
True if on, false if off.

void rdController::setDescription const char *  aDescrip  ) 
 

Set the description of this controller.

Parameters:
aDescrip Description.

void rdController::setName const char *  aName  ) 
 

Set the name of this controller.

Parameters:
aName Name.

void rdController::setOn bool  aTrueFalse  ) 
 

Turn this analysis on or off.

Parameters:
aTureFalse Turns analysis on if "true" and off if "false".


The documentation for this class was generated from the following files:
Generated on Wed Aug 20 02:17:10 2003 for Simulation Software by doxygen1.3