KerMor  0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DPCMDemoClass Class Reference

DPCMDemoClass: Demo class for the DPCM System. More...

Detailed Description

DPCMDemoClass: Demo class for the DPCM System.

Note
The DPCM methods work on nested properties, too.
Author
Daniel Wirtz
Date
2011-11-21
New in 0.6:
(Daniel Wirtz, 2011-11-21) Added this class.

Copyright (c) 2011, Daniel Wirtz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted only in compliance with the BSD license, see http://www.opensource.org/licenses/bsd-license.php

Note
The DPCM methods work on nested properties, too.
Author
Daniel Wirtz
Date
2011-11-21
New in 0.6:
(Daniel Wirtz, 2011-11-21) Added this class.

Copyright (c) 2011, Daniel Wirtz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted only in compliance with the BSD license, see http://www.opensource.org/licenses/bsd-license.php

Definition at line 17 of file DPCMDemoClass.m.

Public Member Functions

 DPCMDemoClass ()
 Call superclass constructor. More...
 
function  demo ()
 Perform some fake computations. More...
 
function  doSomeComputation ()
 
 DPCMDemoClass ()
 
function  demo ()
 
function  doSomeComputation ()
 
- Public Member Functions inherited from DPCMObject
 DPCMObject ()
 Creates a new DPCM object. More...
 
 DPCMObject ()
 

Public Attributes

 Prop1
 Brief description of property one. More...
 
double Prop2
 Brief for property two. More...
 
DPCMObject SubClass
 This is a subclass. More...
 
data SupervisedDataProperty = "somedata"
 This is a property. More...
 
 DPCMCandidate = true
 This is a property that intentionally has been "forgotten" to be added to the DPCM system. Note how the system detects this and suggests inclusion. More...
 
 notObserved = "somevalue"
 Methods with private set access are not considered for DPCM. Candidates are with set access protected and public. More...
 
- Public Attributes inherited from DPCMObject
 WorkspaceVariableName = ""
 The workspace variable name of this class. Optional. More...
 
 ID = "[]"
 An ID that allows to uniquely identify this DPCMObject (at least within the current MatLab session/context). More...
 
 PropertiesChanged = "[]"
 The Dictionary containing all the property settings as key/value pairs. More...
 
- Public Attributes inherited from handle
 addlistener
 Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...
 
 notify
 Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...
 
 delete
 Handle object destructor method that is called when the object's lifecycle ends. More...
 
 disp
 Handle object disp method which is called by the display method. See the MATLAB disp function. More...
 
 display
 Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...
 
 findobj
 Finds objects matching the specified conditions from the input array of handle objects. More...
 
 findprop
 Returns a meta.property objects associated with the specified property name. More...
 
 fields
 Returns a cell array of string containing the names of public properties. More...
 
 fieldnames
 Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...
 
 isvalid
 Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...
 
 eq
 Relational functions example. See details for more information. More...
 
 transpose
 Transposes the elements of the handle object array. More...
 
 permute
 Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...
 
 reshape
 hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...
 
 sort
 ort the handle objects in any array in ascending or descending order. More...
 

Additional Inherited Members

- Protected Member Functions inherited from DPCMObject
function  registerProps (varargin)
 Call this method at any class that defines DPCM observed properties. More...
 
function  registerProps (varargin)
 
- Static Protected Member Functions inherited from DPCMObject
static function obj = loadobj (obj, from)
 Re-register any registered change listeners! More...
 
static function obj = loadobj (obj, from)
 

Constructor & Destructor Documentation

DPCMDemoClass.DPCMDemoClass ( )

Call superclass constructor.

Definition at line 128 of file DPCMDemoClass.m.

References DPCMObject.DPCMObject(), Prop2, DPCMObject.registerProps(), and SubClass.

Here is the call graph for this function:

DPCMDemoClass.DPCMDemoClass ( )

Definition at line 128 of file DPCMDemoClass.m.

References DPCMObject.DPCMObject(), Prop2, DPCMObject.registerProps(), and SubClass.

Here is the call graph for this function:

Member Function Documentation

function DPCMDemoClass.demo ( )

Perform some fake computations.

Definition at line 148 of file DPCMDemoClass.m.

References handle.disp, doSomeComputation(), Prop1, SubClass, and DPCMObject.WorkspaceVariableName.

Here is the call graph for this function:

function DPCMDemoClass.demo ( )

Definition at line 148 of file DPCMDemoClass.m.

References handle.disp, doSomeComputation(), Prop1, SubClass, and DPCMObject.WorkspaceVariableName.

Here is the call graph for this function:

function DPCMDemoClass.doSomeComputation ( )

Definition at line 164 of file DPCMDemoClass.m.

References DPCM.criticalsCheck(), handle.disp, DPCM.getDPCMReport(), and DPCM.getDPCMSummary().

Here is the call graph for this function:

function DPCMDemoClass.doSomeComputation ( )

Definition at line 164 of file DPCMDemoClass.m.

References DPCM.criticalsCheck(), handle.disp, DPCM.getDPCMReport(), and DPCM.getDPCMSummary().

Referenced by demo().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

DPCMDemoClass.DPCMCandidate = true

This is a property that intentionally has been "forgotten" to be added to the DPCM system. Note how the system detects this and suggests inclusion.


Default: true

Definition at line 101 of file DPCMDemoClass.m.

DPCMDemoClass.notObserved = "somevalue"

Methods with private set access are not considered for DPCM. Candidates are with set access protected and public.

Note
This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public
Matlab documentation of property attributes.
Default: "somevalue"

Definition at line 113 of file DPCMDemoClass.m.

DPCMDemoClass.Prop1

Brief description of property one.

Setters for DPCM properties are compatibel.

Property class critical:
This is a very critical property!
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
This property has custom functionality when its value is changed.
Property class critical:
This is a very critical property!
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.

Definition at line 40 of file DPCMDemoClass.m.

Referenced by demo().

DPCMDemoClass.Prop2

Brief for property two.

Property class important:
Another property, but "only" important. This comment is extracted to the end of the comment section or until the next tag.
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
Property class important:
Another property, but "only" important. This comment is extracted to the end of the comment section or until the next tag.
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.

Definition at line 53 of file DPCMDemoClass.m.

Referenced by DPCMDemoClass().

DPCMDemoClass.SubClass

This is a subclass.

Property class important:
This description is about the importance of the SubClass property.
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
Property class important:
This description is about the importance of the SubClass property.
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.

Definition at line 68 of file DPCMDemoClass.m.

Referenced by demo(), and DPCMDemoClass().

DPCMDemoClass.SupervisedDataProperty = "somedata"

This is a property.

The specialty for this

Property class data:
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
Default: "somedata"

The specialty for this

Property class data:
Note
This property has the MATLAB attribute SetObservable set to true.
Matlab documentation of property attributes.
Default: "somedata"

Definition at line 84 of file DPCMDemoClass.m.


The documentation for this class was generated from the following file: