Devel Class Reference

Developer utilities. More...

Detailed Description

Developer utilities.

New function/class generation

In order to create new classes/functions with a customized initial comment etc. use the static methods Devel.newClass and Devel.newFun functions. They use the template files template_class and template_fun from the KerMor root directory and produce the new class by replacing any of

the following occurences by the respective same-named properties of any Devel instance

• $author The full name of the author
• $authorshort The author's short tag for identification in the documentation
• $mainver The current KerMor main version
• $subver The current KerMor sub version
• $date Today's date in the form yyyy-mm-dd

See the template files for examples.

Author

Daniel Wirtz

Date

2011-04-12

Change in 0.7:

(Daniel Wirtz, 2013-01-23) Removed the overwrite flag and added option to specify a path in which the file should be created.

Change in 0.4:

(Syed Ammar, 2011-06-02) Added comments to the function setup

New in 0.3:

(Daniel Wirtz, 2011-04-12) Added this class to aid new class creation and offer customized class / function skeletons.

Todo:

Check class/function name string validity for newClass/newFun

This class is part of the framework

KerMor - Model Order Reduction using Kernels

• Homepage http://www.morepas.org/software/index.html
• Documentation http://www.morepas.org/software/kermor/index.html
• License KerMor license conditions

Definition at line 17 of file Devel.m.

Static Public Member Functions
static function Devel inst =	Instance ()
	Returns the singleton instance of Devel. More...
static function	setup ()
	Setup variables for Kermor Development when Kermor is setup for the first time or any other time manually. More...
static function	newClass (name, varargin)
	Creates a new class using the template_class file. More...
static function	newFun (name, varargin)
	Creates a new function using the template_fun file. More...

Public Attributes
char	Author
	The current developing author. More...
char	AuthorShort
	Author's short tag for identification in doxygen @new and @change tags. More...
	Date
	Always today's date. 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...

Member Function Documentation

function Devel inst = Devel.Instance ( )

static

Returns the singleton instance of Devel.

Return values

inst	The instance

Definition at line 141 of file Devel.m.

Referenced by setup().

Here is the caller graph for this function:

function Devel.newClass (   name,   varargin  )

static

Creates a new class using the template_class file.

Parameters

name	The target class name
varargin	Additional parameters. newClass ( ..., dir ) Required Parameters for varargin: dir The target directory Default: pwd

Definition at line 171 of file Devel.m.

function Devel.newFun (   name,   varargin  )

static

Creates a new function using the template_fun file.

Todo:

check fun name validity!

Parameters

name	The target function name
varargin	Additional parameters. newFun ( ..., dir ) Required Parameters for varargin: dir The target directory Default: pwd

Definition at line 190 of file Devel.m.

function Devel.setup ( )

static

Setup variables for Kermor Development when Kermor is setup for the first time or any other time manually.

Add the name of the author and his initials(short tag)

Definition at line 153 of file Devel.m.

References Instance().

Referenced by KerMor.setup().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Devel.Author

The current developing author.

Note

This property has the MATLAB attribute Dependent set to true.

Matlab documentation of property attributes.

Definition at line 58 of file Devel.m.

Devel.AuthorShort

Author's short tag for identification in doxygen @new and @change tags.

Note

This property has the MATLAB attribute Dependent set to true.

Matlab documentation of property attributes.

Definition at line 71 of file Devel.m.

Devel.Date

Always today's date.

Note

This property has the MATLAB attribute Dependent set to true.

Matlab documentation of property attributes.

[readonly]

Definition at line 83 of file Devel.m.

---

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

• core/tools/Devel.m