AFunGen.m

Go to the documentation of this file.

namespace general{
namespace functions{


/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

class AFunGen
  :public handle {
    public:

        xLabel = "t "[ms]"";

        yLabel = "value";

        
    public:

        function pm = plot(varargin) {
            [f, df] = this.getFunction;
            args = [];
            if ~isempty(df)
                args = [false, 1, 2];
            end
            pm = PlotManager(args[:]);
            pm.UseFileTypeFolders= false;
            pm.LeaveOpen= true;

            
            i.CaseSensitive= true;
            i.KeepUnmatched= true;
            i.FunctionName= " general.functions.AFunGen#plot ";
            i.addParamValue('PM',pm,@(v)isa(v,'PlotManager'));
            i.addParamValue('R',0:.1:1000);
            i.addParamValue('P',{});
            i.addParamValue('AX',[],@(v)all(ishandle(v)));
            i.parse(varargin[:]);
            res = i.Results;
            pm = res.PM;
            if length(res.R) == 2
                range = linspace(res.R(1),res.R(2),2000);
            else
                range = res.R;
            end

            if ~isempty(res.AX)
                hold(res.AX(1)," on ");
                plot(res.AX(1),range,f(range),res.P[:]);
                hold(res.AX(2)," on ");
                plot(res.AX(2),range,f(range),res.P[:]);
            else
                mc = metaclass(this);
                ax = pm.nextPlot(mc.Name,...
                    sprintf(" Plot of %s\n%s ",mc.Name,this.getConfigStr),...
                    this.xLabel,this.yLabel);
                plot(ax,range,f(range),res.P[:]);
                if ~isempty(df)
                    ax = pm.nextPlot([mc.Name " _deriv "],...
                        sprintf(" Plot of %s-derivative\n%s ",mc.Name,this.getConfigStr),...
                    this.xLabel,[this.yLabel " / " this.xLabel]);
                    plot(ax,range,df(range),res.P[:]);
                end
            end
            if nargout > 0
                pm.done;
            end
        }


        function  plottofigure(fignr,range,varargin) {
            if nargin < 3
                range = 0:.1:1000;
                if nargin < 2
                    fignr = gcf;
                end
            elseif length(range) == 2
                range = linspace(range(1),range(2),2000);
            end
            ax = get(fignr," Children ");
            if numel(ax) < 2
                error(" Need two axes handles. ");
            end
            this.plot(range, " AX ", ax, varargin[:]);
        }


        function sum = plus(other) {
            if ~isa(this," general.functions.AFunGen ") || ~isa(other," general.functions.AFunGen ")
                error(" Addition not defined for non-AFunGen classes. ");
            end
            sum = general.functions.FuncSum(this, other);
        }
    public: /* ( Abstract ) */

        virtual function [fhandle , dfhandle ] = getFunction() = 0;


        virtual function str = getConfigStr() = 0;

    

};
}
}