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

        Prop1;
        double Prop2;
        DPCMObject SubClass;
        ::"data" SupervisedDataProperty = "somedata";
    public:

        DPCMCandidate = true;
    public:

        notObserved = "somevalue";
    public:

        DPCMDemoClass() {
            this = this@DPCMObject;

            /*  Assign any class instances as default values.       */
            this.SubClass= DPCMObject;

            /*  Register properties that are to be supervised */
            this.registerProps(" Prop1 "," Prop2 "," SubClass ");

            /*  If you change any property after registering them, the whole point of the system
             * fails because at this stage the DPCM is already active. 
             * As a consequence, Prop2 will always be seen as already changed. */
            this.Prop2= " changed after registering .. ";
        }
        function  demo() {
            this.doSomeComputation;

            /*  Change some variables */
            disp(" <<<<<<<<<<<<<<<<<<<<<<<< DPCMDemo: Changing some variables... >>>>>>>>>>>>>>>>>>>>>>> ");
            this.Prop1= 45;
            this.SubClass.WorkspaceVariableName= " some value for a property ";

            this.doSomeComputation;
        }
        function  doSomeComputation() {
            
            /* % Perform the DPCM check before computations
             * Critical properties only (recommended): */
            DPCM.criticalsCheck(this);

            /* % More details
             * Optional: Print a summary */
            disp(" <<<<<<<<<<<<<<<<<<<<<<<< DPCMDemo: summary >>>>>>>>>>>>>>>>>>>>>>> ");
            pause;
            DPCM.getDPCMSummary(this);

            /*  Optional: Detailed report */
            disp(" <<<<<<<<<<<<<<<<<<<<<<<< DPCMDemo: report >>>>>>>>>>>>>>>>>>>>>>> ");
            pause;
            DPCM.getDPCMReport(this);


            /* % Put your computation/method calls here
             * [...] */
        }


        
#if 0 //mtoc++: 'set.Prop1'
function  Prop1(value) {

            this.Prop1= value;
        }

#endif

};