Diffpack Documentation

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

MatlabGraphics Class Reference

extension of class MatlabEngine for easy visualization. More...

#include <MatlabEngine.h>

Inheritance diagram for MatlabGraphics::

Public Types
enum	{ ON = 1, OFF = 2 }
Public Methods
	MatlabGraphics ()
void	plot (const Vec(real) &x, const Vec(real) &y)
void	plot (const Vec(real) &x, const Vec(real) &y, const String &s)
void	plot (const Mat(real) &A, const Mat(real) &B)
void	plot (const Mat(real) &A, const Mat(real) &B, const String &s)
void	mesh (const Mat(real) &A)
void	surf (const Mat(real) &A)
void	mesh (const ArrayGen(real) &A)
void	surf (const ArrayGen(real) &A)
void	title (const String &s)
void	xlabel (const String &s)
void	ylabel (const String &s)
void	hold (int c)
void	figure (int figNum)
void	gtext (const String &s)
void	print (const String &s)

Detailed Description

extension of class MatlabEngine for easy visualization.

NAME: MatlabGraphics - extension of class MatlabEngine for easy visualization

DESCRIPTION:

This is a subclass of the class "MatlabEngine" and provides extra graphics functionality. Several Matlab Graphics commands are implemented as member functions and make some tasks easier. For example, the user can set the figure by calling "MatlabGraphics figure(int fignum)" rather than having to create a string with the figure number and then pass the string to the matlab engine.

Member Enumeration Documentation

anonymous enum

Enumeration values:

ON

OFF

Constructor & Destructor Documentation

MatlabGraphics::MatlabGraphics ( ) [inline]

Member Function Documentation

void MatlabGraphics::figure ( int figNum ) [inline]

See the MATLAB Reference Guide for a discription of these graphics functions.

void MatlabGraphics::gtext ( const String & s ) [inline]

See the MATLAB Reference Guide for a discription of these graphics functions.

void MatlabGraphics::hold ( int c ) [inline]

Same as the MATLAB "hold on" or "hold off" commands used to see the results of several plot commands on the same graph. The argument 'c' should be set to "MatlabGraphics ON" or "MatlabGraphics OFF".

void MatlabGraphics::mesh ( const ArrayGen(real) & A ) [inline]

See documentation of one of the overloaded functions.

void MatlabGraphics::mesh ( const Mat(real) & A ) [inline]

Plots a Diffpack "Mat" or "ArrayGen" object using the MATLAB function ""mesh"".

void MatlabGraphics::plot ( const Mat(real) & A,

const Mat(real) & B,

const String & s ) [inline]

See documentation of one of the overloaded functions.

void MatlabGraphics::plot ( const Mat(real) & A,

const Mat(real) & B ) [inline]

See documentation of one of the overloaded functions.

void MatlabGraphics::plot ( const Vec(real) & x,

const Vec(real) & y,

const String & s ) [inline]

See documentation of one of the overloaded functions.

void MatlabGraphics::plot ( const Vec(real) & x,

const Vec(real) & y ) [inline]

These routines plot data contained in Diffpack vector and matrix objects. The supplied string in some of the overloaded version of this function provides line type and color information. See MATLAB user documentation for the format in which data should be provided and the line type information. Note that these routines will create a name for the vector 'x' or the matrix 'A'. These names are not publicly available, nor will they be

void MatlabGraphics::print ( const String & s ) [inline]

See the MATLAB Reference Guide for a discription of these graphics functions.

void MatlabGraphics::surf ( const ArrayGen(real) & A ) [inline]

See documentation of one of the overloaded functions.

void MatlabGraphics::surf ( const Mat(real) & A ) [inline]

Plots a Diffpack "Mat" or "ArrayGen" object using the MATLAB function ""surf"".

void MatlabGraphics::title ( const String & s ) [inline]

See the MATLAB Reference Guide for a discription of these graphics functions.

void MatlabGraphics::xlabel ( const String & s ) [inline]

See the MATLAB Reference Guide for a discription of these graphics functions.

void MatlabGraphics::ylabel ( const String & s ) [inline]

See the MATLAB Reference Guide for a discription of these graphics functions.

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

MatlabEngine.h