Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

TxNldIfc Class Reference

Pure virtual interface to define the interaction with a non- linear dynamical scientific and engineering model needed by Tech-X QScimpl graphics package. More...

#include <TxNldIfc.h>

Inheritance diagram for TxNldIfc::

TxModelIfc TxAccelIfc List of all members.

Public Methods

virtual TXSTD::string getFileExt () const=0
 Get file extension string. More...

virtual TXSTD::string getInputFileName ()=0
 Obtain the input file name. More...

virtual int write (ostream &ostrm) const=0
 write object data. More...

virtual int read (istream &fl) const=0
 Read the input file (possibly subject to format determined by file extension). More...

virtual int getDimension () const=0
 Get phase space dimension. More...

virtual const char* getLabel (int i)=0
 Get the label of the i'th dependent variable of the map. More...

virtual double getCompMin (int i) const=0
 Get the computational minimum specified for the i'th dependent variable of the map. More...

virtual double getCompMax (int i) const=0
 Get the computational maximum specified for the i'th dependent variable of the map. More...

virtual double getPlotMin (int i) const=0
 Get the plotting minimum specified for the i'th dependent variable of the map. More...

virtual double getPlotMax (int i) const=0
 Get the plotting maximum specified for the i'th dependent variable of the map. More...

virtual int advance (double *p, int dim=0)=0
 advance the dependent variables through the map. More...

virtual vector<TxAttributeSet*> getViewMenuAttribs ()=0
 Obtain the view menu attributes from the model. More...

virtual vector<TxAttributeSet*> getViewMenuDataAttribs ()=0
 Obtain the view menu data attributes from the model. More...

virtual vector<TxAttributeSet*> getEditMenuAttribs ()=0
 Obtain the edit menu attributes from the model. More...

virtual vector<TxAttributeSet*> getParamsMenuAttribs ()=0
 Obtain the params menu attributes from the model. More...

virtual void updateModelAttribute (TxAttributeSet *attrib)=0
 Update the attribute set from the model data set. More...

virtual void updateViewAttribs (TxAttributeSet *window, TxAttributeSet *data)=0
 Update the attribute set of view from the model data set. More...

Detailed Description

Pure virtual interface to define the interaction with a non- linear dynamical scientific and engineering model needed by Tech-X QScimpl graphics package.

This interface should not depend on QT.

Author:
Kelly G. Luetkemeyer, David L. Bruhwiler, David A. Alexander
Version:
Id:
TxNldIfc.h,v 1.5 2001/12/07 00:14:47 kgl Exp

Definition at line 38 of file TxNldIfc.h.

Member Function Documentation

int TxNldIfc::advance ( double * p,
int dim = 0 ) [pure virtual]
 

advance the dependent variables through the map.

Parameters:
p   input with initial variables; output with final variables.
dim   calculate for map of this dimension.

Returns:
error (0 if no error).

double TxNldIfc::getCompMax ( int i ) const [pure virtual]
 

Get the computational maximum specified for the i'th dependent variable of the map.

Returns:
maximum

double TxNldIfc::getCompMin ( int i ) const [pure virtual]
 

Get the computational minimum specified for the i'th dependent variable of the map.

Returns:
minimum

int TxNldIfc::getDimension ( ) const [pure virtual]
 

Get phase space dimension.

Returns:
number of dimensions

vector< TxAttributeSet *> TxNldIfc::getEditMenuAttribs ( ) [pure virtual]
 

Obtain the edit menu attributes from the model.

Reimplemented from TxModelIfc.

TXSTD::string TxNldIfc::getFileExt ( ) const [pure virtual]
 

Get file extension string.

Returns:
the file extension

Reimplemented from TxModelIfc.

TXSTD::string TxNldIfc::getInputFileName ( ) [pure virtual]
 

Obtain the input file name.

Returns:
the string name for the input filename

const char * TxNldIfc::getLabel ( int i ) [pure virtual]
 

Get the label of the i'th dependent variable of the map.

Returns:
label as a string

vector< TxAttributeSet *> TxNldIfc::getParamsMenuAttribs ( ) [pure virtual]
 

Obtain the params menu attributes from the model.

Reimplemented from TxModelIfc.

double TxNldIfc::getPlotMax ( int i ) const [pure virtual]
 

Get the plotting maximum specified for the i'th dependent variable of the map.

Returns:
maximum

double TxNldIfc::getPlotMin ( int i ) const [pure virtual]
 

Get the plotting minimum specified for the i'th dependent variable of the map.

Returns:
minimum

vector< TxAttributeSet *> TxNldIfc::getViewMenuAttribs ( ) [pure virtual]
 

Obtain the view menu attributes from the model.

Reimplemented from TxModelIfc.

vector< TxAttributeSet *> TxNldIfc::getViewMenuDataAttribs ( ) [pure virtual]
 

Obtain the view menu data attributes from the model.

Reimplemented from TxModelIfc.

int TxNldIfc::read ( istream & fl ) const [pure virtual]
 

Read the input file (possibly subject to format determined by file extension).

Parameters:
fl   the input stream

Returns:
failure/success as integer, with 0 being the success

Reimplemented from TxModelIfc.

void TxNldIfc::updateModelAttribute ( TxAttributeSet * attrib ) [pure virtual]
 

Update the attribute set from the model data set.

void TxNldIfc::updateViewAttribs ( TxAttributeSet * window,
TxAttributeSet * data ) [pure virtual]
 

Update the attribute set of view from the model data set.

int TxNldIfc::write ( ostream & ostrm ) const [pure virtual]
 

write object data.

Parameters:
ostrm   the output stream to write to

Returns:
error condition - 0 for no error

Reimplemented from TxModelIfc.

The documentation for this class was generated from the following file: Copyright Tech-X Corporation, all rights reserved.