IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase Class Reference

A template class for physical models. Each child should define its own plottable curves). More...

+ Inheritance diagram for IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase:

Public Member Functions

PlotZedgraphCurve NewCurveFromPlottableData (PlotterZedGraph plotter, int x, int y)
 Creates a new PlotZedgraphCurve object from the available plottable data. More...
 
void LoadPlottableDataToCurve (PlotZedgraphCurve curve, int x, int y)
 Copies the calculated data to the existing PlotZedgraphCurve object. Enough space must be available on the curve object's list. More...
 

Protected Attributes

string _title
 

Properties

string Title [get, set]
 The plottable model's name. Also used as a plot title. More...
 
List< double[]> PlottableData [get, set]
 The main solution array, which is used by the plotter. More...
 

Private Attributes

List< double[]> _plottableData
 

Detailed Description

A template class for physical models. Each child should define its own plottable curves).

Member Function Documentation

PlotZedgraphCurve IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase.NewCurveFromPlottableData ( PlotterZedGraph  plotter,
int  x,
int  y 
)
inline

Creates a new PlotZedgraphCurve object from the available plottable data.

Parameters
plotterThe PlotHQ's plotter to which the new curve should belong.
xWhich sublist (index) on the source list (plottable data) represents the x-axis data.
yWhich sublist (index) on the source list (plottable data) represents the y-axis data.
Returns
A PlotZedGraphCurve object filled with values.

References IG.Gr.PlotZedgraphCurve.AddPoint().

Referenced by IG.MPetekLib.Application.Scripts.LinearOscillator._14PhaseShiftPlot.Run(), IG.MPetekLib.Application.Scripts.NonlinearOscNondim._16SolutionPlot.Run(), IG.MPetekLib.Application.Scripts.NonlinearOscillator._15SolutionPlot.Run(), IG.MPetekLib.Application.Scripts.MagOscHardSpring._23SingleResCurveManyPhases.Run(), IG.MPetekLib.Application.Scripts.NonlinearOscillator._22SingleResCurveManyPhases.Run(), IG.MPetekLib.Application.Scripts.NonlinearOscillator._19SingleResonancePlot.Run(), IG.Script._18ChaoticPlot.Run(), IG.MPetekLib.Application.Scripts.NonlinearOscillator._21MultipleResCurvesPlot.Run(), IG.Script._25KickedRotator.Run(), IG.MPetekLib.Application.Scripts.LinearOscillator._08SteadyStateAmplitude.Run(), IG.MPetekLib.Application.Scripts.LinearOscillator._12MultipleResCurvesPlot.Run(), IG.MPetekLib.Application.Scripts.LinearOscillator._13SolutionAndDrivingFunctionPlot.Run(), IG.MPetekLib.Application.Scripts.LinearOscillator._09SingleResonanceCurvePlot.Run(), IG.MPetekLib.Application.Scripts.NonlinearOscNondim._20MultipleResCurvesPlot.Run(), IG.MPetekLib.Application.Scripts.MagOscHardSpring._24MultiResCurvesPlotPhaseScan.Run(), IG.MPetekLib.Application.Scripts.LinearOscillator._10MultipleResCurvesPlotObsolete.Run(), IG.Script.DemoResonanceCurvePlot.Run(), IG.Script.DemoResonanceCurvePlotExt.Run(), and IG.MPetekLib.Application.Scripts.CompPhys._01AnnealingCatenary.ShowPlot().

void IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase.LoadPlottableDataToCurve ( PlotZedgraphCurve  curve,
int  x,
int  y 
)
inline

Copies the calculated data to the existing PlotZedgraphCurve object. Enough space must be available on the curve object's list.

Parameters
curveThe PlotZedgraphCurve object that the data will be copied to.
xWhich sublist (index) on the source list (plottable data) represents the x-axis data.
yWhich sublist (index) on the source list (plottable data) represents the y-axis data.

References IG.Gr.PlotZedgraphCurve.AddPoint(), and IG.Gr.PlotZedgraphCurve.ClearPoints().

Referenced by IG.MPetekLib.Application.Scripts.CompPhys._01AnnealingCatenary.Run().

Member Data Documentation

string IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase._title
protected
List<double[]> IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase._plottableData
private

Property Documentation

string IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase.Title
getset

The plottable model's name. Also used as a plot title.

List<double[]> IG.MPetekLib.Algorithms.PlottableModels.PlottableModelBase.PlottableData
getset

The main solution array, which is used by the plotter.


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