DPCMObject: Base object for any class participating in the DPCM system. More...

Detailed Description

DPCMObject: Base object for any class participating in the DPCM system.

Inherit any class from this superclass and use the DPCMObject.registerProps method in your object constructor after assigning any default values. Make sure to explicitly call the superclass constructor from your subclass constructor (see demo class)

Author: Daniel Wirtz

Date: 2011-11-18

Attention: Subclasses that explicitly implement the static loadobj-method for custom class loading MUST call the loadobj method of DPCMObject in order for the DPCM system to continue working after a save/load process.

See Also: loadobj

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 DPCMObject.m.

Public Member Functions
	DPCMObject ()
	Creates a new DPCM object. More...

	DPCMObject ()

Public Attributes
	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...

Protected Member Functions
function	registerProps (varargin)
	Call this method at any class that defines DPCM observed properties. More...

function	registerProps (varargin)

Static Protected Member Functions
static function obj =	loadobj (obj, from)
	Re-register any registered change listeners! More...

static function obj =	loadobj (obj, from)

Constructor & Destructor Documentation

DPCMObject.DPCMObject ( )

Creates a new DPCM object.

Attention: Due to possible multiple inheritance any object's constructor should check if any custom properties that are assigned during construction are already present / different from the default value given at property declaration. If so, chances are that the constructor is called again for the same object; in this case, assigning a new ID and property changed dictionary caused any old registered properties to be overwritten!

Definition at line 101 of file DPCMObject.m.

References ID, and PropertiesChanged.

Referenced by DPCMDemoClass.DPCMDemoClass(), KerMorObject.KerMorObject(), dscomponents.ParamTimeKernelCoreFun.loadobj(), and models.BaseModel.loadobj().

Here is the caller graph for this function:

DPCMObject.DPCMObject ( )

Definition at line 101 of file DPCMObject.m.

References ID, and PropertiesChanged.

Member Function Documentation

function obj = DPCMObject.loadobj	(	obj,
		from
	)

staticprotected

Re-register any registered change listeners!

Change in 0.6:: (Daniel Wirtz, 2012-01-17) Checking if any properties registered in the PropertiesChanged dictionary are not present anymore (due to updates etc) and removing them from the dictionary if that is the case.

Required fields of from:

Required fields of obj:

Generated fields of obj:

Change in 0.6:: (Daniel Wirtz, 2012-01-17) Checking if any properties registered in the PropertiesChanged dictionary are not present anymore (due to updates etc) and removing them from the dictionary if that is the case.

Required fields of from:

Required fields of obj:

Generated fields of obj:

Definition at line 232 of file DPCMObject.m.

References handle.addlistener.

static function obj = DPCMObject.loadobj	(	obj,
		from
	)

staticprotected

Definition at line 232 of file DPCMObject.m.

References handle.addlistener.

function DPCMObject.registerProps ( varargin )

protected

Definition at line 125 of file DPCMObject.m.

References handle.addlistener, KerMor.App(), DPCM.PropClasses, and PropertiesChanged.

Here is the call graph for this function:

function DPCMObject.registerProps ( varargin )

protected

Call this method at any class that defines DPCM observed properties.

Parameters

varargin A list of char arrays, denoting the names of the properties to register.

Definition at line 125 of file DPCMObject.m.

References handle.addlistener, KerMor.App(), DPCM.PropClasses, and PropertiesChanged.

Referenced by approx.algorithms.AAdaptiveBase.AAdaptiveBase(), approx.algorithms.ABase.ABase(), dscomponents.ACoreFun.ACoreFun(), models.synth.AffParamKernelTest.AffParamKernelTest(), solvers.AJacobianSolver.AJacobianSolver(), dscomponents.AOutputConv.AOutputConv(), models.BaseFirstOrderSystem.BaseFirstOrderSystem(), models.BaseFullModel.BaseFullModel(), kernels.BaseKernel.BaseKernel(), models.BaseModel.BaseModel(), models.pcdi.BasePCDISystem.BasePCDISystem(), models.pcd.BasePCDSystem.BasePCDSystem(), general.regression.BaseQPSVR.BaseQPSVR(), general.regression.BaseScalarSVR.BaseScalarSVR(), models.BaseSecondOrderSystem.BaseSecondOrderSystem(), solvers.BaseSolver.BaseSolver(), kernels.BellFunction.BellFunction(), approx.algorithms.Componentwise.Componentwise(), DPCMDemoClass.DPCMDemoClass(), data.selection.EpsSelector.EpsSelector(), kernels.GaussKernel.GaussKernel(), models.iciam2011.ICIAMExperiment.ICIAMExperiment(), models.iciam2011.ICIAMSystem.ICIAMSystem(), error.lipfun.ImprovedLocalSecantLipschitz.ImprovedLocalSecantLipschitz(), kernels.InvMultiquadrics.InvMultiquadrics(), approx.KernelApprox.KernelApprox(), kernels.KernelExpansion.KernelExpansion(), general.interpolation.KernelInterpol.KernelInterpol(), general.regression.KernelLS.KernelLS(), models.synth.KernelTest.KernelTest(), models.synth.KernelTestFun.KernelTestFun(), data.selection.LinspaceSelector.LinspaceSelector(), sampling.ManualSampler.ManualSampler(), models.mathmod2012.MathMODExperiment.MathMODExperiment(), models.mathmod2012.MathMODSystem.MathMODSystem(), solvers.MLode15i.MLode15i(), solvers.MLWrapper.MLWrapper(), kernels.ParamTimeKernelExpansion.ParamTimeKernelExpansion(), general.POD.POD(), spacereduction.PODGreedy.PODGreedy(), sampling.RandomSampler.RandomSampler(), models.circ.RCLadder.RCLadder(), spacereduction.RotationDecorator.RotationDecorator(), general.regression.ScalarEpsSVR.ScalarEpsSVR(), general.regression.ScalarNuSVR.ScalarNuSVR(), kernels.SigmoidKernel.SigmoidKernel(), data.selection.TimeSelector.TimeSelector(), approx.TPWLApprox.TPWLApprox(), models.wh10.WH10Experiment.WH10Experiment(), and models.wh10.WH10System.WH10System().

Here is the call graph for this function:

Member Data Documentation

DPCMObject.ID = "[]"

An ID that allows to uniquely identify this DPCMObject (at least within the current MatLab session/context).

This value is assigned automatically during construction.

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

Definition at line 70 of file DPCMObject.m.

Referenced by DPCMObject(), spacereduction.BaseSpaceReducer.plotSummary(), and general.DEIM.updateOrderData().

DPCMObject.PropertiesChanged = "[]"

The Dictionary containing all the property settings as key/value pairs.

This dictionary is created in the constructor of the DPCMObject.

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

Definition at line 85 of file DPCMObject.m.

Referenced by DPCMObject(), and registerProps().

DPCMObject.WorkspaceVariableName = ""

The workspace variable name of this class. Optional.

Must be set manually as the name is not available inside the class.

Property class optional:: This property can be set by any methods that perform computations that use the DPCM system a-priori. Setting this value increases the readability of the DPCM output.

See Also: inputname

Note: This property has the MATLAB attribute SetObservable set to true.; Matlab documentation of property attributes.
Default: ""

Must be set manually as the name is not available inside the class.

Property class optional:: This property can be set by any methods that perform computations that use the DPCM system a-priori. Setting this value increases the readability of the DPCM output.

See Also: inputname

Note: This property has the MATLAB attribute SetObservable set to true.; Matlab documentation of property attributes.
Default: ""

Definition at line 48 of file DPCMObject.m.

Referenced by DPCMDemoClass.demo(), and models.BaseModel.simulate().

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

dpcm/DPCMObject.m

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation