FileData.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 FileData
  :public handle {
    public:

        char Host = "";
    public: /* ( Dependent ) */

        char DataDirectory = "";
    protected:

        logical isSaved = false;
    private:

        fDataDir;

        
    public:

        FileData(data_dir) {
            if nargin == 1
                this.DataDirectory= data_dir;
            end
            this.Host= KerMor.getHost;
        }


        function  relocate(char new_root) {
            this.DataDirectory= new_root;
            this.Host= KerMor.getHost;
        }
        function  delete() {
            if ~isempty(this.fDataDir) && ~this.isSaved && exist(this.fDataDir," dir ") == 7
                if length(dir(this.fDataDir)) ~= 2
                    warning(" KerMor:FileData ",...
                        " A FileData instance (%s) should be deleted but the DataDirectory '%s' is not empty. Not deleting. ",...
                        class(this),this.fDataDir);
                else
                    rmdir(this.fDataDir);
                end
            end
        }



        
#if 0 //mtoc++: 'set.DataDirectory'
function  DataDirectory(value) {
            if ~isempty(value)
                if Utils.ensureDir(value);
                    this.fDataDir= value;
                    return;
                else
                    warning(" KerMor:FileData "," Could not make sure that the directory '%s' exists.\nPlease ensure a correct path and try again. ",value);
                end    
            end
            this.fDataDir= ;    
        }

#endif


        
#if 0 //mtoc++: 'get.DataDirectory'
function dir = DataDirectory() {
            dir = this.fDataDir;
        }

#endif

    
    protected:

        function file = getfile(file) {
            file = fullfile(this.fDataDir,file);
            if exist(file," file ") ~= 2
                if strcmp(this.Host,KerMor.getHost)
                    error(" File '%s' not found in folder '%s'. Have you deleted data files? ",...
                        file,this.fDataDir);
                else
                    error([" File '%s' not found. This FileData instance was created on host '%s' "...
                        " and the DataDirectory cannot be found on the local machine '%s'.\n "...
                        " Copy the files to an accessible directory and use the 'relocate' method. "],...
                        file,this.Host,KerMor.getHost);
                end
            end
        }


        function this = saveobj() {
            this.isSaved= true;
        }
    protected: /* ( Static ) */

        static function this = loadobj(this,initfrom) {

            created = false;
            if ~isa(this, " data.FileData ")
                initfrom = this;
                if isfield(initfrom," fDataDir ")
                    this = data.FileData(initfrom.fDataDir);
                else
                    this = data.FileData(initfrom.DataDirectory);
                end
                created = true;
            end
            if nargin == 2
                if ~created
                    if isfield(initfrom," fDataDir ")
                        this.fDataDir= initfrom.fDataDir;
                    else
                        this.fDataDir= initfrom.DataDirectory;
                    end
                end
                this.Host= initfrom.Host;
                this.isSaved= initfrom.isSaved;
            end
            if ~isempty(this.fDataDir) && exist(this.fDataDir," file ") == 0 
                str = " Directory '%s' not found. Loading files will not work until fixed.\n ";
                if ~strcmp(this.Host,KerMor.getHost)
                    str = sprintf([" %sNote that this FileData has been created on machine %s.  "...
                        " If you changed the computer (local: %s), use the 'relocate' method.\n "],str,this.Host,KerMor.getHost);
                end
                fprintf(2,str,this.fDataDir);
            end
        }
};
}