ModelParam.m

Go to the documentation of this file.

namespace data{


/* (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 ModelParam
  :public handle {
    public:

        char Name = "New Parameter";
        double Range;
        integer Desired = 1;
        char Spacing = "lin";
        double Default;
    public: /* ( Dependent ) */

        double MinVal;
        ::@double MaxVal;
        .boolean HasRange;
    public: /* ( Dependent ) */

        ModelParam(char name,double default,varargin) {

            this.Name= name;
            this.Default= default;

            
            i.addParamValue('Desired',1);
            i.addParamValue('Range',[default * .9 default*1.1]);
            i.addParamValue('Spacing','lin');
            i.parse(varargin[:])
            r = i.Results;            
            this.Desired= r.Desired;
            this.Range= r.Range;
            this.Spacing= r.Spacing;
        }
#if 0 //mtoc++: 'set.Name'
function  Name(value) {
            if ~ischar(value)
                error(" name should be a character field ");
            end
            this.Name= value;
        }

#endif


        
#if 0 //mtoc++: 'set.Range'
function  Range(range) {
            if isscalar(range)
                range = [range range];
            end
            if range(2) < range(1)
                error(" Invalid range: MinVal must be greater or equal to MaxVal. ");
            end
            this.Range= range;
        }

#endif

#if 0 //mtoc++: 'set.Desired'
function  Desired(value) {
            if value < 0 || ~isscalar(value)
                error(" Desired must be a positive integer greater than zero. ");
            end
            this.Desired= value;
        }

#endif


        
#if 0 //mtoc++: 'set.Default'
function  Default(value) {
            if isempty(value) || ~isscalar(value)
                error(" Default must be a scalar double ");
            end
            this.Default= value;
        }

#endif


        
#if 0 //mtoc++: 'set.Spacing'
function  Spacing(value) {
            if ~ischar(value) || ~any(strcmp(value,[" lin "," log "]))
                error(" Spacing can either be 'lin' or 'log'. ");
            end
            this.Spacing= value;
        }

#endif



        
#if 0 //mtoc++: 'get.MinVal'
function value = MinVal() {
            value = this.Range(1);
        }

#endif


        
#if 0 //mtoc++: 'get.MaxVal'
function value = MaxVal() {
            value = this.Range(2);
        }

#endif


        
#if 0 //mtoc++: 'get.HasRange'
function value = HasRange() {
            value = abs(this.MinVal - this.MaxVal) > 10*eps;
        }

#endif

    
};
}