DPCMObject.m

Go to the documentation of this file.

/* (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 DPCMObject
  :public handle {
    public: /* ( setObservable ) */

        WorkspaceVariableName = "";
    public:

        ID = "[]";
        PropertiesChanged = "[]";
    public:

        DPCMObject() {

            /*  Check if this constructor has already been called; if yes, dont assign a new ID
             * as this might lead to errors in subclasses or with properties (see above) */
            if isempty(this.ID)
                this.PropertiesChanged= Dictionary;
                this.ID= DPCMObject.generateID;
            end
        }
    protected:

        function  registerProps(varargin) {

            if ~KerMor.App.UseDPCM
                return;
            end

            mc = metaclass(this);
            if isempty(varargin)
                for idx = 1:length(mc.Properties)
                end
            end

            /*  Iterate over all properties that are to be registered */
            for pidx = 1:length(varargin)
                if ~ischar(varargin[pidx])
                    error(" All input arguments must be strings. ");
                end
                found = false;
                for idx = 1:length(mc.Properties)
                    if strcmp(mc.Properties[idx].Name,varargin[pidx])
                        p = mc.Properties[idx];
                        found = true;
                        break;
                    end
                end
                /*  Validity checks */
                if ~found
                    error(" Property %s does not exists in class %s. ",varargin[pidx],mc.Name);
                elseif ~strcmp(p.GetAccess," public ")
                    error(" Property %s has GetAccess=%s,  "" public ""  is required for registering. ",p.Name,p.GetAccess);
                elseif p.Constant
                    error(" Property %s is marked Constant. ",p.Name,p.GetAccess);
                elseif p.Transient
                    error(" Transient property %s is not admissible. ",p.Name,p.GetAccess);
                elseif strcmp(p.SetAccess," private ")
                    error(" Property %s has SetAccess=private, at least  "" protected ""  is required for registering. ",p.Name,p.GetAccess);
                end

                key = [p.DefiningClass.Name " . " p.Name];
                hlp = strtrim(help(key)); /* key matches the help search path! see doc help */

                n = regexp(hlp, " @propclass{(?<level>\w*)}\s*(?<text>[^@]*) "," names ");
                /*  Check if property has @propclass tag set */
                if ~isempty(n)
                    /*  Check validity */
                    if ~any(strcmp(n.level,DPCM.PropClasses))
                        error(" Invalid property class: %s ",n.level);
                    end
                    /*  Add the listener */
                    if ~any(strcmp(n.level," data "))
                        if ~p.SetObservable
                            error(" Non-passive registered property %s must have the SetObservable flag. ",p.Name);
                        end
                        addlistener(this,p.Name," PostSet ",@(src,evd)this.PropPostSetCallback(src,evd));
                    end
                    /*  Only overwrite if not present -> save/load process! */
                    if ~this.PropertiesChanged.containsKey(key)
                        /*  Initialize Changed flag to false */
                        ps.Changed= false;

                        /*  Get current value and save as default */
                        ps.Default= this.(p.Name);
                        ps.Name= p.Name;

                        /*  Add misc help texts and classification */
                        ps.Short= DPCMObject.getHelpShort(hlp);
                        ps.Level= n.level;
                        ps.Text= strtrim(n.text);

                        this.PropertiesChanged(key) = ps;
                    end
                elseif ~isempty(hlp)
                    error(" When registering a property you must define the @propclass{<level>} tag in the properties help text. ");
                end
            end
        }
    private:

        function  PropPostSetCallback(unused1,evd) {
            p = evd.Source;
            key = [p.DefiningClass.Name " . " p.Name];
            ps = this.PropertiesChanged(key);
            if isempty(ps)
                warning(" DPCMObject:warning "," PostSet called on property %s but dict does not contain key ",key);
            else
                if ~ps.Changed
                    this.PropertiesChanged(key).Changed = true;
                    this.PropertiesChanged(key).DefaultConfirmed = isequal(ps.Default,evd.AffectedObject.(p.Name));
                    /*  Save some space! */
                    this.PropertiesChanged(key).Default = [];
                    this.PropertiesChanged(key).Text = [];
                end
            end
        }

    
    protected: /* ( Static ) */

        static function obj = loadobj(obj,from) {
            if nargin > 1
                obj.ID= from.ID;
                obj.WorkspaceVariableName= from.WorkspaceVariableName;
                if isfield(from," PropertiesChanged ") && ~isempty(from.PropertiesChanged)
                    obj.PropertiesChanged= from.PropertiesChanged;
                    keys = obj.PropertiesChanged.Keys;
                    for idx = 1:obj.PropertiesChanged.Count
                        ps = obj.PropertiesChanged(keys[idx]);
                        if ~ps.Changed && ~any(strcmp(ps.Level," data "))
                            if isprop(obj,ps.Name)
                                addlistener(obj,ps.Name," PostSet ",@(src,evd)obj.PropPostSetCallback(src,evd));
                            else
                                warning(" DPCMObject:load "," Property %s of DPCMObject #%s (class %s) does not exist anymore.\nRemoving it from ProperitesChanged dictionary. ",ps.Name,obj.ID,class(obj));
                                obj.PropertiesChanged.clear(keys[idx]);
                            end
                        end
                    end
                end
            elseif ~isa(obj," DPCMObject ")
                warning(" DPCM:loadobj "," Argument 'obj' not a DPCMObject instance but no argument to initialize from given! ");
            end
        }
    private: /* ( Static ) */

        static function id = generateID() {
            persistent cnt;
            if isempty(cnt)
                cnt = round((sum(clock)+cputime)*1000);
            end
            id = sprintf(" %d ",cnt);
            cnt = cnt+1;
        }
        static function charshort = getHelpShort(char txt) {
            pos = regexp(txt,sprintf(" \n[ ]*\n "));
            short = ;
            if ~isempty(pos)
                short = txt(1:pos(1)-1);
            else
                /*  Maybe only one line? */
                pos = strfind(txt,char(10));
                if ~isempty(pos)
                    short = txt(1:pos(1)-1);
                end
            end
            short = strtrim(short);
        }
};