MATLAB

Object-Oriented Programming

R2016a

How to Contact MathWorks

Latest news:

www.mathworks.com

Sales and services:

www.mathworks.com/sales_and_services

User community:

www.mathworks.com/matlabcentral

Technical support:

www.mathworks.com/support/contact_us

Phone:

508-647-7000

The MathWorks, Inc.

3 Apple Hill Drive
Natick, MA 01760-2098
Object-Oriented Programming
COPYRIGHT 19842016 by The MathWorks, Inc.
The software described in this document is furnished under a license agreement. The software may be used
or copied only under the terms of the license agreement. No part of this manual may be photocopied or
reproduced in any form without prior written consent from The MathWorks, Inc.
FEDERAL ACQUISITION: This provision applies to all acquisitions of the Program and Documentation
by, for, or through the federal government of the United States. By accepting delivery of the Program
or Documentation, the government hereby agrees that this software or documentation qualifies as
commercial computer software or commercial computer software documentation as such terms are used
or defined in FAR 12.212, DFARS Part 227.72, and DFARS 252.227-7014. Accordingly, the terms and
conditions of this Agreement and only those rights specified in this Agreement, shall pertain to and
govern the use, modification, reproduction, release, performance, display, and disclosure of the Program
and Documentation by the federal government (or other entity acquiring for or through the federal
government) and shall supersede any conflicting contractual terms or conditions. If this License fails
to meet the government's needs or is inconsistent in any respect with federal procurement law, the
government agrees to return the Program and Documentation, unused, to The MathWorks, Inc.

Trademarks

MATLAB and Simulink are registered trademarks of The MathWorks, Inc. See
www.mathworks.com/trademarks for a list of additional trademarks. Other product or brand
names may be trademarks or registered trademarks of their respective holders.
Patents

MathWorks products are protected by one or more U.S. patents. Please see
www.mathworks.com/patents for more information.

Revision History

March 2008
October 2008
March 2009
September 2009
March 2010
September 2010
April 2011
September 2011
March 2012
September 2012
March 2013
September 2013
March 2014
October 2014
March 2015
September 2015
March 2016

Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only
Online only

New for MATLAB 7.6 (Release 2008a)

Revised for MATLAB 7.7 (Release 2008b)
Revised for MATLAB 7.8 (Release 2009a)
Revised for MATLAB 7.9 (Release 2009b)
Revised for MATLAB 7.10 (Release 2010a)
Revised for Version 7.11 (Release 2010b)
Revised for Version 7.12 (Release 2011a)
Revised for Version 7.13 (Release 2011b)
Revised for Version 7.14 (Release 2012a)
Revised for Version 8.0 (Release 2012b)
Revised for Version 8.1 (Release 2013a)
Revised for Version 8.2 (Release 2013b)
Revised for Version 8.3 (Release 2014a)
Revised for Version 8.4 (Release 2014b)
Revised for Version 8.5 (Release 2015a)
Revised for Version 8.6 (Release 2015b)
Revised for Version 9.0 (Release 2016a)

Contents

Using Object-Oriented Design in MATLAB

Why Use Object-Oriented Design . . . . . . . . . . . . . . . . . . . . . .
Approaches to Writing MATLAB Programs . . . . . . . . . . . . . .
When Should You Create Object-Oriented Programs . . . . . . .

1-2
1-2
1-6

Using Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is a Handle? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Copies of Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Handle Objects Modified in Functions . . . . . . . . . . . . . . . . .
Determine If an Object Is a Handle . . . . . . . . . . . . . . . . . .
Deleted Handle Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1-12
1-12
1-12
1-13
1-15
1-15

Basic Example
A Simple Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define a Simple Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Access Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Call Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add Constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Vectorize Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overload Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BasicClass Code Listing . . . . . . . . . . . . . . . . . . . . . . . . . . .

2-2
2-2
2-3
2-3
2-3
2-4
2-5
2-6
2-6

vi

Contents

MATLAB Classes Overview

Role of Classes in MATLAB . . . . . . . . . . . . . . . . . . . . . . . . . . .
Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Some Basic Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . .

3-2
3-2
3-4

Developing Classes Typical Workflow . . . . . . . . . . . . . . . .

Formulating a Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specifying Class Components . . . . . . . . . . . . . . . . . . . . . . . .
BankAccount Class Implementation . . . . . . . . . . . . . . . . .
Formulating the AccountManager Class . . . . . . . . . . . . . .
Implementing the AccountManager Class . . . . . . . . . . . . .
AccountManager Class Synopsis . . . . . . . . . . . . . . . . . . . .
Using BankAccount Objects . . . . . . . . . . . . . . . . . . . . . . . .

3-8
3-8
3-9
3-10
3-14
3-15
3-15
3-16

Class to Manage Writable Files . . . . . . . . . . . . . . . . . . . . . . .

Flexible Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Performing a Task with an Object . . . . . . . . . . . . . . . . . . . .
Defining the Filewriter Class . . . . . . . . . . . . . . . . . . . . . . .
Using Filewriter Objects . . . . . . . . . . . . . . . . . . . . . . . . . . .

3-19
3-19
3-19
3-19
3-21

Class to Represent Structured Data . . . . . . . . . . . . . . . . . . .

Objects As Data Structures . . . . . . . . . . . . . . . . . . . . . . . . .
Structure of the Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The TensileData Class . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create an Instance and Assign Data . . . . . . . . . . . . . . . . . .
Restrict Properties to Specific Values . . . . . . . . . . . . . . . . .
Simplifying the Interface with a Constructor . . . . . . . . . . . .
Calculate Data on Demand . . . . . . . . . . . . . . . . . . . . . . . . .
Displaying TensileData Objects . . . . . . . . . . . . . . . . . . . .
Method to Plot Stress vs. Strain . . . . . . . . . . . . . . . . . . . . .
TensileData Class Synopsis . . . . . . . . . . . . . . . . . . . . . . .

3-24
3-24
3-24
3-25
3-25
3-26
3-27
3-28
3-29
3-30
3-31

Class to Implement Linked Lists . . . . . . . . . . . . . . . . . . . . . .

Class Definition Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
dlnode Class Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create Doubly Linked List . . . . . . . . . . . . . . . . . . . . . . . . .
Why a Handle Class for Linked Lists? . . . . . . . . . . . . . . . .
dlnode Class Synopsis . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specialize the dlnode Class . . . . . . . . . . . . . . . . . . . . . . . .

3-36
3-36
3-36
3-37
3-38
3-39
3-50

Class for Graphing Functions . . . . . . . . . . . . . . . . . . . . . . . .

Class Definition Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the topo Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Behavior of the Handle Class . . . . . . . . . . . . . . . . . . . . . . .

Static Data
Static Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is Static Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Static Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Static Data Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Constant Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

3-53
3-53
3-54
3-55

4-2
4-2
4-2
4-3
4-5

Class DefinitionSyntax Reference

Class Files and Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Definition Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Options for Class Folders . . . . . . . . . . . . . . . . . . . . . . . . . . .
Options for Class Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Group Classes with Package Folders . . . . . . . . . . . . . . . . . . .

5-2
5-2
5-2
5-2
5-3

Class Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Building Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Definition Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Properties Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Methods Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Events Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
A Complete Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enumeration Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5-5
5-5
5-5
5-6
5-6
5-7
5-7
5-8
5-9

Classdef Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Specify Attributes and Superclasses . . . . . . . . . . . .
Class Attribute Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Superclass Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5-10
5-10
5-10
5-11

vii

Local Functions in Class File . . . . . . . . . . . . . . . . . . . . . . .

viii

Contents

5-11

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Properties Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Access to Property Values . . . . . . . . . . . . . . . . . . . . . . . . . .

5-12
5-12
5-13

Methods and Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

The Methods Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Method Calling Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Private Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
More Detailed Information On Methods . . . . . . . . . . . . . . .
Class-Related Functions . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Overload Functions and Operators . . . . . . . . . . . . .
Rules for Defining Methods in Separate Files . . . . . . . . . . .

5-15
5-15
5-15
5-17
5-17
5-17
5-18
5-18

Events and Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Define and Trigger Events . . . . . . . . . . . . . . . . . . . . . . . . .
Listen for Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5-20
5-20
5-20

Attribute Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Attribute Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Attribute Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Attribute Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Simpler Syntax for true/false Attributes . . . . . . . . . . . . . . .

5-22
5-22
5-22
5-23
5-23

Call Superclass Methods on Subclass Objects . . . . . . . . . . .

How to Call Superclass Constructor . . . . . . . . . . . . . . . . . .
How to Call Superclass Methods . . . . . . . . . . . . . . . . . . . . .

5-25
5-25
5-26

Representative Class Code . . . . . . . . . . . . . . . . . . . . . . . . . . .

Class Calculates Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description of Class Definition . . . . . . . . . . . . . . . . . . . . . .

5-27
5-27
5-29

MATLAB Code Analyzer Warnings . . . . . . . . . . . . . . . . . . . .

Syntax Warnings and Property Names . . . . . . . . . . . . . . . .
Variable/Property Name Conflict Warnings . . . . . . . . . . . . .
Exception to Variable/Property Name Rule . . . . . . . . . . . . .

5-32
5-32
5-32
5-33

Objects In Conditional Statements . . . . . . . . . . . . . . . . . . . .

Enable Use of Objects In Conditional Statements . . . . . . . .
How MATLAB Evaluates Switch Statements . . . . . . . . . . .
How to Define the eq Method . . . . . . . . . . . . . . . . . . . . . . .
Enumerations in Switch Statements . . . . . . . . . . . . . . . . . .

5-34
5-34
5-34
5-36
5-38

Operations on Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Object Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Help on Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Functions to Test Objects . . . . . . . . . . . . . . . . . . . . . . . . . .
Functions to Query Class Components . . . . . . . . . . . . . . . .

5-41
5-41
5-42
5-44
5-44

Use of Editor and Debugger with Classes . . . . . . . . . . . . . .

Write Class Code in the Editor . . . . . . . . . . . . . . . . . . . . . .
How to Refer to Class Files . . . . . . . . . . . . . . . . . . . . . . . . .
How to Debug Class Files . . . . . . . . . . . . . . . . . . . . . . . . . .

5-45
5-45
5-45
5-46

Automatic Updates for Modified Classes . . . . . . . . . . . . . . .

When MATLAB Loads Class Definitions . . . . . . . . . . . . . . .
Consequences of Automatic Update . . . . . . . . . . . . . . . . . . .
What Happens When Class Definitions Change . . . . . . . . .
Actions That Do Not Trigger Updates . . . . . . . . . . . . . . . . .
Multiple Updates to Class Definitions . . . . . . . . . . . . . . . . .
Object Validity with Deleted Class File . . . . . . . . . . . . . . . .
When Updates Are Not Possible . . . . . . . . . . . . . . . . . . . . .
Potential Consequences of Class Updates . . . . . . . . . . . . . .
Updates to Class Attributes . . . . . . . . . . . . . . . . . . . . . . . .
Updates to Property Definitions . . . . . . . . . . . . . . . . . . . . .
Updates to Method Definitions . . . . . . . . . . . . . . . . . . . . . .
Updates to Event Definitions . . . . . . . . . . . . . . . . . . . . . . .

5-47
5-47
5-48
5-48
5-49
5-49
5-49
5-49
5-50
5-50
5-51
5-52
5-53

Compatibility with Previous Versions . . . . . . . . . . . . . . . . .

New Class-Definition Syntax Introduced with MATLAB
Software Version 7.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Changes to Class Constructors . . . . . . . . . . . . . . . . . . . . . .
New Features Introduced with Version 7.6 . . . . . . . . . . . . .
Examples of Old and New . . . . . . . . . . . . . . . . . . . . . . . . . .

5-55
5-55
5-56
5-56
5-57

Comparison of MATLAB and Other OO Languages . . . . . . .

Some Differences from C++ and Java Code . . . . . . . . . . . . .
Object Modification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Static Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Common Object-Oriented Techniques . . . . . . . . . . . . . . . . .

5-58
5-58
5-59
5-63
5-64

ix

Contents

Defining and Organizing Classes

User-Defined Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is a Class Definition . . . . . . . . . . . . . . . . . . . . . . . . . .
Attributes for Class Members . . . . . . . . . . . . . . . . . . . . . . . .
Kinds of Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Constructing Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
classdef Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6-2
6-2
6-2
6-3
6-3
6-3
6-3
6-4

Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specifying Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . .
Specifying Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6-6
6-6
6-7

Evaluation of Expressions in Class Definitions . . . . . . . . . . .

Why Use Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Where to Use Expressions in Class Definitions . . . . . . . . . . .
How MATLAB Evaluates Expressions . . . . . . . . . . . . . . . . .
When MATLAB Evaluates Expressions . . . . . . . . . . . . . . . .
Expression Evaluation in Handle and Value Classes . . . . . .

6-9
6-9
6-9
6-12
6-12
6-12

Folders Containing Class Definitions . . . . . . . . . . . . . . . . . .

Class and Path Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Path Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Class Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Access to Functions Defined in Private Folders . . . . . . . . . .
Class Precedence and MATLAB Path . . . . . . . . . . . . . . . . .
Changing Path to Update Class Definition . . . . . . . . . . . . .

6-16
6-16
6-16
6-17
6-17
6-18
6-19

Class Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Use of Class Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Mark Classes as Inferior . . . . . . . . . . . . . . . . . . . . . . .
InferiorClasses Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . .

6-22
6-22
6-22
6-22

Packages Create Namespaces . . . . . . . . . . . . . . . . . . . . . . . .

Package Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Internal Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Referencing Package Members Within Packages . . . . . . . . .
Referencing Package Members from Outside the Package . .
Packages and the MATLAB Path . . . . . . . . . . . . . . . . . . . .

6-24
6-24
6-25
6-25
6-26
6-27

Import Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Syntax for Importing Classes . . . . . . . . . . . . . . . . . . . . . . .
Import Package Functions . . . . . . . . . . . . . . . . . . . . . . . . . .
Package Function and Class Method Name Conflict . . . . . .
Clearing Import List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6-29
6-29
6-29
6-30
6-30

Value or Handle Class Which to Use

Comparison of Handle and Value Classes . . . . . . . . . . . . . . .
Basic Difference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Behavior of MATLAB Built-In Classes . . . . . . . . . . . . . . . . .
User-Defined Value Classes . . . . . . . . . . . . . . . . . . . . . . . . .
User-Defined Handle Classes . . . . . . . . . . . . . . . . . . . . . . . .
Determining Equality of Objects . . . . . . . . . . . . . . . . . . . . . .
Functionality Supported by Handle Classes . . . . . . . . . . . . .

7-2
7-2
7-3
7-4
7-5
7-7
7-9

Which Kind of Class to Use . . . . . . . . . . . . . . . . . . . . . . . . . .

Examples of Value and Handle Classes . . . . . . . . . . . . . . . .
When to Use Handle Classes . . . . . . . . . . . . . . . . . . . . . . .
When to Use Value Classes . . . . . . . . . . . . . . . . . . . . . . . . .

7-11
7-11
7-11
7-12

The Handle Superclass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Building on the Handle Class . . . . . . . . . . . . . . . . . . . . . . .
Handle Class Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event and Listener Methods . . . . . . . . . . . . . . . . . . . . . . . .
Relational Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test Handle Validity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
When MATLAB Destroys Objects . . . . . . . . . . . . . . . . . . . .

7-13
7-13
7-13
7-14
7-14
7-14
7-14

Handle Class Destructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Basic Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Syntax of Handle Class Destructor Method . . . . . . . . . . . . .
When to Define a Destructor Method . . . . . . . . . . . . . . . . .
Destructors in Class Hierarchies . . . . . . . . . . . . . . . . . . . . .
Object Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Restrict Access to Object Delete Method . . . . . . . . . . . . . . .
Nondestructor Delete Methods . . . . . . . . . . . . . . . . . . . . . .
Java Objects Referencing MATLAB Objects . . . . . . . . . . . .

7-16
7-16
7-16
7-17
7-18
7-18
7-20
7-20
7-21

xi

xii

Contents

Find Handle Objects and Properties . . . . . . . . . . . . . . . . . . .

Find Handle Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Find Handle Object Properties . . . . . . . . . . . . . . . . . . . . . .

7-24
7-24
7-24

Implement Set/Get Interface for Properties . . . . . . . . . . . . .

The Standard Set/Get Interface . . . . . . . . . . . . . . . . . . . . . .
Subclass matlab.mixin.SetGet . . . . . . . . . . . . . . . . . . . . . . .
Get Method Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set Method Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Derived from matlab.mixin.SetGet . . . . . . . . . . . . . . .

7-25
7-25
7-25
7-26
7-26
7-27

Customize Class Copy Behavior . . . . . . . . . . . . . . . . . . . . . .

Customize Copy Operation . . . . . . . . . . . . . . . . . . . . . . . . .
Copy Properties That Contain Handles . . . . . . . . . . . . . . . .
Exclude Properties from Copy . . . . . . . . . . . . . . . . . . . . . . .

7-32
7-32
7-33
7-35

Control Number of Instances . . . . . . . . . . . . . . . . . . . . . . . . .

Limit Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Singleton Class Implementation . . . . . . . . . . . . . . . . . . . . .

7-38
7-38
7-38

Properties Storing Class Data

How to Use Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Are Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Types of Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-2
8-2
8-2

Property Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property Definition Block . . . . . . . . . . . . . . . . . . . . . . . . . . .
Access Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inheritance of Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specify Property Attributes . . . . . . . . . . . . . . . . . . . . . . . . . .

8-4
8-4
8-5
8-6
8-6

Property Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Purpose of Property Attributes . . . . . . . . . . . . . . . . . . . . . . .
Specifying Property Attributes . . . . . . . . . . . . . . . . . . . . . . .
Table of Property Attributes . . . . . . . . . . . . . . . . . . . . . . . . .

8-7
8-7
8-7
8-7

Defining Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What You Can Define . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-13
8-13

Initialize Property Values . . . . . . . . . . . . . . . . . . . . . . . . . .

Property Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . .
Assign Property Values from Constructor . . . . . . . . . . . . . .
Initialize Properties to Unique Values . . . . . . . . . . . . . . . . .
Property Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Property Access Methods . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reference Object Properties Using Variables . . . . . . . . . . . .

8-13
8-14
8-14
8-15
8-15
8-16
8-17

Mutable and Immutable Properties . . . . . . . . . . . . . . . . . . .

Set Access to Property Values . . . . . . . . . . . . . . . . . . . . . . .
Define Immutable Property . . . . . . . . . . . . . . . . . . . . . . . . .

8-18
8-18
8-18

Restrict Class of Properties . . . . . . . . . . . . . . . . . . . . . . . . . .

Restrict Property Values to Specific Classes . . . . . . . . . . . .
Property Restriction Syntax . . . . . . . . . . . . . . . . . . . . . . . .
Restricted Property Implementation . . . . . . . . . . . . . . . . . .

8-20
8-20
8-20
8-21

Property Access Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Properties Provide Access to Class Data . . . . . . . . . . . . . . .
Property Setter and Getter Methods . . . . . . . . . . . . . . . . . .
Set and Get Method Execution and Property Events . . . . . .
Access Methods and Properties Containing Arrays . . . . . . .
Access Methods and Arrays of Objects . . . . . . . . . . . . . . . .
Modify Property Values with Access Methods . . . . . . . . . . .

8-23
8-23
8-23
8-26
8-27
8-27
8-27

Property Set Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Overview of Property Access Methods . . . . . . . . . . . . . . . . .
Property Set Method Syntax . . . . . . . . . . . . . . . . . . . . . . . .
Validate Property Set Value . . . . . . . . . . . . . . . . . . . . . . . .
Set Method Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-29
8-29
8-29
8-30
8-30

Property Get Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Overview of Property Access Methods . . . . . . . . . . . . . . . . .
Property Get Method Syntax . . . . . . . . . . . . . . . . . . . . . . . .
Calculate Value for Dependent Property . . . . . . . . . . . . . . .
Errors Not Returned from Get Method . . . . . . . . . . . . . . . .
Get Method Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-32
8-32
8-32
8-32
8-33
8-33

Access Methods for Dependent Properties . . . . . . . . . . . . . .

Set and Get Methods for Dependent Properties . . . . . . . . . .
Get Method for Dependent Property . . . . . . . . . . . . . . . . . .
When to Use Set Methods with Dependent Properties . . . . .
Private Set Access with Dependent Properties . . . . . . . . . .

8-34
8-34
8-35
8-35
8-36

xiii

xiv

Contents

Properties Containing Objects . . . . . . . . . . . . . . . . . . . . . . . .

Assigning Objects as Default Property Values . . . . . . . . . . .
Assigning to Read-Only Properties Containing Objects . . . .
Assignment Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8-38
8-38
8-38
8-38

Dynamic Properties Adding Properties to an Instance .

What Are Dynamic Properties . . . . . . . . . . . . . . . . . . . . . . .
Define Dynamic Properties . . . . . . . . . . . . . . . . . . . . . . . . .

8-41
8-41
8-42

Access Methods for Dynamic Properties . . . . . . . . . . . . . . .

Create Access Methods for Dynamic Properties . . . . . . . . . .
Shared Set and Get Methods . . . . . . . . . . . . . . . . . . . . . . .

8-45
8-45
8-46

Dynamic Property Events . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Dynamic Properties and Ordinary Property Events . . . . . . .
Dynamic-Property Events . . . . . . . . . . . . . . . . . . . . . . . . . .
Listen for a Specific Property Name . . . . . . . . . . . . . . . . . .
PropertyAdded Event Callback Execution . . . . . . . . . . . .
PropertyRemoved Event Callback Execution . . . . . . . . . .
How to Find meta.DynamicProperty Objects . . . . . . . . . .

8-47
8-47
8-47
8-48
8-49
8-50
8-50

Dynamic Properties and ConstructOnLoad . . . . . . . . . . . . .

8-51

Methods Defining Class Operations

How to Use Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Method Naming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

9-2
9-2
9-3

Method Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Purpose of Method Attributes . . . . . . . . . . . . . . . . . . . . . . . .
Specifying Method Attributes . . . . . . . . . . . . . . . . . . . . . . . .
Table of Method Attributes . . . . . . . . . . . . . . . . . . . . . . . . . .

9-5
9-5
9-5
9-5

Ordinary Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ordinary Methods Operate on Objects . . . . . . . . . . . . . . . . .
Methods Inside classdef Block . . . . . . . . . . . . . . . . . . . . . . . .
Method Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

9-7
9-7
9-7
9-8

Methods In Separate Files . . . . . . . . . . . . . . . . . . . . . . . . . . .

Class Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define Method in Function File . . . . . . . . . . . . . . . . . . . . . .
Specify Method Attributes in classdef File . . . . . . . . . . . .
Methods That You Must Define In the classdef File . . . . .

9-10
9-10
9-11
9-11
9-12

Method Invocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Determining Which Method Is Invoked . . . . . . . . . . . . . . . .
Referencing Names with ExpressionsDynamic Reference .
Controlling Access to Methods . . . . . . . . . . . . . . . . . . . . . . .
Invoking Superclass Methods in Subclass Methods . . . . . . .
Invoking Built-In Functions . . . . . . . . . . . . . . . . . . . . . . . .

9-14
9-14
9-16
9-17
9-18
9-19

Class Constructor Methods . . . . . . . . . . . . . . . . . . . . . . . . . .

Purpose of Class Constructor Methods . . . . . . . . . . . . . . . .
Rules for Constructors . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Initializing Objects in Constructor . . . . . . . . . . . . . . . . . . .
No Input Argument Constructor Requirement . . . . . . . . . . .
Constructing Subclasses . . . . . . . . . . . . . . . . . . . . . . . . . . .
Errors During Class Construction . . . . . . . . . . . . . . . . . . . .
Basic Structure of Constructor Methods . . . . . . . . . . . . . . .
Output Object Not Assigned . . . . . . . . . . . . . . . . . . . . . . . .

9-20
9-20
9-20
9-21
9-21
9-22
9-23
9-25
9-26
9-27

Static Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Are Static Methods . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Define Static Methods . . . . . . . . . . . . . . . . . . . . . . . . .
Defining Static Methods . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling Static Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inheriting Static Methods . . . . . . . . . . . . . . . . . . . . . . . . . .

9-28
9-28
9-28
9-28
9-29
9-29

Overload Functions in Class Definitions . . . . . . . . . . . . . . .

Why Overload Functions . . . . . . . . . . . . . . . . . . . . . . . . . . .
Implementing Overloaded MATLAB Functions . . . . . . . . . .
Rules for Naming to Avoid Conflicts . . . . . . . . . . . . . . . . . .

9-30
9-30
9-30
9-32

Class Support for Array-Creation Functions . . . . . . . . . . . .

Extend Array-Creation Functions for Your Class . . . . . . . . .
Which Syntax to Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Implement Support for Array-Creation Functions . . . . . . . .

9-34
9-34
9-35
9-36

Object Precedence in Method Invocation . . . . . . . . . . . . . . .

Default Object Precedence . . . . . . . . . . . . . . . . . . . . . . . . . .

9-44
9-44

xv

10

xvi

Contents

Specifying Precedence of User-Defined Classes . . . . . . . . . .

9-45

Dominant Argument in Overloaded Graphics Functions . .

Graphics Object Precedence . . . . . . . . . . . . . . . . . . . . . . . .
Dominant Argument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Defining Class Precedence . . . . . . . . . . . . . . . . . . . . . . . . .
Calls to Inferior-Class Methods . . . . . . . . . . . . . . . . . . . . . .

9-46
9-46
9-46
9-46
9-48

Class Methods for Graphics Callbacks . . . . . . . . . . . . . . . . .

Referencing the Method . . . . . . . . . . . . . . . . . . . . . . . . . . .
Syntax for Method Callbacks . . . . . . . . . . . . . . . . . . . . . . .
How to Use a Class Method for a Slider Callback . . . . . . . .

9-49
9-49
9-49
9-50

Object Arrays
Construct Object Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Build Arrays in the Constructor . . . . . . . . . . . . . . . . . . . . .
Referencing Property Values in Object Arrays . . . . . . . . . . .

10-2
10-2
10-3

Initialize Object Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Calls to Constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Initial Value of Object Properties . . . . . . . . . . . . . . . . . . . .

10-5
10-5
10-6

Empty Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating Empty Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Assigning Values to an Empty Array . . . . . . . . . . . . . . . . .

10-8
10-8
10-8

Initialize Arrays of Handle Objects . . . . . . . . . . . . . . . . . . .

Related Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10-10
10-11

Object Arrays with Dynamic Properties . . . . . . . . . . . . . . .

10-13

Concatenating Objects of Different Classes . . . . . . . . . . . .

Basic Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MATLAB Concatenation Rules . . . . . . . . . . . . . . . . . . . . .
Concatenating Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling the Dominant-Class Constructor . . . . . . . . . . . . . .
Converter Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10-15
10-15
10-15
10-16
10-16
10-18

11

Heterogeneous Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MATLAB Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Heterogeneous Hierarchies . . . . . . . . . . . . . . . . . . . . . . . .
Heterogeneous Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Heterogeneous Array Concepts . . . . . . . . . . . . . . . . . . . . .
Nature of Heterogeneous Arrays . . . . . . . . . . . . . . . . . . . .
Unsupported Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Conversion During Assignment and Concatenation . . . . . .
Empty Arrays of Heterogeneous Abstract Classes . . . . . . .

10-21
10-21
10-21
10-22
10-22
10-23
10-26
10-28
10-29
10-29

Heterogeneous Array Constructors . . . . . . . . . . . . . . . . . . .

Building Arrays in Superclass Constructors . . . . . . . . . . .
When Errors Can Occur . . . . . . . . . . . . . . . . . . . . . . . . . .
Initialize Array in Superclass Constructor . . . . . . . . . . . . .
Sample Implementation . . . . . . . . . . . . . . . . . . . . . . . . . .
Potential Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10-31
10-31
10-31
10-32
10-33
10-35

Events Sending and Responding to Messages

Overview Events and Listeners . . . . . . . . . . . . . . . . . . . . . . .
Why Use Events and Listeners . . . . . . . . . . . . . . . . . . . . . .
Events and Listeners Basics . . . . . . . . . . . . . . . . . . . . . . . .
Events and Listeners Syntax . . . . . . . . . . . . . . . . . . . . . . .
Create Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11-2
11-2
11-2
11-3
11-4

Class with Custom Event Data . . . . . . . . . . . . . . . . . . . . . . .

Class Event Data Requirements . . . . . . . . . . . . . . . . . . . . .
Define and Trigger Event . . . . . . . . . . . . . . . . . . . . . . . . . .
Define Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create Listener for Overflow Event . . . . . . . . . . . . . . . . . . .

11-6
11-6
11-6
11-7
11-8

Class to Observe Property Changes . . . . . . . . . . . . . . . . . . .

11-9

Implement Property Set Listener . . . . . . . . . . . . . . . . . . . .

PushButton Class Design . . . . . . . . . . . . . . . . . . . . . . . . .

11-11
11-11

Event and Listener Concepts . . . . . . . . . . . . . . . . . . . . . . . .

The Event Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11-14
11-14

xvii

xviii

Contents

Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Event Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Events Only in Handle Classes . . . . . . . . . . . . . . . . . . . . .
Property-Set and Query Events . . . . . . . . . . . . . . . . . . . . .
Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11-15
11-16
11-16
11-17
11-17

Event Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specify Event Attributes . . . . . . . . . . . . . . . . . . . . . . . . . .

11-19
11-19

Events and Listeners Syntax . . . . . . . . . . . . . . . . . . . . . . . .

Components to Implement . . . . . . . . . . . . . . . . . . . . . . . . .
Name Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Trigger Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Listen to Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Define Event-Specific Data . . . . . . . . . . . . . . . . . . . . . . . .

11-21
11-21
11-21
11-22
11-22
11-25

Listener Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Control Listener Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . .
Temporarily Deactivate Listeners . . . . . . . . . . . . . . . . . . .
Permanently Delete Listeners . . . . . . . . . . . . . . . . . . . . . .

11-27
11-27
11-27
11-28

Listener Callback Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . .

Specifying Listener Callbacks . . . . . . . . . . . . . . . . . . . . . .
Input Arguments for Callback Function . . . . . . . . . . . . . .
Additional Arguments for Callback Function . . . . . . . . . . .

11-29
11-29
11-29
11-30

Callback Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
When Callbacks Execute . . . . . . . . . . . . . . . . . . . . . . . . . .
Listener Order of Execution . . . . . . . . . . . . . . . . . . . . . . .
Callbacks That Call notify . . . . . . . . . . . . . . . . . . . . . . .
Manage Callback Errors . . . . . . . . . . . . . . . . . . . . . . . . . .
Invoke Functions from Function Handles . . . . . . . . . . . . .

11-32
11-32
11-32
11-32
11-33
11-33

Determine If Event Has Listeners . . . . . . . . . . . . . . . . . . . .

Do Listeners Exist for This Event? . . . . . . . . . . . . . . . . . .
Why Test for Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . .
Coding Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Listeners in Heterogeneous Arrays . . . . . . . . . . . . . . . . . .

11-34
11-34
11-34
11-34
11-35

Listen for Changes to Property Values . . . . . . . . . . . . . . . .

Create Property Listeners . . . . . . . . . . . . . . . . . . . . . . . . .
Property Event and Listener Classes . . . . . . . . . . . . . . . .

11-37
11-37
11-39

12

Abort Property Set Events . . . . . . . . . . . . . . . . . . . . . . . . . .

AbortSet When Value Does Not Change . . . . . . . . . . . . . .
When to Use AbortSet . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Implement AbortSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

11-41
11-41
11-41
11-41

Update Graphs Using Events and Listeners . . . . . . . . . . . .

Example Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Techniques Demonstrated in This Example . . . . . . . . . . . .
Summary of fcneval Class . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of fcnview Class . . . . . . . . . . . . . . . . . . . . . . . .
Methods Inherited from Handle Class . . . . . . . . . . . . . . . .
Using the fcneval and fcnview Classes . . . . . . . . . . . . . . .
Implement UpdateGraph Event and Listener . . . . . . . . . .
The PostSet Event Listener . . . . . . . . . . . . . . . . . . . . . . . .
Enable and Disable Listeners . . . . . . . . . . . . . . . . . . . . . .
@fcneval/fcneval.m Class Code . . . . . . . . . . . . . . . . . . . . .
@fcnview/fcnview.m Class Code . . . . . . . . . . . . . . . . . . . . .

11-45
11-45
11-46
11-46
11-47
11-49
11-49
11-51
11-55
11-58
11-59
11-60

How to Build on Other Classes

Hierarchies of Classes Concepts . . . . . . . . . . . . . . . . . . . .
Classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Develop the Abstraction . . . . . . . . . . . . . . . . . . . . . . . . . . .
Design of Class Hierarchies . . . . . . . . . . . . . . . . . . . . . . . .
Super and Subclass Behavior . . . . . . . . . . . . . . . . . . . . . . .
Implementation and Interface Inheritance . . . . . . . . . . . . .

12-2
12-2
12-3
12-4
12-4
12-5

Create Subclasses Syntax and Techniques . . . . . . . . . . .

Subclass Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Initialize Superclasses from Subclasses . . . . . . . . . . . . . . . .
Call Superclass Constructor Explicitly . . . . . . . . . . . . . . . .
Constructor Arguments and Object Initialization . . . . . . . .
Call Only Direct Superclass from Constructor . . . . . . . . . .
Subclass Alias for Existing Class . . . . . . . . . . . . . . . . . . .

12-7
12-7
12-7
12-9
12-9
12-10
12-11

Sequence of Constructor Calls in Class Hierarchy . . . . . .

12-13

Modify Superclass Methods . . . . . . . . . . . . . . . . . . . . . . . . .

When to Modify Superclass Methods . . . . . . . . . . . . . . . . .

12-15
12-15

xix

xx

Contents

Extend Superclass Methods . . . . . . . . . . . . . . . . . . . . . . . .

Complete Superclass Methods in Subclass . . . . . . . . . . . . .
How to Redefine Superclass Methods . . . . . . . . . . . . . . . .

12-15
12-16
12-17

Modify Superclass Properties . . . . . . . . . . . . . . . . . . . . . . .

Allowed Superclass Property Modification . . . . . . . . . . . . .
Private Local Property Takes Precedence in Method . . . . .

12-18
12-18
12-18

Subclass Multiple Classes . . . . . . . . . . . . . . . . . . . . . . . . . . .

Class Member Compatibility . . . . . . . . . . . . . . . . . . . . . . .
Multiple Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

12-20
12-20
12-21

Specify Allowed Subclasses . . . . . . . . . . . . . . . . . . . . . . . . .

Basic Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Control Allowed Subclasses . . . . . . . . . . . . . . . . . . . .
Specify Allowed Subclasses . . . . . . . . . . . . . . . . . . . . . . . .
Define Sealed Hierarchy of Classes . . . . . . . . . . . . . . . . . .

12-22
12-22
12-22
12-22
12-24

Control Access to Class Members . . . . . . . . . . . . . . . . . . . .

Basic Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Applications for Access Control Lists . . . . . . . . . . . . . . . . .
Specify Access to Class Members . . . . . . . . . . . . . . . . . . . .
Properties with Access Lists . . . . . . . . . . . . . . . . . . . . . . .
Methods with Access Lists . . . . . . . . . . . . . . . . . . . . . . . .
Abstract Methods with Access Lists . . . . . . . . . . . . . . . . .

12-25
12-25
12-26
12-26
12-27
12-28
12-32

Property Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

12-33

Method Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

12-34

Event Access List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

12-35

Support Both Handle and Value Subclasses . . . . . . . . . . .

Basic Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Handle Compatibility Rules . . . . . . . . . . . . . . . . . . . . . . .
Define Handle-Compatible Classes . . . . . . . . . . . . . . . . . .
Subclass Handle-Compatible Classes . . . . . . . . . . . . . . . . .
Methods for Handle Compatible Classes . . . . . . . . . . . . . .
Handle-Compatible Classes and Heterogeneous Arrays . . .

12-36
12-36
12-36
12-37
12-39
12-41
12-42

Subclasses of MATLAB Built-In Types . . . . . . . . . . . . . . . .

MATLAB Built-In Types . . . . . . . . . . . . . . . . . . . . . . . . . .
Built-In Types You Can Subclass . . . . . . . . . . . . . . . . . . .

12-44
12-44
12-44

Why Subclass Built-In Types . . . . . . . . . . . . . . . . . . . . . .

Which Functions Work with Subclasses of Built-In Types .
Behavior of Built-In Functions with Subclass Objects . . . .
Built-In Subclasses That Define Properties . . . . . . . . . . . .

12-45
12-45
12-45
12-46

Behavior of Inherited Built-In Methods . . . . . . . . . . . . . . .

Subclass double . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Built-In Data Value Methods . . . . . . . . . . . . . . . . . . . . . .
Built-In Data Organization Methods . . . . . . . . . . . . . . . . .
Built-In Indexing Methods . . . . . . . . . . . . . . . . . . . . . . . .
Built-In Concatenation Methods . . . . . . . . . . . . . . . . . . . .

12-48
12-48
12-49
12-50
12-51
12-51

Subclasses of Built-In Types Without Properties . . . . . . . .

Specialized Numeric Types . . . . . . . . . . . . . . . . . . . . . . . .
A Class to Manage uint8 Data . . . . . . . . . . . . . . . . . . . . .
Using the DocUint8 Class . . . . . . . . . . . . . . . . . . . . . . . . .

12-53
12-53
12-53
12-54

Subclasses of Built-In Types with Properties . . . . . . . . . . .

Specialized Numeric Types with Additional Data Storage .
Subclasses with Properties . . . . . . . . . . . . . . . . . . . . . . . .
Property Added . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Methods Implemented . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Definition Code . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using ExtendDouble . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Concatenation of ExtendDouble Objects . . . . . . . . . . . . . .

12-61
12-61
12-61
12-61
12-62
12-62
12-64
12-67

Use of size and numel with Classes . . . . . . . . . . . . . . . . . . .

size and numel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Built-In Class Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . .
Subclasses Inherit Behavior . . . . . . . . . . . . . . . . . . . . . . .
Classes Not Derived from Built-In Classes . . . . . . . . . . . .
Change the Behavior of size or numel . . . . . . . . . . . . . . . .
Overload numArgumentsFromSubscript Instead of numel .

12-69
12-69
12-69
12-70
12-71
12-73
12-74

Class to Represent Hardware . . . . . . . . . . . . . . . . . . . . . . .

Objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Derive from int32 . . . . . . . . . . . . . . . . . . . . . . . . . . .
Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Construct MuxCard Object . . . . . . . . . . . . . . . . . . . . . . . .
Call Methods of int32 . . . . . . . . . . . . . . . . . . . . . . . . . . . .

12-75
12-75
12-75
12-75
12-76
12-77

Determine Array Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Query the Class Name . . . . . . . . . . . . . . . . . . . . . . . . . . .

12-78
12-78

xxi

13

xxii

Contents

Test for Array Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Test for Specific Types . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test for Most Derived Class . . . . . . . . . . . . . . . . . . . . . . .

12-78
12-79
12-80

Abstract Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Abstract Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Declare Classes as Abstract . . . . . . . . . . . . . . . . . . . . . . .
Determine If a Class Is Abstract . . . . . . . . . . . . . . . . . . . .
Find Inherited Abstract Properties and Methods . . . . . . . .

12-82
12-82
12-83
12-84
12-85

Define an Interface Superclass . . . . . . . . . . . . . . . . . . . . . .

Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Interface Class Implementing Graphs . . . . . . . . . . . . . . . .

12-87
12-87
12-87

Saving and Loading Objects

Save and Load Process for Objects . . . . . . . . . . . . . . . . . . . .
Save and Load Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Information Is Saved? . . . . . . . . . . . . . . . . . . . . . . . .
How Is the Property Data Loaded? . . . . . . . . . . . . . . . . . . .
Errors During Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13-2
13-2
13-2
13-2
13-3

Reduce MAT-File Size for Saved Objects . . . . . . . . . . . . . . .

Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dependent Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transient Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Avoid Saving Unwanted Variables . . . . . . . . . . . . . . . . . . .

13-4
13-4
13-4
13-4
13-5

Save Object Data to Recreate Graphics Objects . . . . . . . . .

What to Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Regenerate When Loading . . . . . . . . . . . . . . . . . . . . . . . . .
Change to a Stairstep Chart . . . . . . . . . . . . . . . . . . . . . . . .

13-6
13-6
13-6
13-7

Improve Version Compatibility with Default Values . . . . .

Version Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using a Default Property Value . . . . . . . . . . . . . . . . . . . . .

13-8
13-8
13-8

Avoid Property Initialization Order Dependency . . . . . . .

Control Property Loading . . . . . . . . . . . . . . . . . . . . . . . . .

13-10
13-10

Dependent Property with Private Storage . . . . . . . . . . . . .

Property Value Computed from Other Properties . . . . . . .

13-10
13-12

Modify the Save and Load Process . . . . . . . . . . . . . . . . . . .

When to Modify the Save and Load Process . . . . . . . . . . .
How to Modify the Save and Load Process . . . . . . . . . . . .
Implementing saveobj and loadobj Methods . . . . . . . . . . . .
Additional Considerations . . . . . . . . . . . . . . . . . . . . . . . . .

13-14
13-14
13-14
13-14
13-15

Basic saveobj and loadobj Pattern . . . . . . . . . . . . . . . . . .

Using saveobj and loadobj . . . . . . . . . . . . . . . . . . . . . .
Handle Load Problems . . . . . . . . . . . . . . . . . . . . . . . . . . .

13-17
13-17
13-18

Maintain Class Compatibility . . . . . . . . . . . . . . . . . . . . . . . .

Rename Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Update Property When Loading . . . . . . . . . . . . . . . . . . . .
Maintaining Compatible Versions of a Class . . . . . . . . . . .
Version 2 of the PhoneBookEntry Class . . . . . . . . . . . . . .

13-21
13-21
13-23
13-24
13-25

Initialize Objects When Loading . . . . . . . . . . . . . . . . . . . . .

Calling Constructor When Loading Objects . . . . . . . . . . . .
Initializing Objects in the loadobj Method . . . . . . . . . . .

13-28
13-28
13-28

Save and Load Objects from Class Hierarchies . . . . . . . . .

Saving and Loading Subclass Objects . . . . . . . . . . . . . . . .
Reconstruct the Subclass Object from a Saved struct . . .

13-30
13-30
13-30

Restore Listeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create Listener with loadobj . . . . . . . . . . . . . . . . . . . . .
Use Transient Property to Load Listener . . . . . . . . . . . . .
Using the BankAccount and AccountManager Classes . . . .

13-33
13-33
13-33
13-35

Save and Load Dynamic Properties . . . . . . . . . . . . . . . . . .

Saving Dynamic Properties . . . . . . . . . . . . . . . . . . . . . . . .
When You Need saveobj and loadobj Methods . . . . . . .
Implementing saveobj and loadobj Methods . . . . . . . . .

13-36
13-36
13-36
13-36

xxiii

14

xxiv

Contents

Enumerations
Named Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Kinds of Predefined Names . . . . . . . . . . . . . . . . . . . . . . . . .
Techniques for Defining Enumerations . . . . . . . . . . . . . . . .

14-2
14-2
14-3

Define Enumeration Classes . . . . . . . . . . . . . . . . . . . . . . . . .

Enumeration Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Construct an Enumeration Member . . . . . . . . . . . . . . . . . .
Convert to Superclass Value . . . . . . . . . . . . . . . . . . . . . . . .
Define Methods in Enumeration Classes . . . . . . . . . . . . . . .
Define Properties in Enumeration Classes . . . . . . . . . . . . .
Enumeration Class Constructor Calling Sequence . . . . . . . .

14-5
14-5
14-5
14-6
14-7
14-7
14-8

Refer to Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances of Enumeration Classes . . . . . . . . . . . . . . . . . . .
Conversion of Characters to Enumerations . . . . . . . . . . . .
Enumeration Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

14-11
14-11
14-13
14-15

Restrict Property Values to Enumerations . . . . . . . . . . . .

Syntax for Property/Enumeration Definition . . . . . . . . . . .
Example of Restricted Property . . . . . . . . . . . . . . . . . . . . .

14-17
14-17
14-17

Operations on Enumerations . . . . . . . . . . . . . . . . . . . . . . . .
Operations Supported by Enumerations . . . . . . . . . . . . . .
Enumeration Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Convert Enumeration Member to Characters . . . . . . . . . .
Convert Enumeration Array to Cell Array of char Vectors .
Enumerations and char Vectors in Relational Operations .
Enumerations in switch Statements . . . . . . . . . . . . . . . .
Enumeration Set Membership . . . . . . . . . . . . . . . . . . . . . .
Enumeration Text Comparison Methods . . . . . . . . . . . . . .
How to Get Information About Enumerations . . . . . . . . . .
Testing for an Enumeration . . . . . . . . . . . . . . . . . . . . . . .

14-19
14-19
14-19
14-20
14-20
14-20
14-21
14-22
14-23
14-24
14-25
14-25

Enumeration Class Restrictions . . . . . . . . . . . . . . . . . . . . .

14-27

Enumerations Derived from Built-In Types . . . . . . . . . . . .

Subclassing Built-In Types . . . . . . . . . . . . . . . . . . . . . . . .
Derive Enumeration Class from Numeric Type . . . . . . . . .

14-28
14-28
14-28

15

How to Alias Enumeration Names . . . . . . . . . . . . . . . . . .

Superclass Constructor Returns Underlying Value . . . . . .
Default Converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

14-30
14-31
14-32

Mutable Handle vs. Immutable Value Enumeration

Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Select Handle- or Value-Based Enumerations . . . . . . . . . .
Value-Based Enumeration Classes . . . . . . . . . . . . . . . . . .
Handle-Based Enumeration Classes . . . . . . . . . . . . . . . . .
Represent State with Enumerations . . . . . . . . . . . . . . . . .

14-34
14-34
14-34
14-36
14-39

Enumerations That Encapsulate Data . . . . . . . . . . . . . . . .

Enumeration Classes with Properties . . . . . . . . . . . . . . . .
Store Data in Properties . . . . . . . . . . . . . . . . . . . . . . . . . .

14-41
14-41
14-41

Save and Load Enumerations . . . . . . . . . . . . . . . . . . . . . . .

Basic Knowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Built-In and Value-Based Enumeration Classes . . . . . . . .
Simple and Handle-Based Enumeration Classes . . . . . . . .
Causes: Load as struct Instead of Object . . . . . . . . . . . .

14-45
14-45
14-45
14-45
14-46

Constant Properties
Properties with Constant Values . . . . . . . . . . . . . . . . . . . . . .
Defining Named Constants . . . . . . . . . . . . . . . . . . . . . . . . .
Constant Property Assigned a Handle Object . . . . . . . . . . .
Constant Property Assigned Any Object . . . . . . . . . . . . . . .
Constant Properties No Support for Get Events . . . . . . .

16

15-2
15-2
15-4
15-4
15-6

Information from Class Metadata

Class Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What Is Class Metadata? . . . . . . . . . . . . . . . . . . . . . . . . . .
The meta Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Metaclass Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

16-2
16-2
16-3
16-3

xxv

17

xxvi

Contents

Metaclass Object Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . .

16-4

Class Introspection with Metadata . . . . . . . . . . . . . . . . . . . .

Using Class Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inspect the EmployeeData Class . . . . . . . . . . . . . . . . . . . . .
Metaclass EnumeratedValues Property . . . . . . . . . . . . . . . .

16-5
16-5
16-5
16-8

Find Objects with Specific Values . . . . . . . . . . . . . . . . . . . .

Find Handle Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Find by Attribute Settings . . . . . . . . . . . . . . . . . . . . . . . .

16-10
16-10
16-11

Get Information About Properties . . . . . . . . . . . . . . . . . . . .

The meta.property object . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Find Properties with Specific Attributes . . . . . . . .

16-14
16-14
16-18

Find Default Values in Property Metadata . . . . . . . . . . . .

Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
meta.property Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

16-20
16-20
16-20

Specialize Object Behavior

Methods That Modify Default Behavior . . . . . . . . . . . . . . . .
How to Customize Class Behavior . . . . . . . . . . . . . . . . . . . .
Which Methods Control Which Behaviors . . . . . . . . . . . . . .
Overload Functions and Override Methods . . . . . . . . . . . . .

17-2
17-2
17-2
17-4

Number of Arguments for subsref and subsasgn . . . . . . . . .

How MATLAB Determines Number of Arguments . . . . . . .
Syntax for subsref, and subsasgn Methods . . . . . . . . . . . . .

17-5
17-5
17-6

Modify nargout and nargin for Indexing Methods . . . . . . .

When to Modify Number of Arguments . . . . . . . . . . . . . . . .
How to Modify Number of Arguments . . . . . . . . . . . . . . . . .

17-8
17-8
17-8

Concatenation Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Concatenation . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Methods to Overload . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17-10
17-10
17-10

Object Converters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Implement Converters . . . . . . . . . . . . . . . . . . . . . . . .
Converters for Package Classes . . . . . . . . . . . . . . . . . . . . .
Converters and Subscripted Assignment . . . . . . . . . . . . . .

17-11
17-11
17-11
17-12

Object Array Indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Default Indexed Reference and Assignment . . . . . . . . . . .
What You Can Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . .
When to Modify Indexing Behavior . . . . . . . . . . . . . . . . . .
Built-In subsref and subsasgn Called in Methods . . . . . . .
Avoid Overriding Access Attributes . . . . . . . . . . . . . . . . . .

17-14
17-14
17-15
17-16
17-16
17-18

Code Patterns for subsref and subsasgn Methods . . . . . . .

Customize Indexed Reference and Assignment . . . . . . . . .
Syntax for subsref and subsasgn Methods . . . . . . . . . . . . .
Indexing Structure Describes Indexing Expressions . . . . .
Values of the Indexing Structure . . . . . . . . . . . . . . . . . . . .
Typical Patterns for Indexing Methods . . . . . . . . . . . . . . .

17-20
17-20
17-20
17-21
17-22
17-22

Indexed Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How Indexed Reference Works . . . . . . . . . . . . . . . . . . . . .
Compound Indexed References . . . . . . . . . . . . . . . . . . . . .
How to Write subsref for Objects . . . . . . . . . . . . . . . . . . . .

17-27
17-27
17-28
17-29

Indexed Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How Indexed Assignment Works . . . . . . . . . . . . . . . . . . . .
Indexed Assignment to Objects . . . . . . . . . . . . . . . . . . . . .
Compound Indexed Assignments . . . . . . . . . . . . . . . . . . . .
How to Write subsasgn for Objects . . . . . . . . . . . . . . . . . .

17-31
17-31
17-33
17-33
17-34

end as Object Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Define end Indexing for an Object . . . . . . . . . . . . . . . . . . .
The end Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17-36
17-36
17-37

Objects in Index Expressions . . . . . . . . . . . . . . . . . . . . . . . .

Objects Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ways to Implement Objects as Indices . . . . . . . . . . . . . . .
subsindex Implementation . . . . . . . . . . . . . . . . . . . . . . . . .

17-38
17-38
17-38
17-38

Class with Modified Indexing . . . . . . . . . . . . . . . . . . . . . . .

How to Modify Class Indexing . . . . . . . . . . . . . . . . . . . . . .
Class Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Specialize Subscripted Reference subsref . . . . . . . . . . .

17-40
17-40
17-40
17-42

xxvii

18

xxviii

Contents

Specialize Subscripted Assignment subsasgn . . . . . . . .

Implement Addition for Object Data double and plus . .
MyDataClass.m . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17-43
17-44
17-45

Operator Overloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Overload Operators . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Define Operators . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample Implementation Addable Objects . . . . . . . . . . .
MATLAB Operators and Associated Functions . . . . . . . . .

17-48
17-48
17-48
17-49
17-51

Customizing Object Display

Custom Display Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Object Display . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CustomDisplay Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Methods for Customizing Object Display . . . . . . . . . . . . . . .

18-2
18-2
18-3
18-3

How CustomDisplay Works . . . . . . . . . . . . . . . . . . . . . . . . . .

Steps to Display an Object . . . . . . . . . . . . . . . . . . . . . . . . .
Methods Called for a Given Object State . . . . . . . . . . . . . . .

18-7
18-7
18-8

Role of size Function in Custom Displays . . . . . . . . . . . . .

How size Is Used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Precautions When Overloading size . . . . . . . . . . . . . . . . . .

18-10
18-10
18-10

Customize Display for Heterogeneous Arrays . . . . . . . . . .

18-12

Class with Default Object Display . . . . . . . . . . . . . . . . . . . .

The EmployeeInfo Class . . . . . . . . . . . . . . . . . . . . . . . . . .
Default Display Scalar . . . . . . . . . . . . . . . . . . . . . . . . .
Default Display Nonscalar . . . . . . . . . . . . . . . . . . . . . .
Default Display Empty Object Array . . . . . . . . . . . . . . .
Default Display Handle to Deleted Object . . . . . . . . . . .
Default Display Detailed Display . . . . . . . . . . . . . . . . .

18-14
18-14
18-15
18-15
18-16
18-17
18-17

Choose a Technique for Display Customization . . . . . . . .

Ways to Implement a Custom Display . . . . . . . . . . . . . . . .
Sample Approaches Using the Interface . . . . . . . . . . . . . .

18-19
18-19
18-20

19

Customize Property Display . . . . . . . . . . . . . . . . . . . . . . . . .

Objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Change the Property Order . . . . . . . . . . . . . . . . . . . . . . . .
Change the Values Displayed for Properties . . . . . . . . . . .

18-23
18-23
18-23
18-24

Customize Header, Property List, and Footer . . . . . . . . . .

Objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Design of Custom Display . . . . . . . . . . . . . . . . . . . . . . . . .
getHeader Method Override . . . . . . . . . . . . . . . . . . . . . . .
getPropertyGroups Override . . . . . . . . . . . . . . . . . . . . . . .
getFooter Override . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18-26
18-26
18-26
18-28
18-29
18-29

Customize Display of Scalar Objects . . . . . . . . . . . . . . . . . .

Objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Design Of Custom Display . . . . . . . . . . . . . . . . . . . . . . . .
displayScalarObject Method Override . . . . . . . . . . . . . . . .
getPropertyGroups Override . . . . . . . . . . . . . . . . . . . . . . .

18-32
18-32
18-32
18-33
18-34

Customize Display of Object Arrays . . . . . . . . . . . . . . . . . .

Objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Design of Custom Display . . . . . . . . . . . . . . . . . . . . . . . . .
The displayNonScalarObject Override . . . . . . . . . . . . . . . .
The displayEmptyObject Override . . . . . . . . . . . . . . . . . . .

18-36
18-36
18-36
18-37
18-38

Overloading the disp Function . . . . . . . . . . . . . . . . . . . . . .

Display Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overloaded disp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Relationship Between disp and display . . . . . . . . . . . . . . .

18-41
18-41
18-41
18-41

Implementing a Class for Polynomials

Class Design for Polynomials . . . . . . . . . . . . . . . . . . . . . . . . .
Object Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DocPolynom Class Members . . . . . . . . . . . . . . . . . . . . . . . .
DocPolynom Class Synopsis . . . . . . . . . . . . . . . . . . . . . . . .
The DocPolynom Constructor . . . . . . . . . . . . . . . . . . . . . .
Remove Irrelevant Coefficients . . . . . . . . . . . . . . . . . . . . .
Convert DocPolynom Objects to Other Types . . . . . . . . . .
Overload disp for DocPolynom . . . . . . . . . . . . . . . . . . . . .

19-2
19-2
19-2
19-4
19-13
19-14
19-15
19-17

xxix

Display Evaluated Expression . . . . . . . . . . . . . . . . . . . . . .

Redefine Indexed Reference . . . . . . . . . . . . . . . . . . . . . . . .
Define Arithmetic Operators . . . . . . . . . . . . . . . . . . . . . . .

20

xxx

Contents

19-18
19-19
19-21

Designing Related Classes

A Simple Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Shared and Specialized Properties . . . . . . . . . . . . . . . . . . .
Designing a Class for Financial Assets . . . . . . . . . . . . . . . .
DocAsset Class Definition . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the DocAsset Class . . . . . . . . . . . . . . . . . . . . .
The DocAsset Constructor Method . . . . . . . . . . . . . . . . . . .
The DocAsset Display Method . . . . . . . . . . . . . . . . . . . . . . .
Designing a Class for Stock Assets . . . . . . . . . . . . . . . . . . .
DocStock Class Definition . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the DocStock Class . . . . . . . . . . . . . . . . . . . . .
Designing a Class for Bond Assets . . . . . . . . . . . . . . . . . .
DocBond Class Definition . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the DocBond Class . . . . . . . . . . . . . . . . . . . .
Designing a Class for Savings Assets . . . . . . . . . . . . . . . .
DocSavings Class Definition . . . . . . . . . . . . . . . . . . . . . . .
Summary of the DocSavings Class . . . . . . . . . . . . . . . . . .
DocAsset Class Code Listing . . . . . . . . . . . . . . . . . . . . . . .
DocStock Class Code Listing . . . . . . . . . . . . . . . . . . . . . . .
DocBond Class Code Listing . . . . . . . . . . . . . . . . . . . . . . .
DocSavings Class Code Listing . . . . . . . . . . . . . . . . . . . . .

20-2
20-2
20-3
20-4
20-4
20-5
20-6
20-7
20-7
20-7
20-10
20-10
20-10
20-14
20-14
20-14
20-17
20-17
20-18
20-19

Containing Assets in a Portfolio . . . . . . . . . . . . . . . . . . . . .

Kinds of Containment . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Designing the DocPortfolio Class . . . . . . . . . . . . . . . . . . . .
Displaying the Class Files . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the DocPortfolio Class . . . . . . . . . . . . . . . . . .
The DocPortfolio Constructor Method . . . . . . . . . . . . . . . .
The DocPortfolio disp Method . . . . . . . . . . . . . . . . . . . . . .
The DocPortfolio pie3 Method . . . . . . . . . . . . . . . . . . . . . .
Visualizing a Portfolio . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DocPortfolio Class Code Listing . . . . . . . . . . . . . . . . . . . . .

20-20
20-20
20-20
20-21
20-21
20-23
20-24
20-24
20-25
20-26

1
Using Object-Oriented Design in
MATLAB
Why Use Object-Oriented Design on page 1-2
Using Handles on page 1-12

Using Object-Oriented Design in MATLAB

Why Use Object-Oriented Design

In this section...
Approaches to Writing MATLAB Programs on page 1-2
When Should You Create Object-Oriented Programs on page 1-6

Approaches to Writing MATLAB Programs

Creating software applications typically involves designing the application data and
implementing operations performed on that data. Procedural programs pass data to
functions, which perform the necessary operations on the data. Object-oriented software
encapsulates data and operations in objects that interact with each other via the object's
interface.
The MATLAB language enables you to create programs using both procedural and objectoriented techniques and to use objects and ordinary functions together in your programs.
Procedural Program Design
In procedural programming, your design focuses on the steps that must execute to
achieve a desired state. Typically, you represent data as individual variables or fields of a
structure. You implement operations as functions that take the variables as arguments.
Programs usually call a sequence of functions, each one of which is passed data, and then
returns modified data. Each function performs an operation or many operations on the
data.
Object-Oriented Program Design
The object-oriented program design involves:
Identifying the components of the system or application that you want to build
Analyzing and identifying patterns to determine what components are used
repeatedly or share characteristics
Classifying components based on similarities and differences
After performing this analysis, you define classes that describe the objects your
application uses.
1-2

Why Use Object-Oriented Design

Classes and Objects

A class describes a set of objects with common characteristics. Objects are specific
instances of a class. The values contained in an object's properties are what make an
object different from other objects of the same class. The functions defined by the class
(called methods) are what implement object behaviors that are common to all objects of a
class.
Using Objects in MATLAB Programs
The MATLAB language defines objects that are designed for use in any MATLAB code.
For example, consider the try/catch programming construct.
If the code executed in the try block generates an error, program control passes to the
code in the catch block. This behavior enables your program to provide special error
handling that is more appropriate to your particular application. However, you must
have enough information about the error to take the appropriate action.
MATLAB provides detailed information about the error by passing an MException
object to functions executing the try/catch blocks.
The following try/catch blocks display the error message stored in an MException
object when you call a function (surf in this case) without the necessary arguments:
try
surf
catch ME
disp(ME.message)
end
Not enough input arguments.

In this code, ME is an object of the MException class, which the catch statement creates
to capture information about the error. Displaying the value of the object message
property returns the error message (Not enough input arguments). Your program can
access other properties to get information about the error.
List all the public properties of an object with the properties function:
properties(ME)
Properties for class MException:
identifier

1-3

Using Object-Oriented Design in MATLAB

message
cause
stack

Objects Organize Data

Properties store the information returned in MException objects. Reference a property
using dot notation, as in ME.message. This reference returns the value of the property.
For example,
class(ME.message)
ans =
char

shows that the value of the message property is an array of class char (a character
array). The stack property contains a MATLAB struct:
s = ME.stack
s =
file: [1x90 char]
name: 'surf'
line: 50

You can treat ME.stack as a structure and reference its fields without assigning the
value:
ME.stack.file
ans =
D:\myMATLAB\matlab\toolbox\matlab\graph3d\surf.m

The file field of the struct contained in the stack property is a character array:
class(ME.stack.file)
ans =
char

You could, for example, use a property reference in MATLAB functions:

strcmp(ME.stack.name,'surf')
ans =
1

1-4

Why Use Object-Oriented Design

Objects Manage Their Own Data

You could write a function that generates a report from the data returned by
MException object properties. This function could become complicated because it would
have to be able to handle all possible errors. Perhaps you would use different functions
for different try/catch blocks in your program. If the data returned by the error object
must change, you would have to update the functions to use the new data.
Objects define their own operations as part of their interface. The MException object
can generate its own report. The methods that implement an object's operations are
part of the object definition (that is, specified by the class that defines the object). The
object definition can be modified many times, but the interface your program use does not
change. Objects isolate your code from the object's code.
To see what methods exist for MException objects, use the methods function:
methods(ME)

Methods for class MException:

addCause
eq

getReport
isequal

ne
rethrow

throw
throwAsCaller

Static methods:
last

You can use these methods like any other MATLAB statement when there is an
MException object in the workspace. For example:
ME.getReport
ans =
Error using ==> surf
Not enough input arguments.

Objects often have methods that overload (redefined for the particular class of the object)
MATLAB functions. Overloading enables you to use objects just like other values. For
example, MException objects have an isequal method. This method enables you
to compare these objects in the same way you would compare variables containing
numeric values. If ME1 and ME2 are MException objects, you can compare them with this
statement:
isequal(ME1,ME2)

1-5

Using Object-Oriented Design in MATLAB

However, what really happens in this case is MATLAB calls the MException isequal
method because you passed MException objects to isequal.
Similarly, the eq method enables you to use the == operator with MException objects:
ME == ME2

Objects should support only those methods that make sense. For example, it would
probably not make sense to multiply MException objects so the MException class does
not implement methods to do so.

When Should You Create Object-Oriented Programs

You can implement simple programming tasks as simple functions. However, as the
magnitude and complexity of your tasks increase, functions become more complex and
difficult to manage.
As functions become too large, you can break them into smaller functions and pass data
from one to function to another. However, as the number of functions becomes large,
designing, and managing the data passed to functions becomes difficult and error prone.
At this point, consider moving your MATLAB programming tasks to object-oriented
designs.
Understand a Problem in Terms of Its Objects
Thinking in terms of objects is simpler and more natural for some problems. Think of the
nouns in your problem statement as the objects to define and the verbs as the operations
to perform.
Consider the design of classes to represent money lending institutions (banks, mortgage
companies, individual money lenders, and so on). It is difficult to represent the various
types of lenders as procedures. However, you can represent each one as an object that
performs certain actions and contains certain data. The process of designing the objects
involves identifying the characteristics of a lender that are important to your application.
Identify Commonalities

What do all money lenders have in common? All MoneyLender objects can have a loan
method and an InterestRate property, for example.
Identify Differences

How does each money lender differ? One can provide loans to businesses while another
provides loans only to individuals. Therefore, the loan operation might need to be
1-6

Why Use Object-Oriented Design

different for different types of lending institutions. Subclasses of a base MoneyLender

class can specialize the subclass versions of the loan method. Each lender can have a
different value for its InterestRate property.
Factor out commonalities into a superclass and implement what is specific to each type of
lender in the subclass.
Add Only What Is Necessary

These institutions might engage in activities that are not of interest to your application.
During the design phase, determine what operations and data an object must contain
based on your problem definition.
Objects Manage Internal State
Objects provide several useful features not available from structures and cell arrays. For
example, objects can:
Constrain the data values assigned to any given property
Calculate the value of a property only when it is queried
Broadcast notices when any property value is queried or changed
Restrict access to properties and methods
Reducing Redundancy
As the complexity of your program increases, the benefits of an object-oriented design
become more apparent. For example, suppose that you implement the following
procedure as part of your application:
1

Check inputs

Perform computation on the first input argument

Transform the result of step 2 based on the second input argument

Check validity of outputs and return values

You can implement this procedure as an ordinary function. But suppose that you use
this procedure again somewhere in your application, except that step 2 must perform
a different computation. You could copy and paste the first implementation, and then
rewrite step 2. Or you could create a function that accepted an option indicating which
computation to make, and so on. However, these options lead to more complicated code.
An object-oriented design can factor out the common code into what is called a base class.
The base class would define the algorithm used and implement whatever is common to
1-7

Using Object-Oriented Design in MATLAB

all cases that use this code. Step 2 could be defined syntactically, but not implemented,
leaving the specialized implementation to the classes that you then derive from this base
class.
Step 1
function checkInputs()
% actual implementation
end
Step 2
function results = computeOnFirstArg()
% specify syntax only
end
Step 3
function transformResults()
% actual implementation
end
Step 4
function out = checkOutputs()
% actual implementation
end

The code in the base class is not copied or modified. Classes you derive from the base
class inherit this code. Inheritance reduces the amount of code to be tested, and isolates
your program from changes to the basic procedure.
Defining Consistent Interfaces
The use of a class as the basis for similar, but more specialized classes is a useful
technique in object-oriented programming. This class defines a common interface.
Incorporating this kind of class into your program design enables you to:
Identify the requirements of a particular objective
Encode requirements into your program as an interface class
Reducing Complexity
Objects reduce complexity by reducing what you must know to use a component or
system:
Objects provide an interface that hides implementation details.
1-8

Why Use Object-Oriented Design

Objects enforce rules that control how objects interact.

To illustrate these advantages, consider the implementation of a data structure called a
doubly linked list. See Class to Implement Linked Lists on page 3-36 for the actual
implementation.
Here is a diagram of a three-element list:

n1

n2

Properties
Next
Prev

n3

Properties
Next
Prev

n2.Prev

Properties
Next
Prev

n2

n2.Next

To add a node to the list, disconnect the existing nodes in the list, insert the new node,
and reconnect the nodes appropriately. Here are the basic steps:
First disconnect the nodes:
1

Unlink n2.Prev from n1

Unlink n1.Next from n2

Now create the new node, connect it, and renumber the original nodes:
1

Link new.Prev to n1

Link new.Next to n3 (was n2)

Link n1.Next to new (will be n2)

Link n3.Prev to new (will be n2)

n1

Properties
Next
Prev

n2
Properties
Next
Prev

n3
Properties
Next
Prev

n4
Properties
Next
Prev

Newly inserted node

1-9

Using Object-Oriented Design in MATLAB

The details of how methods perform these steps are encapsulated in the class design.
Each node object contains the functionality to insert itself into or remove itself from the
list.
For example, in this class, every node object has an insertAfter method. To add a node
to a list, create the node object and then call its insertAfter method:
nnew = NodeConstructor;
nnew.insertAfter(n1)

Because the node class defines the code that implements these operations, this code is:
Implemented in an optimal way by the class author
Always up to date with the current version of the class
Properly tested
Can automatically update old-versions of the objects when they are loaded from MATfiles.
The object methods enforce the rules for how the nodes interact. This design removes
the responsibility for enforcing rules from the applications that use the objects. It also
means that the application is less likely to generate errors in its own implementation of
the process.
Fostering Modularity
As you decompose a system into objects (car > engine > fuel system > oxygen sensor),
you form modules around natural boundaries. Classes provide three levels of control over
code modularity:
Public Any code can access this particular property or call this method.
Protected Only the object's own methods and those of the object's whose class has
been derived from this object's class can access this property or call this method.
Private Only the object's own methods can access this property or call this method.
Overloaded Functions and Operators
When you define a class, you can overload existing MATLAB functions to work with your
new object. For example, the MATLAB serial port class overloads the fread function to
read data from the device connected to the port represented by this object. You can define
various operations, such as equality (eq) or addition (plus), for a class you have defined
to represent your data.
1-10

Why Use Object-Oriented Design

More About

Role of Classes in MATLAB on page 3-2

1-11

Using Object-Oriented Design in MATLAB

Using Handles
In this section...
What Is a Handle? on page 1-12
Copies of Handles on page 1-12
Handle Objects Modified in Functions on page 1-13
Determine If an Object Is a Handle on page 1-15
Deleted Handle Objects on page 1-15
This topic describes the behavior of handle objects for users of handle objects. For
information on defining handle classes, see Handle Classes.

What Is a Handle?
Certain kinds of MATLAB objects are handles. When a variable holds a handle, it
actually holds a reference to the object.
Handle objects enable more than one variable to refer to the same object. Handle-object
behavior affects what happens when you copy handle objects and when you pass them to
functions.

Copies of Handles
All copies of a handle object variable refer to the same underlying object. This reference
behavior means that if h identifies a handle object, then,
h2 = h;

Creates another variable, h2, that refers to the same object as h.

For example, the MATLAB audioplayer function creates a handle object that contains
the audio source data to reproduce a specific sound segment. The variable returned by
the audioplayer function identifies the audio data and enables you to access object
functions to play the audio.
MATLAB software includes audio data that you can load and use to create an
audioplayer object. This sample load audio data, creates the audio player, and plays
the audio:
1-12

Using Handles

load gong Fs y
gongSound = audioplayer(y,Fs);
play(gongSound)

Suppose that you copy the gongSound object handle to another variable (gongSound2):
gongSound2 = gongSound;

The variables gongSound and gongSound2 are copies of the same handle and, therefore,
refer to the same audio source. Access the audioplayer information using either
variable.
For example, set the sample rate for the gong audio source by assigning a new value to
the SampleRate property. First get the current sample rate and then set a new sample
rate:
sr = gongSound.SampleRate
sr =
8192
gongSound.SampleRate = sr*2;

You can use gongSound2 to access the same audio source:

gongSound2.SampleRate
ans =
16384

Play the gong sound with the new sample rate:

play(gongSound2)

Handle Objects Modified in Functions

When you pass an argument to a function, the function copies the variable from the
workspace in which you call the function into the parameter variable in the functions
workspace.
Passing a nonhandle variable to a function does not affect the original variable that is
in the callers workspace. For example, myFunc modifies a local variable called var, but
when the function ends, the local variable var no longer exists:
1-13

Using Object-Oriented Design in MATLAB

function myFunc(var)
var = var + 1;
end

Define a variable and pass it to myfunc:

x = 12;
myFunc(x)

The value of x has not changed after executing myFunc(x):

x
x =
12

The myFunc function can return the modified value, which you could assign to the same
variable name (x) or another variable.
function out = myFunc(var)
out = var + 1;
end

Modify a value in myfunc:

x = 12;
x = myFunc(x)
x =
13

When the argument is a handle variable, the function copies only the handle, not the
object identified by that handle. Both handles (original and local copy) refer to the same
object.
When the function modifies the data referred to by the object handle, those changes are
accessible from the handle variable in the calling workspace without the need to return
the modified object.
For example, the modifySampleRate function changes the audioplayer sample rate:
function modifySampleRate(audioObj,sr)
audioObj.SampleRate = sr;
end

1-14

Using Handles

Create an audioplayer object and pass it to the modifySampleRate function:

load gong Fs y
gongSound = audioplayer(y,Fs);
gongSound.SampleRate
ans =
8192
modifySampleRate(gongSound,16384)
gongSound.SampleRate
ans =
16384

The modifySampleRate function does not need to return a modified gongSound object
because audioplayer objects are handle objects.

Determine If an Object Is a Handle

Handle objects are members of the handle class. Therefore, you can always identify an
object as a handle using the isa function. isa returns logical true (1) when testing for a
handle variable:
load gong Fs y
gongSound = audioplayer(y,Fs);
isa(gongSound,'handle')
ans =
1

To determine if a variable is a valid handle object, use isa and isvalid:

if isa(gongSound,'handle') && isvalid(gongSound)
...
end

Deleted Handle Objects

When a handle object has been deleted, the handle variables that referenced the object
can still exist. These variables become invalid because the object they referred to no
1-15

Using Object-Oriented Design in MATLAB

longer exists. Calling delete on the object removes the object, but does not clear handle
variables.
For example, create an audioplayer object:
load gong Fs y
gongSound = audioplayer(y,Fs);

The output argument, gongSound, is a handle variable. Calling delete deletes the
object along with the audio source information it contains:
delete(gongSound)

However, the handle variable still exists:

gongSound
gongSound =
handle to deleted audioplayer

The whos command shows gongSound as an audioplayer object:

whos
Name
Fs
gongSound
y

Size
1x1
1x1
42028x1

Bytes
8
104
336224

Class

Attributes

double
audioplayer
double

Note: The value for Bytes returned by the whos command does not include all the data
referenced by a handle because many variables can reference the same data.
The handle gongSound no longer refers to a valid object, as shown by the isvalid handle
method:
isvalid(gongSound)
ans =
0

1-16

Using Handles

Calling delete on a deleted handle does nothing and does not cause an error. You can
pass an array containing both valid and invalid handles to delete. MATLAB deletes the
valid handles, but does not issue an error when encountering handles that are already
invalid.
You cannot access properties with the invalid handle variable:
gongSound.SampleRate
Invalid or deleted object.

Functions and methods that access object properties cause an error:

play(gongSound)
Invalid or deleted object.

To remove the variable, gongSound, use clear:

clear gongSound
whos
Name
Fs
y

Size
1x1
42028x1

Bytes
8
336224

Class

Attributes

double
double

More About

Handle Class Destructor on page 7-16

Comparison of Handle and Value Classes on page 7-2

1-17

2
Basic Example

Basic Example

A Simple Class
In this section...
Define a Simple Class on page 2-2
Create Object on page 2-3
Access Properties on page 2-3
Call Methods on page 2-3
Add Constructor on page 2-4
Vectorize Methods on page 2-5
Overload Functions on page 2-6
BasicClass Code Listing on page 2-6

Define a Simple Class

The basic purpose of a class is to define an object that encapsulates data and the
operations performed on that data. For example, BasicClass defines a property and two
methods that operate on the data in that property:
Value Property that contains the data stored in an object of the class
roundOff Method that rounds the value of the property to two decimal places
multiplyBy Method that multiplies the value of the property by the specified
number
Here is the definition of BasicClass:
classdef BasicClass
properties
Value
end
methods
function r = roundOff(obj)
r = round([obj.Value],2);
end
function r = multiplyBy(obj,n)
r = [obj.Value] * n;
end
end

2-2

A Simple Class

end

For a summary of class syntax, see classdef.

To use the class, save the class definition in a .m file, create an object of the class, assign
the class data, and call operations on that data.

Create Object
Create an object of the class using the class name:
a = BasicClass
a =
BasicClass with properties:
Value: []

Initially, the property value is empty.

Access Properties
Assign a value to the Value property using the object variable and a dot before the
property name:
a.Value = pi/3;

To access a property value, use dot notation without the assignment:

a.Value
ans =
1.0472

For information on class properties, see Property Syntax on page 8-4

Call Methods
Call the roundOff method on object a:
roundOff(a)

2-3

Basic Example

ans =
1.0500

Pass the object as the first argument to a method that takes multiple arguments:
multiplyBy(a,3)
ans =
3.1416

You can also call a method using dot notation:

a.multiplyBy(3)

It is not necessary to pass the object explicitly as an argument when using dot notation.
The notation uses the object to the left of the method name.
For information on class methods, see Ordinary Methods on page 9-7

Add Constructor
Classes can define a special method to create objects, called a constructor. Constructor
methods enable you pass arguments to the constructor and to validate and assign
property values. Here is a constructor for the BasicClass class:
methods
function obj = BasicClass(val)
if nargin > 0
if isnumeric(val)
obj.Value = val;
else
error('Value must be numeric')
end
end
end
end

By adding this constructor to the class definition, you can create an object in one step:
a = BasicClass(pi/3)
a =

2-4

A Simple Class

BasicClass with properties:

Value: 1.0472

This constructor also performs type checking on the input argument. For example:
a = BasicClass('A character array')
Error using BasicClass (line 11)
Value must be numeric

For information on constructors, see Class Constructor Methods on page 9-20

Vectorize Methods
MATLAB enables you to vectorize operations. For example, you can add a number to a
vector:
[1 2 3] + 2
ans =
3

MATLAB adds the number 2 to each of the elements in the array [1 2 3]. To vectorize
the arithmetic operator methods, enclose the obj.Value property reference in brackets,
where obj is an object array.
[obj.Value] + 2

This syntax enables the method to work with arrays of object. For example, given objects
a1, a2, and a3:
[a1.Value,a2.Value,a3.Value] + 2

By using vector notation, a can be an array:

a(1) = BasicClass(2.7984);
a(2) = BasicClass(sin(pi/3));
a(3) = BasicClass(7);
roundOff(a)
ans =

2-5

Basic Example

2.8000

0.8700

7.0000

Overload Functions
Classes can implement existing functionality, such as addition, by defining a method
with the same name as the existing MATLAB function. For example, suppose you want
to add two BasicClass objects. It makes sense to add the values of the ObjectValue
properties of each object.
Here is an overload of the MATLAB plus function. It defines addition for this class as
adding the property values:
method
function r = plus(o1,o2)
r = [o1.Value] + [o2.Value];
end
end

By implementing a method called plus, you can use the + operator with objects of
BasicClass.
a = BasicClass(pi/3);
b = BasicClass(pi/4);
a + b
ans =
1.8326

Related Information
For information on overloading functions, see Overload Functions in Class Definitions
on page 9-30.
For information on overloading operators, see Operator Overloading on page 17-48.

BasicClass Code Listing

Here is the BasicClass definition after adding the features discussed in this topic:
classdef BasicClass
properties

2-6

A Simple Class

Value
end
methods
function obj = BasicClass(val)
if nargin == 1
if isnumeric(val)
obj.Value = val;
else
error('Value must be numeric')
end
end
end
function r = roundOff(obj)
r = round([obj.Value],2);
end
function r = multiplyBy(obj,n)
r = [obj.Value] * n;
end
function r = plus(o1,o2)
r = o1.Value + o2.Value;
end
end
end

2-7

3
MATLAB Classes Overview
Role of Classes in MATLAB on page 3-2
Developing Classes Typical Workflow on page 3-8
Class to Manage Writable Files on page 3-19
Class to Represent Structured Data on page 3-24
Class to Implement Linked Lists on page 3-36
Class for Graphing Functions on page 3-53

MATLAB Classes Overview

Role of Classes in MATLAB

In this section...
Classes on page 3-2
Some Basic Relationships on page 3-4

Classes
In the MATLAB language, every value is assigned to a class. For example, creating a
variable with an assignment statement constructs a variable of the appropriate class:
a = 7;
b = 'some text';
s.Name = 'Nancy';
s.Age = 64;
whos
whos
Name
a
b
s

Size
1x1
1x9
1x1

Bytes
8
18
370

Class

Attributes

double
char
struct

Basic commands like whos display the class of each value in the workspace. This
information helps MATLAB users recognize that some values are characters and display
as text while other values are double precision numbers, and so on. Some variables can
contain different classes of values like structures.
Predefined Classes
MATLAB defines fundamental class that comprise the basic types used by the language.
For more information, see Fundamental MATLAB Classes.
User-Defined Classes
You can create your own MATLAB classes. For example, you could define a class to
represent polynomials. This class could define the operations typically associated with
MATLAB classes, like addition, subtraction, indexing, displaying in the command
window, and so on. These operations would need to perform the equivalent of polynomial
addition, polynomial subtraction, and so on. For example, when you add two polynomial
objects:
3-2

Role of Classes in MATLAB

p1 + p2

the plus operation must be able to add polynomial objects because the polynomial class
defines this operation.
When you define a class, you can overload special MATLAB functions (such as plus.m
for the addition operator). MATLAB calls these methods when users apply those
operations to objects of your class.
See Class Design for Polynomials on page 19-2 for an example that creates just
such a class.
MATLAB Classes Key Terms
MATLAB classes use the following words to describe different parts of a class definition
and related concepts.
Class definition Description of what is common to every instance of a class.
Properties Data storage for class instances
Methods Special functions that implement operations that are usually performed
only on instances of the class
Events Messages that are defined by classes and broadcast by class instances when
some specific action occurs
Attributes Values that modify the behavior of properties, methods, events, and
classes
Listeners Objects that respond to a specific event by executing a callback function
when the event notice is broadcast
Objects Instances of classes, which contain actual data values stored in the objects'
properties
Subclasses Classes that are derived from other classes and that inherit the
methods, properties, and events from those classes (subclasses facilitate the reuse of
code defined in the superclass from which they are derived).
Superclasses Classes that are used as a basis for the creation of more specifically
defined classes (i.e., subclasses).
Packages Folders that define a scope for class and function naming
These are general descriptions of these components and concepts. This documentation
describes all of these components in detail.
3-3

MATLAB Classes Overview

Some Basic Relationships

This section discusses some of the basic concepts used by MATLAB classes.
Classes
A class is a definition that specifies certain characteristics that all instances of the class
share. These characteristics are determined by the properties, methods, and events that
define the class and the values of attributes that modify the behavior of each of these
class components. Class definitions describe how objects of the class are created and
destroyed, what data the objects contain, and how you can manipulate this data.
Class Hierarchies
It sometimes makes sense to define a new class in terms of existing classes. This
enables you to reuse the designs and techniques in a new class that represents a similar
entity. You accomplish this reuse by creating a subclass. A subclass defines objects
that are a subset of those defined by the superclass. A subclass is more specific than its
superclass and might add new properties, methods, and events to those inherited from
the superclass.
Mathematical sets can help illustrate the relationships among classes. In the following
diagram, the set of Positive Integers is a subset of the set of Integers and a subset of
Positive numbers. All three sets are subsets of Real numbers, which is a subset of All
Numbers.
The definition of Positive Integers requires the additional specification that members of
the set be greater than zero. Positive Integers combine the definitions from both Integers
and Positives. The resulting subset is more specific, and therefore more narrowly defined,
than the supersets, but still shares all the characteristics that define the supersets.

3-4

Role of Classes in MATLAB

All
Numbers
Integers
Positive
Integers
Positives
Reals

The is a relationship is a good way to determine if it is appropriate to define a

particular subset in terms of existing supersets. For example, each of the following
statements makes senses:
A Positive Integer is an Integer
A Positive Integer is a Positive number
If the is a relationship holds, then it is likely you can define a new class from a class or
classes that represent some more general case.
Reusing Solutions
Classes are usually organized into taxonomies to foster code reuse. For example, if
you define a class to implement an interface to the serial port of a computer, it would
probably be very similar to a class designed to implement an interface to the parallel
port. To reuse code, you could define a superclass that contains everything that is
common to the two types of ports, and then derive subclasses from the superclass in
which you implement only what is unique to each specific port. Then the subclasses
would inherit all of the common functionality from the superclass.
3-5

MATLAB Classes Overview

Objects
A class is like a template for the creation of a specific instance of the class. This instance
or object contains actual data for a particular entity that is represented by the class. For
example, an instance of a bank account class is an object that represents a specific bank
account, with an actual account number and an actual balance. This object has built into
it the ability to perform operations defined by the class, such as making deposits to and
withdrawals from the account balance.
Objects are not just passive data containers. Objects actively manage the data contained
by allowing only certain operations to be performed, by hiding data that does not need
to be public, and by preventing external clients from misusing data by performing
operations for which the object was not designed. Objects even control what happens
when they are destroyed.
Encapsulating Information
An important aspect of objects is that you can write software that accesses the
information stored in the object via its properties and methods without knowing
anything about how that information is stored, or even whether it is stored or calculated
when queried. The object isolates code that accesses the object from the internal
implementation of methods and properties. You can define classes that hide both data
and operations from any methods that are not part of the class. You can then implement
whatever interface is most appropriate for the intended use.

References
[1] Shalloway, A., J. R. Trott, Design Patterns Explained A New Perspective on ObjectOriented Design.. Boston, MA: Addison-Wesley 2002.
[2] Gamma, E., R. Helm, R. Johnson, J. Vlissides, Design Patterns Elements of Reusable
Object-Oriented Software. Boston, MA: Addison-Wesley 1995.
[3] Freeman, E., Elisabeth Freeman, Kathy Sierra, Bert Bates, Head First Design
Patterns. Sebastopol, CA 2004.

Related Examples

3-6

A Simple Class on page 2-2

Developing Classes Typical Workflow on page 3-8

Role of Classes in MATLAB

Class to Represent Structured Data on page 3-24

Class to Manage Writable Files on page 3-19

Class to Implement Linked Lists on page 3-36

External Websites

Object Oriented Programming

3-7

MATLAB Classes Overview

Developing Classes Typical Workflow

In this section...
Formulating a Class on page 3-8
Specifying Class Components on page 3-9
BankAccount Class Implementation on page 3-10
Formulating the AccountManager Class on page 3-14
Implementing the AccountManager Class on page 3-15
AccountManager Class Synopsis on page 3-15
Using BankAccount Objects on page 3-16

Formulating a Class
This example discusses how to approach the design and implementation of a class. The
objective of this class is to represent a familiar concept (a bank account). However, you
can apply the same approach to most class designs.
To design a class that represents a bank account, first determine the elements of data
and the operations that form your abstraction of a bank account. For example, a bank
account has:
An account number
An account balance
A status (open, closed, etc.)
You must perform certain operations on a bank account:
Create an object for each bank account
Deposit money
Withdraw money
Generate a statement
Save and load the BankAccount object
If the balance is too low and you attempt to withdraw money, the bank account
broadcasts a notice. When this event occurs, the bank account broadcasts a notice to
other entities that are designed to listen for these notices. In this example, a simplified
version of an account manager program performs this task.
3-8

Developing Classes Typical Workflow

In this example, an account manager program determines the status of all bank
accounts. This program monitors the account balance and assigns one of three values:
open Account balance is a positive value
overdrawn Account balance is overdrawn, but by $200 or less.
closed Account balance is overdrawn by more than $200.
These features define the requirements of the BankAccount and AccountManager
classes. Include only what functionality is required to meet your specific objectives.
Support special types of accounts by subclassing BankAccount and adding more specific
features to the subclasses. Extend the AccountManager as required to support new
account types.

Specifying Class Components

Classes store data in properties, implement operations with methods, and support
notifications with events and listeners. Here is how the BankAccount and
AccountManager classes define these components.
Class Data
The class defines these properties to store the account number, account balance, and the
account status:
AccountNumber A property to store the number identifying the specific account.
MATLAB assigns a value to this property when you create an instance of the class.
Only BankAccount class methods can set this property. The SetAccess attribute is
private.
AccountBalance A property to store the current balance of the account. The
class operation of depositing and withdrawing money assigns values to this property.
Only BankAccount class methods can set this property. The SetAccess attribute is
private.
AccountStatus The BankAccount class defines a default value for this property.
The AccountManager class methods change this value whenever the value of
the AccountBalance falls below 0. The Access attribute specifies that only the
AccountManager and BankAccount classes have access to this property.
AccountListener Storage for the InsufficentFunds event listener. Saving
a BankAccount object does not save this property because you must recreate the
listener when loading the object.
3-9

MATLAB Classes Overview

Class Operations
These methods implement the operations defined in the class formulation:
BankAccount Accepts an account number and an initial balance to create an
object that represents an account.
deposit Updates the AccountBalance property when a deposit transaction
occurs
withdraw Updates the AccountBalance property when a withdrawal transaction
occurs
getStatement Displays information about the account
loadobj Recreates the account manager listener when you load the object from a
MAT-file.
Class Events
The account manager program changes the status of bank accounts that have
negative balances. To implement this action, the BankAccount class triggers an event
when a withdrawal results in a negative balance. Therefore, the triggering of the
InsufficientsFunds event occurs from within the withdraw method.
To define an event, specify a name within an events block. Trigger the event by a call
to the notify handle class method. Because InsufficientsFunds is not a predefined
event, you can name it with any char vector and trigger it with any action.

BankAccount Class Implementation

It is important to ensure that there is only one set of data associated with any object of
a BankAccount class. You would not want independent copies of the object that could
have, for example, different values for the account balance. Therefore, implement the
BankAccount class as a handle class. All copies of a given handle object refer to the
same data.
BankAccount Class Synopsis
BankAccount Class
classdef BankAccount < handle

3-10

Discussion
Handle class because there should
be only one copy of any instance of
BankAccount.Comparison of Handle
and Value Classes on page 7-2

Developing Classes Typical Workflow

BankAccount Class

Discussion

properties (Access = ?AccountManager)AccountStatus contains the status

AccountStatus = 'open';
of the account determined by the
end
current balance. Access is limited to the

BankAccount and AccountManager

classes. Control Access to Class
Members on page 12-25

properties (SetAccess = private)

AccountNumber
AccountBalance
end
properties (Transient)
AccountListener
end

AccountStatus property access by

AccountManager class methods.
AccountNumber and AccountBalance
properties have private set access.
AccountListener property is
transient so the listener handle is not
saved.
See Specify Property Attributes on page
8-6.

events
InsufficientFunds
end

Class defines event called

InsufficentFunds. withdraw method
triggers event when account balance
becomes negative.
For information on events and listeners,
see Events .

methods

Block of ordinary methods. See Methods

and Functions on page 5-15 for
syntax.

function BA = BankAccount(AccountNumber,InitialBalance)
Constructor initializes property values
BA.AccountNumber = AccountNumber;
with input arguments.
BA.AccountBalance = InitialBalance;
BA.AccountListener = AccountManager.addAccount(BA);
end
AccountManager.addAccount is

static method of AccountManager class.

Creates listener for InsufficientFunds
event and stores listener handle in
AccountListener property.

3-11

MATLAB Classes Overview

BankAccount Class

Discussion

function deposit(BA,amt)
deposit adjusts value of
BA.AccountBalance = BA.AccountBalance + amt;
AccountBalance property.
if BA.AccountBalance > 0
BA.AccountStatus = 'open';
end
If AccountStatus is closed
end

and subsequent deposit brings

AccountBalance into positive range,
then AccountStatus is reset to open.

function withdraw(BA,amt)
Updates AccountBalance property. If
if (strcmp(BA.AccountStatus,'closed')&& ...
value of account balance is negative as
BA.AccountBalance < 0)
disp(['Account ',num2str(BA.AccountNumber),...
result of the withdrawal, notify triggers
' has been closed.'])
InsufficentFunds event.
return
end
newbal = BA.AccountBalance - amt;
For more information on listeners, see
BA.AccountBalance = newbal;
Events and Listeners Syntax on page
if newbal < 0
11-21.
notify(BA,'InsufficientFunds')
end
end
function getStatement(BA)
Display selected
disp('-------------------------')
account.
disp(['Account: ',num2str(BA.AccountNumber)])
ab = sprintf('%0.2f',BA.AccountBalance);
disp(['CurrentBalance: ',ab])
disp(['Account Status: ',BA.AccountStatus])
disp('-------------------------')
end
end
methods (Static)

information about the

End of ordinary methods block.

Beginning of static methods block. See
Static Methods on page 9-28

function obj = loadobj(s)

loadobj method:
if isstruct(s)
accNum = s.AccountNumber;
If the load operation fails, create the
initBal = s.AccountBalance;
obj = BankAccount(accNum,initBal);
object from a struct.
else
obj.AccountListener = AccountManager.addAccount(s);
Recreates the listener using the newly
end
created BankAccount object as the
end

source.

For more information on saving and

loading objects, see Save and Load
Process for Objects on page 13-2

3-12

Developing Classes Typical Workflow

BankAccount Class
end
end

Discussion
End of static methods block
End of classdef

Expand for Class Code

classdef BankAccount < handle
properties (Access = ?AccountManager)
AccountStatus = 'open';
end
properties (SetAccess = private)
AccountNumber
AccountBalance
end
properties (Transient)
AccountListener
end
events
InsufficientFunds
end
methods
function BA = BankAccount(accNum,initBal)
BA.AccountNumber = accNum;
BA.AccountBalance = initBal;
BA.AccountListener = AccountManager.addAccount(BA);
end
function deposit(BA,amt)
BA.AccountBalance = BA.AccountBalance + amt;
if BA.AccountBalance > 0
BA.AccountStatus = 'open';
end
end
function withdraw(BA,amt)
if (strcmp(BA.AccountStatus,'closed')&& BA.AccountBalance <= 0)
disp(['Account ',num2str(BA.AccountNumber),' has been closed.'])
return
end
newbal = BA.AccountBalance - amt;
BA.AccountBalance = newbal;
if newbal < 0
notify(BA,'InsufficientFunds')
end
end

3-13

MATLAB Classes Overview

function getStatement(BA)
disp('-------------------------')
disp(['Account: ',num2str(BA.AccountNumber)])
ab = sprintf('%0.2f',BA.AccountBalance);
disp(['CurrentBalance: ',ab])
disp(['Account Status: ',BA.AccountStatus])
disp('-------------------------')
end
end
methods (Static)
function obj = loadobj(s)
if isstruct(s)
accNum = s.AccountNumber;
initBal = s.AccountBalance;
obj = BankAccount(accNum,initBal);
else
obj.AccountListener = AccountManager.addAccount(s);
end
end
end
end

Formulating the AccountManager Class

The purpose of the AccountManager class is to provide services to accounts. For the
BankAccount class, the AccountManager class listens for withdrawals that cause the
balance to drop into the negative range. When the BankAccount object triggers the
InsufficientsFunds event, the AccountManager resets the account status.
The AccountManager class stores no data so it does not need properties. The
BankAccount object stores the handle of the listener object.
The AccountManager performs two operations:
Assign a status to each account as a result of a withdrawal
Adds an account to the system by monitoring account balances.
Class Components
The AccountManager class implements two methods:
assignStatus Method that assigns a status to a BankAccount object. Serves as
the listener callback.
3-14

Developing Classes Typical Workflow

addAccount Method that creates the InsufficientFunds listener.

Implementing the AccountManager Class

The AccountManager class implements both methods as static because there is no need
for an AccountManager object. These methods operate on BankAccount objects.
The AccountManager is not intended to be instantiated. Separating the functionality of
the AccountManager class from the BankAccount class provides greater flexibility and
extensibility. For example, doing so enables you to:
Extend the AccountManager class to support other types of accounts while keeping
the individual account classes simple and specialized.
Change the criteria for the account status without affecting the compatibility of saved
and loaded BankAccount objects.
Develop an Account superclass that factors out what is common to all accounts
without requiring each subclass to implement the account management functionality

AccountManager Class Synopsis

AccountManager Class
classdef AccountManager

methods (Static)

function assignStatus(BA)
if BA.AccountBalance < 0
if BA.AccountBalance < -200
BA.AccountStatus = 'closed';
else
BA.AccountStatus = 'overdrawn';
end
end
end

Discussion
This class defines the
InsufficentFunds event listener and
the listener callback.
There is no need to create an instance
of this class so the methods defined are
static. See Static Methods on page
9-28.
The assignStatus method is the
callback for the InsufficentFunds
event listener. It determines the value of
a BankAccount object AccountStatus
property based on the value of the
AccountBalance property.
The BankAccount class constructor
calls the AccountManager addAccount
method to create and store this listener.
3-15

MATLAB Classes Overview

AccountManager Class

Discussion

function lh = addAccount(BA)
addAccount creates the listener for
lh = addlistener(BA, 'InsufficientFunds', ...
the InsufficentFunds event that the
@(src, ~)AccountManager.assignStatus(src));
end
BankAccount class defines.

See Control Listener Lifecycle on page

11-27
end
end

end statements for methods and for

classdef.

Expand for Class Code

classdef AccountManager
methods (Static)
function assignStatus(BA)
if BA.AccountBalance < 0
if BA.AccountBalance < -200
BA.AccountStatus = 'closed';
else
BA.AccountStatus = 'overdrawn';
end
end
end
function lh = addAccount(BA)
lh = addlistener(BA, 'InsufficientFunds', ...
@(src, ~)AccountManager.assignStatus(src));
end
end
end

Using BankAccount Objects

The BankAccount class, while overly simple, demonstrates how MATLAB classes
behave. For example, create a BankAccount object with an account number and an
initial deposit of $500:
BA = BankAccount(1234567,500)
BA =
BankAccount with properties:

3-16

Developing Classes Typical Workflow

AccountNumber: 1234567
AccountBalance: 500
AccountListener: [1x1 event.listener]

Use the getStatement method to check the status:

getStatement(BA)
------------------------Account: 1234567
CurrentBalance: 500.00
Account Status: open
-------------------------

Make a withdrawal of $600, which results in a negative account balance:

withdraw(BA,600)
getStatement(BA)
------------------------Account: 1234567
CurrentBalance: -100.00
Account Status: overdrawn
-------------------------

The $600 withdrawal triggered the InsufficientsFunds event. The current criteria
defined by the AccountManager class results in a status of overdrawn.
Make another withdrawal of $200:
withdraw(BA,200)
getStatement(BA)
------------------------Account: 1234567
CurrentBalance: -300.00
Account Status: closed
-------------------------

Now the AccountStatus has been set to closed by the listener and further attempts to
make withdrawals are blocked without triggering the event:
withdraw(BA,100)
Account 1234567 has been closed.

3-17

MATLAB Classes Overview

If the AccountBalance is returned to a positive value by a deposit, then the

AccountStatus is returned to open and withdrawals are allowed again:
deposit(BA,700)
getStatement(BA)
------------------------Account: 1234567
CurrentBalance: 400.00
Account Status: open
-------------------------

3-18

Class to Manage Writable Files

Class to Manage Writable Files

In this section...
Flexible Workflow on page 3-19
Performing a Task with an Object on page 3-19
Defining the Filewriter Class on page 3-19
Using Filewriter Objects on page 3-21

Flexible Workflow
The MATLAB language does not require you to define classes for all the code you write.
You can use objects along with ordinary functions. This section illustrates the use of an
object that implements the basic task of writing text to a file.

Performing a Task with an Object

One of the advantages of an object instead of writing a function to perform a task is that
objects can encapsulate related data. For example, consider the task of writing data to a
file. It involves the following steps:
Opening a file for writing and saving the file identifier
Using the file identifier to write data to the file
Using the file identifier to close the file

Defining the Filewriter Class

This class writes text to a file. The advantage of using a class for this purpose is to:
Hide private data The caller does not need to manage the file identifier.
Ensure only one file identifier is in use at any time Copies of handle objects
reference the same file identifier as the original.
Provide automatic file closing when the object is deleted the object's delete
method takes care of cleanup without needing to be called explicitly.
The Filewriter class derives from the handle class. Therefore, a Filewriter object
is a handle object. All copies of handle objects reference the same internal data. There is
only one file identifier in use, even if you make copies of the object.
3-19

MATLAB Classes Overview

Also, handle classes define a delete method, which is called automatically when
MATLAB destroys a handle object. This example overrides the delete method. This
method closes the file before deleting the object and losing file identifier.
The Filewriter Class
classdef Filewriter < handle
properties (Access = private)
FileID
end
methods
function obj = Filewriter(filename)
obj.FileID = fopen(filename,'a');
end
function writeToFile(obj,text_str)
fprintf(obj.FileID,'%s\n',text_str);
end
function delete(obj)
fclose(obj.FileID);
end
end
end

Filewriter Class Synopsis

Filewriter Class
classdef Filewriter < handle

Discussion
This class derives from handle to provide
a single reference to the file identifier and
use the class destructor to close the file.
For general information on class
destructors, see Handle Class
Destructor on page 7-16

properties (Access = private)

FileID
end

Only Filewriter class methods can

access file identifier.
Property Attributes on page 8-7

methods

3-20

For method syntax, see Methods and

Functions on page 5-15

Class to Manage Writable Files

Filewriter Class
function obj = Filewriter(filename)
if nargin < 1
error('You must specify a filename')
else
obj.FileID = fopen(filename,'a');
end
end

Discussion
Class constructor opens file for writing
and saves file identifier in private
property. See fopen and Rules for
Constructors on page 9-20

function writeToFile(obj,text_str)
fprintf(obj.FileID,'%s\n',text_str);
end

Write text to open file. See ferror and

fseek.

function delete(obj)
fclose(obj.FileID);
end

delete method closes file before

destroying Filewriter object.
See Handle Class Destructor on page
7-16

end
end

end statements for methods and for

classdef.

Using Filewriter Objects

Provides a file name to create a Filewriter object. Use the writeToFile method to
write text to the file. The following statements create a file named mynewclass.m and
write one line to it. The clear all command deletes the Filewriter object. Clearing
the object variable calls its delete method, which closes the file.
fw = Filewriter('MyNewClass.m');
writeToFile(fw,'classdef < handle')
clear fw
type MyNewClass
classdef MyNewClass < handle

Filewriter objects provide functionality that you can use from functions and
within other classes. You can create an ordinary function that uses this object, as the
writeClassFile function does below.
This example creates only one simple class template, but another version could accept a
cell array of attribute name/value pairs, method names, and so on.
function writeClassFile(classname,superclass)
fw = Filewriter([classname '.m']);

3-21

MATLAB Classes Overview

if nargin > 1
writeToFile(fw,['classdef ' classname ' < ' superclass])
else
writeToFile(fw,['classdef ' classname])
end
writeToFile(fw,'
properties ')
writeToFile(fw,' ')
writeToFile(fw,'
end')
writeToFile(fw,' ')
writeToFile(fw,'
methods ')
writeToFile(fw,'
function')
writeToFile(fw,' ')
writeToFile(fw,'
end')
writeToFile(fw,'
end')
writeToFile(fw,'end')
end

To create a class file template, call writeClassFile with the name of the new class and
its superclass. Use the type command to display the contents of the file:
writeClassFile('MyNewClass','handle')
edit MyNewClass

Here is the template file in the editor ready to add code:

3-22

Class to Manage Writable Files

See Also

fclose | fopen | fprintf

More About

Handle Class Destructor on page 7-16

3-23

MATLAB Classes Overview

Class to Represent Structured Data

In this section...
Objects As Data Structures on page 3-24
Structure of the Data on page 3-24
The TensileData Class on page 3-25
Create an Instance and Assign Data on page 3-25
Restrict Properties to Specific Values on page 3-26
Simplifying the Interface with a Constructor on page 3-27
Calculate Data on Demand on page 3-28
Displaying TensileData Objects on page 3-29
Method to Plot Stress vs. Strain on page 3-30
TensileData Class Synopsis on page 3-31

Objects As Data Structures

This example defines a class for storing data with a specific structure. Using a consistent
structure for data storage makes it easier to create functions that operate on the data.
A MATLAB struct with field names describing the particular data element is a useful
way to organize data. However, a class can define both the data storage (properties) and
operations that you can perform on that data (methods). This example illustrates these
advantages.
Background for the Example
For this example, the data represents tensile stress/strain measurements. These data
are used to calculate the elastic modulus of various materials. In simple terms, stress is
the force applied to a material and strain is the resulting deformation. Their ratio defines
a characteristic of the material. While this is an over simplification of the process, it
suffices for this example.

Structure of the Data

This table describes the structure of the data.
3-24

Class to Represent Structured Data

Data

Description

Material

char vector identifying the type of material tested

SampleNumber

Number of a particular test sample

Stress

Vector of numbers representing the stress applied to

the sample during the test.

Strain

Vector of numbers representing the strain at the

corresponding values of the applied stress.

Modulus

Number defining an elastic modulus of the material

under test, which is calculated from the stress and
strain data

The TensileData Class

This example begins with a simple implementation of the class and builds on this
implementation to illustrate how features enhance the usefulness of the class.
The first version of the class provides only data storage. The class defines a property for
each of the required data elements.
classdef TensileData
properties
Material
SampleNumber
Stress
Strain
Modulus
end
end

Create an Instance and Assign Data

The following statements create a TensileData object and assign data to it:
td = TensileData;
td.Material = 'Carbon Steel';
td.SampleNumber = 001;
td.Stress = [2e4 4e4 6e4 8e4];
td.Strain = [.12 .20 .31 .40];
td.Modulus = mean(td.Stress./td.Strain);

3-25

MATLAB Classes Overview

Advantages of a Class vs. a Structure

Treat the TensileData object (td in the statements above) much as you would any
MATLAB structure. However, defining a specialized data structure as a class has
advantages over using a general-purpose data structure, like a MATLAB struct:
Users cannot accidentally misspell a field name without getting an error. For
example, typing the following:
td.Modulis = ...

would simply add a new field to a structure, but returns an error when td is an
instance of the TensileData class.
A class is easy to reuse. Once you have defined the class, you can easily extend it with
subclasses that add new properties.
A class is easy to identify. A class has a name so that you can identify objects with the
whos and class functions and the Workspace browser. The class name makes it easy
to refer to records with a meaningful name.
A class can validate individual field values when assigned, including class or value.
A class can restrict access to fields, for example, allowing a particular field to be read,
but not changed.

Restrict Properties to Specific Values

Restrict properties to specific values by defining a property set access method. MATLAB
calls the set access method whenever setting a value for a property.
Material Property Set Function
The Material property set method restricts the assignment of the property to one of the
following strings: aluminum, stainless steel, or carbon steel.
Add this function definition to the methods block.
classdef TensileData
properties
Material
SampleNumber
Stress
Strain

3-26

Class to Represent Structured Data

Modulus
end
methods
function obj = set.Material(obj,material)
if (strcmpi(material,'aluminum') ||...
strcmpi(material,'stainless steel') ||...
strcmpi(material,'carbon steel'))
obj.Material = material;
else
error('Invalid Material')
end
end
end
end

When there is an attempt to set the Material property, MATLAB calls the
set.Material method before setting the property value.
If the value matches the acceptable values, the function set the property to that value.
The code within set method can access the property directly to avoid calling the property
set method recursively.
For example:
td = TensileData;
td.Material = 'brass';
Error using TensileData/set.Material
Invalid Material

Simplifying the Interface with a Constructor

Simplify the interface to the TensileData class by adding a constructor that:
Enables you to pass the data as arguments to the constructor
Assigns values to properties
The constructor is a method having the same name as the class.
methods
function td = TensileData(material,samplenum,stress,strain)
if nargin > 0
td.Material = material;

3-27

MATLAB Classes Overview

td.SampleNumber = samplenum;
td.Stress = stress;
td.Strain = strain;
end
end
end

Create a TensileData object fully populated with data using the following statement:
td = TensileData('carbon steel',1,...
[2e4 4e4 6e4 8e4],...
[.12 .20 .31 .40]);

Calculate Data on Demand

If the value of a property depends on the values of other properties, define that property
using the Dependent attribute. MATLAB does not store the values of dependent
properties. The dependent property get method determines the property value when the
property is queried.
Calculating Modulus
TensileData objects do not store the value of the Modulus property. The constructor
does not have an input argument for the value of the Modulus property. The value of the
Modulus:
Is calculated from the Stress and Strain property values
Needs to change if the value of the Stress or Strain property changes
Therefore, it is better to calculate the value of the Modulus property only when its value
is requested. Use a property get access method to calculate the value of the Modulus.
Modulus Property Get Method
The Modulus property depends on Stress and Strain, so its Dependent attribute
is true. Place the Modulus property in a separate properties block and set the
Dependent attribute.
The get.Modulus method calculates and returns the value of the Modulus property.
properties (Dependent)

3-28

Class to Represent Structured Data

Modulus
end

Define the property get method in a methods block using only default attributes.
methods
function modulus = get.Modulus(obj)
ind = find(obj.Strain > 0);
modulus = mean(obj.Stress(ind)./obj.Strain(ind));
end
end

This method calculates the average ratio of stress to strain data after eliminating zeros
in the denominator data.
MATLAB calls the get.Modulus method when the property is queried. For example,
td = TensileData('carbon steel',1,...
[2e4 4e4 6e4 8e4],...
[.12 .20 .31 .40]);
td.Modulus
ans =
1.9005e+005

Modulus Property Set Method

To set the value of a Dependent property, the class must implement a property set
method. There is no need to allow explicit setting of the Modulus property. However, a
set method enables you to provide a customized error message. The Modulus set method
references the current property value and then returns an error:
methods
function obj = set.Modulus(obj,~)
fprintf('%s%d\n','Modulus is: ',obj.Modulus)
error('You cannot set the Modulus property');
end
end

Displaying TensileData Objects

The TensileData class overloads the disp method. This method controls object display
in the command window.
3-29

MATLAB Classes Overview

The disp method displays the value of the Material, SampleNumber, and Modulus
properties. It does not display the Stress and Strain property data. These properties
contain raw data that is not easily viewed in the command window.
The disp method uses fprintf to display formatted text in the command window:
methods
function disp(td)
fprintf(1,...
'Material: %s\nSample Number: %g\nModulus: %1.5g\n',...
td.Material,td.SampleNumber,td.Modulus);
end
end

Method to Plot Stress vs. Strain

It is useful to view a graph of the stress/strain data to determine the behavior of the
material over a range of applied tension. The TensileData class overloads the MATLAB
plot function.
The plot method creates a linear graph of the stress versus strain data and adds a title
and axis labels to produce a standardized graph for the tensile data records:
methods
function plot(td,varargin)
plot(td.Strain,td.Stress,varargin{:})
title(['Stress/Strain plot for Sample',...
num2str(td.SampleNumber)])
ylabel('Stress (psi)')
xlabel('Strain %')
end
end

The first argument to this method is a TensileData object, which contains the data.
The method passes a variable list of arguments (varargin) directly to the built-in plot
function. The TensileData plot method allows you to pass line specifier arguments or
property name/value pairs.
For example:
td = TensileData('carbon steel',1,...
[2e4 4e4 6e4 8e4],[.12 .20 .31 .40]);
plot(td,'-+b','LineWidth',2)

3-30

Class to Represent Structured Data

TensileData Class Synopsis

Example Code
classdef TensileData

properties
Material
SampleNumber
Stress
Strain
end

Discussion
Value class enables independent copies
of object. For more information, see
Comparison of Handle and Value
Classes on page 7-2
See Structure of the Data on page
3-24

3-31

MATLAB Classes Overview

Example Code
properties (Dependent)
Modulus
end

Discussion
Calculate Modulus when queried.
For information about this code, see
Calculate Data on Demand on page
3-28
For general information, see Access
Methods for Dependent Properties on
page 8-34

methods

For general information about methods,

see Ordinary Methods on page 9-7

function td = TensileData(material,samplenum,...
For information about this code, see
stress,strain)
Simplifying the Interface with a
if nargin > 0
td.Material = material;
Constructor on page 3-27
td.SampleNumber = samplenum;
td.Stress = stress;
For general information about
td.Strain = strain;
end
constructors, see Class Constructor
end
Methods on page 9-20
function obj = set.Material(obj,material)
Restrict possible values for Material
if (strcmpi(material,'aluminum') ||...
strcmpi(material,'stainless steel') ||...property.
strcmpi(material,'carbon steel'))
obj.Material = material;
For information about this code, see
else
Restrict Properties to Specific Values
error('Invalid Material')
end
page 3-26.
end

on

For general information about property

set methods, see Property Set Methods
on page 8-29.
function m = get.Modulus(obj)
ind = find(obj.Strain > 0);
m = mean(obj.Stress(ind)./obj.Strain(ind));
end

Calculate Modulus property when

queried.
For information about this code, see
Modulus Property Get Method on page
3-28.
For general information about property
get methods, see Property Get Methods
on page 8-32.

3-32

Class to Represent Structured Data

Example Code

Discussion

function obj = set.Modulus(obj,~)

Add set method for Dependent Modulus
fprintf('%s%d\n','Modulus is: ',obj.Modulus)
property. For information about this code,
error('You cannot set Modulus property);
end
see Modulus Property Set Method on

page 3-29

For general information about property

set methods, see Property Set Methods
on page 8-29.
function disp(td)
Overload disp method
sprintf(1,'Material: %s\nSample Number: %g\nModulus: %1.5g\n',...
properties.
td.Material,td.SampleNumber,td.Modulus)
end

to display certain

For information about this code, see

Displaying TensileData Objects on
page 3-29
For general information about
overloading disp, see Overloading the
disp Function on page 18-41

function plot(td,varargin)
plot(td.Strain,td.Stress,varargin{:})
title(['Stress/Strain plot for Sample',...
num2str(td.SampleNumber)])
ylabel('Stress (psi)')
xlabel('Strain %')
end
end
end

Overload plot function to accept

TensileData objects and graph stress
vs. strain.
Method to Plot Stress vs. Strain on page
3-30
end statements for methods and for
classdef.

Expand for Class Code

classdef TensileData
properties
Material
SampleNumber
Stress
Strain
end
properties (Dependent)
Modulus
end

3-33

MATLAB Classes Overview

methods
function td = TensileData(material,samplenum,stress,strain)
if nargin > 0
td.Material = material;
td.SampleNumber = samplenum;
td.Stress = stress;
td.Strain = strain;
end
end
function obj = set.Material(obj,material)
if (strcmpi(material,'aluminum') ||...
strcmpi(material,'stainless steel') ||...
strcmpi(material,'carbon steel'))
obj.Material = material;
else
error('Invalid Material')
end
end
function m = get.Modulus(obj)
ind = find(obj.Strain > 0);
m = mean(obj.Stress(ind)./obj.Strain(ind));
end
function obj = set.Modulus(obj,~)
fprintf('%s%d\n','Modulus is: ',obj.Modulus)
error('You cannot set Modulus property');
end
function disp(td)
sprintf('Material: %s\nSample Number: %g\nModulus: %1.5g\n',...
td.Material,td.SampleNumber,td.Modulus)
end
function plot(td,varargin)
plot(td.Strain,td.Stress,varargin{:})
title(['Stress/Strain plot for Sample ',...
num2str(td.SampleNumber)])
xlabel('Strain %')
ylabel('Stress (psi)')
end
end

3-34

Class to Represent Structured Data

end

More About

Class Components on page 5-5

3-35

MATLAB Classes Overview

Class to Implement Linked Lists

In this section...
Class Definition Code on page 3-36
dlnode Class Design on page 3-36
Create Doubly Linked List on page 3-37
Why a Handle Class for Linked Lists? on page 3-38
dlnode Class Synopsis on page 3-39
Specialize the dlnode Class on page 3-50

Class Definition Code

For the class definition code listing, see dlnode Class Synopsis on page 3-39.
To use the class, create a folder named @dlnode and save dlnode.m to this folder. The
parent folder of @dlnode must be on the MATLAB path. Alternatively, save dlnode.m
to a path folder.

dlnode Class Design

dlnode is a class for creating doubly linked lists in which each node contains:
Data array
Handle to the next node
Handle to the previous node
Each node has methods that enables the node to be:
Inserted before a specified node in a linked list
Inserted after a specific node in a linked list
Removed from a list
Class Properties
The dlnode class implements each node as a handle object with three properties:
Data Contains the data for this node
Next Contains the handle of the next node in the list (SetAccess = private)
3-36

Class to Implement Linked Lists

Prev Contains the handle of the previous node in the list (SetAccess =
private)
This diagram shows a list with three-nodes n1, n2, and n3. It also shows how the nodes
reference the next and previous nodes.

n1
Properties
Next
Prev
n2.Prev

n2
Properties
Next
Prev

n3
Properties
Next
Prev

n2

n2.Next

Class Methods
The dlnode class implements the following methods:
dlnode Construct a node and assign the value passed as an input to the Data
property
insertAfter Insert this node after the specified node
insertBefore Insert this node before the specified node
removeNode Remove this node from the list and reconnect the remaining nodes
clearList Remove large lists efficiently
delete Private method called by MATLAB when deleting the list.

Create Doubly Linked List

Create a node by passing the node's data to the dlnode class constructor. For example,
these statements create three nodes with data values 1, 2, and 3:
n1 = dlnode(1);
n2 = dlnode(2);
n3 = dlnode(3);

Build these nodes into a doubly linked list using the class methods designed for this
purpose:
n2.insertAfter(n1) % Insert n2 after n1
n3.insertAfter(n2) % Insert n3 after n2

3-37

MATLAB Classes Overview

Now the three nodes are linked:

n1.Next % Points to n2
ans =
dlnode with properties:
Data: 2
Next: [1x1 dlnode]
Prev: [1x1 dlnode]
n2.Next.Prev % Points back to n2
ans =
dlnode with properties:
Data: 2
Next: [1x1 dlnode]
Prev: [1x1 dlnode]
n1.Next.Next % Points to n3
ans =
dlnode with properties:
Data: 3
Next: []
Prev: [1x1 dlnode]
n3.Prev.Prev % Points to n1
ans =
dlnode with properties:
Data: 1
Next: [1x1 dlnode]
Prev: []

Why a Handle Class for Linked Lists?

Each node is unique in that no two nodes can be previous to or next to the same node.
3-38

Class to Implement Linked Lists

For example, a node object, node, contains in its Next property the handle of the
next node object, node.Next. Similarly, the Prev property contains the handle of the
previous node, node.Prev. Using the three-node linked list defined in the previous
section, you can demonstrate that the following statements are true:
n1.Next == n2
n2.Prev == n1

Now suppose you assign n2 to x:

x = n2;

The following two equalities are then true:

x == n1.Next
x.Prev == n1

But each instance of a node is unique so there is only one node in the list that can satisfy
the conditions of being equal to n1.Next and having a Prev property that contains a
handle to n1. Therefore, x must point to the same node as n2.
This means there has to be a way for multiple variables to refer to the same object. The
MATLAB handle class provides a means for both x and n2 to refer to the same node.
The handle class defines the eq method (use methods('handle') to list the handle
class methods), which enables the use of the == operator with all handle objects.
Related Information
For more information on handle classes, see Comparison of Handle and Value Classes
on page 7-2.

dlnode Class Synopsis

This section describes the implementation of the dlnode class.
Example Code

Discussion

classdef dlnode < handle

dlnode Class Design on page 3-36

Why a Handle Class for Linked Lists?
on page 3-38
Comparison of Handle and Value
Classes on page 7-2
3-39

MATLAB Classes Overview

Example Code
properties
Data
end
properties (SetAccess = private)
Next = dlnode.empty;
Prev = dlnode.empty;
end

Discussion
dlnode Class Design on page 3-36
Property Attributes on page 8-7:
SetAccess.
Initialize these properties to empty
dlnode objects.
For general information about properties,
see Property Syntax on page 8-4

methods

function node = dlnode(Data)

if (nargin > 0)
node.Data = Data;
end
end

function insertAfter(newNode, nodeBefore)

removeNode(newNode);
newNode.Next = nodeBefore.Next;
newNode.Prev = nodeBefore;
if ~isempty(nodeBefore.Next)
nodeBefore.Next.Prev = newNode;
end
nodeBefore.Next = newNode;
end
function insertBefore(newNode, nodeAfter)
removeNode(newNode);
newNode.Next = nodeAfter;
newNode.Prev = nodeAfter.Prev;
if ~isempty(nodeAfter.Prev)
nodeAfter.Prev.Next = newNode;
end
nodeAfter.Prev = newNode;
end

3-40

For general information about methods,

seeHow to Use Methods on page
9-2
Creating an individual node (not
connected) requires only the data.
For general information about
constructors, see Rules for Constructors
on page 9-20
Insert node into a doubly linked list
after specified node, or link the two
specified nodes if there is not already a
list. Assigns the correct values for Next
and Prev properties.
Insert Nodes on page 3-44
Insert node into doubly linked list before
specified node, or link the two specified
nodes if there is not already a list. This
method assigns correct values for Next
and Prev properties.
See Insert Nodes on page 3-44

Class to Implement Linked Lists

Example Code
function removeNode(node)
if ~isscalar(node)
error('Nodes must be scalar')
end
prevNode = node.Prev;
nextNode = node.Next;
if ~isempty(prevNode)
prevNode.Next = nextNode;
end
if ~isempty(nextNode)
nextNode.Prev = prevNode;
end
node.Next = = dlnode.empty;
node.Prev = = dlnode.empty;
end
function clearList(node)
prev = node.Prev;
next = node.Next;
removeNode(node)
while ~isempty(next)
node = next;
next = node.Next;
removeNode(node);
end
while ~isempty(prev)
node = prev;
prev = node.Prev;
removeNode(node)
end
end
methods (Access = private)
function delete(node)
clearList(node)
end
end
end

Discussion
Remove node and fix the list so that
remaining nodes are properly connected.
node argument must be scalar.
Once there are no references to node,
MATLAB deletes it.
Remove a Node on page 3-45

Avoid recursive calls to destructor as a

result of clearing the list variable. Loop
through list to disconnect each node.
When there are no references to a node,
MATLAB calls the class destructor (see
the delete method) before deleting it.

Class destructor method. MATLAB calls

the delete method you delete a node
that is still connected to the list.
End of private methods and end of class
definition.

Expand for Class Code

classdef dlnode < handle
% dlnode A class to represent a doubly-linked node.
% Link multiple dlnode objects together to create linked lists.
properties
Data
end
properties(SetAccess = private)
Next = dlnode.empty;
Prev = dlnode.empty;

3-41

MATLAB Classes Overview

end
methods
function node = dlnode(Data)
% Construct a dlnode object
if nargin > 0
node.Data = Data;
end
end
function insertAfter(newNode, nodeBefore)
% Insert newNode after nodeBefore.
removeNode(newNode);
newNode.Next = nodeBefore.Next;
newNode.Prev = nodeBefore;
if ~isempty(nodeBefore.Next)
nodeBefore.Next.Prev = newNode;
end
nodeBefore.Next = newNode;
end
function insertBefore(newNode, nodeAfter)
% Insert newNode before nodeAfter.
removeNode(newNode);
newNode.Next = nodeAfter;
newNode.Prev = nodeAfter.Prev;
if ~isempty(nodeAfter.Prev)
nodeAfter.Prev.Next = newNode;
end
nodeAfter.Prev = newNode;
end
function removeNode(node)
% Remove a node from a linked list.
if ~isscalar(node)
error('Input must be scalar')
end
prevNode = node.Prev;
nextNode = node.Next;
if ~isempty(prevNode)
prevNode.Next = nextNode;
end
if ~isempty(nextNode)
nextNode.Prev = prevNode;

3-42

Class to Implement Linked Lists

end
node.Next = dlnode.empty;
node.Prev = dlnode.empty;
end
function clearList(node)
% Clear the list before
% clearing list variable
prev = node.Prev;
next = node.Next;
removeNode(node)
while ~isempty(next)
node = next;
next = node.Next;
removeNode(node);
end
while ~isempty(prev)
node = prev;
prev = node.Prev;
removeNode(node)
end
end
end
methods (Access = private)
function delete(node)
clearList(node)
end
end
end

Class Properties
Only dlnode class methods can set the Next and Prev properties because these
properties have private set access (SetAccess = private). Using private set access
prevents client code from performing any incorrect operation with these properties. The
dlnode class methods perform all the operations that are allowed on these nodes.
The Data property has public set and get access, allowing you to query and modify the
value of Data as required.
Here is how the dlnode class defines the properties:
properties

3-43

MATLAB Classes Overview

Data
end
properties(SetAccess = private)
Next = dlnode.empty;
Prev = dlnode.empty;
end

Construct a Node Object

To create a node object, specify the node's data as an argument to the constructor:
function node = dlnode(Data)
if nargin > 0
node.Data = Data;
end
end

Insert Nodes
There are two methods for inserting nodes into the list insertAfter and
insertBefore. These methods perform similar operations, so this section describes only
insertAfter in detail.
function insertAfter(newNode, nodeBefore)
removeNode(newNode);
newNode.Next = nodeBefore.Next;
newNode.Prev = nodeBefore;
if ~isempty(nodeBefore.Next)
nodeBefore.Next.Prev = newNode;
end
nodeBefore.Next = newNode;
end
How insertAfter Works

First, insertAfter calls the removeNode method to ensure that the new node is not
connected to any other nodes. Then, insertAfter assigns the newNode Next and Prev
properties to the handles of the nodes that are after and before the newNode location in
the list.
For example, suppose you want to insert a new node, nnew, after an existing node, n1, in
a list containing n1n2n3.
First, create nnew:
nnew = dlnode(rand(3));

3-44

Class to Implement Linked Lists

Next, call insertAfter to insert nnew into the list after n1:
nnew.insertAfter(n1)

The insertAfter method performs the following steps to insert nnew in the list
between n1 and n2:
Set nnew.Next to n1.Next (n1.Next is n2):
nnew.Next = n1.Next;

Set nnew.Prev to n1
nnew.Prev = n1;

If n1.Next is not empty, then n1.Next is still n2, so n1.Next.Prev is n2.Prev,

which is set to nnew
n1.Next.Prev = nnew;

n1.Next is now set to nnew

n1.Next = nnew;

Remove a Node
The removeNode method removes a node from a list and reconnects the remaining
nodes. The insertBefore and insertAfter methods always call removeNode on the
node to insert before attempting to connect it to a linked list.
Calling removeNode ensures the node is in a known state before assigning it to the Next
or Prev property:
function removeNode(node)
if ~isscalar(node)

3-45

MATLAB Classes Overview

error('Input must be scalar')

end
prevNode = node.Prev;
nextNode = node.Next;
if ~isempty(prevNode)
prevNode.Next = nextNode;
end
if ~isempty(nextNode)
nextNode.Prev = prevNode;
end
node.Next = dlnode.empty;
node.Prev = dlnode.empty;
end

For example, suppose you remove n2 from a three-node list (n1n2n3):

n2.removeNode;

n1
Properties
Next
Prev

n2
Properties
Next
Prev

n3
Properties
Next
Prev

Disconnect the nodes

removeNode removes n2 from the list and reconnects the remaining nodes with the
following steps:
n1 = n2.Prev;
n3 = n2.Next;
if n1 exists, then
n1.Next = n3;
if n3 exists, then
n3.Prev = n1

The list is rejoined because n1 connects to n3 and n3 connects to n1. The final step is to
ensure that n2.Next and n2.Prev are both empty (i.e., n2 is not connected):
n2.Next = dlnode.empty;

3-46

Class to Implement Linked Lists

n2.Prev = dlnode.empty;

Removing a Node From a List

Suppose you create a list with ten nodes and save the handle to the head of the list:
head = dlnode(1);
for i = 10:-1:2
new = dlnode(i);
insertAfter(new,head);
end

Now remove the third node (Data property assigned the value 3):
removeNode(head.Next.Next)

Now the third node in the list has a data value of 4:

head.Next.Next
ans =
dlnode with properties:
Data: 4
Next: [1x1 dlnode]
Prev: [1x1 dlnode]

And the previous node has a Data value of 2:

head.Next
ans =
dlnode with properties:
Data: 2
Next: [1x1 dlnode]
Prev: [1x1 dlnode]

Delete a Node
To delete a node, call the removeNode method on that node. The removeNode method
disconnects the node and reconnects the list before allowing MATLAB to destroy the
removed node. MATLAB destroys the node once references to it by other nodes are
removed and the list is reconnected.
3-47

MATLAB Classes Overview

n1
Properties
Next
Prev

n2
Properties
Next
Prev

n3
Properties
Next
Prev

>> removeNode(n2)

n2
Properties
Next
Prev
>> clear(n2)
MATLAB calls delete(n2)
Delete the List
When you create a linked list and assign a variable that contains, for example, the
head or tail of the list, clearing that variable causes the destructor to recurse through
the entire list. With large enough list, clearing the list variable can result in MATLAB
exceeding its recursion limit.
The clearList method avoids recursion and improves the performance of deleting large
lists by looping over the list and disconnecting each node. clearList accepts the handle
of any node in the list and removes the remaining nodes.
function clearList(node)
if ~isscalar(node)
error('Input must be scalar')
end
prev = node.Prev;
next = node.Next;
removeNode(node)
while ~isempty(next)
node = next;
next = node.Next;

3-48

Class to Implement Linked Lists

removeNode(node);
end
while ~isempty(prev)
node = prev;
prev = node.Prev;
removeNode(node)
end
end

For example, suppose you create a list with a large number of nodes:
head = dlnode(1);
for k = 100000:-1:2
nextNode = dlnode(k);
insertAfter(nextNode,head)
end

The variable head contains the handle to the node at the head of the list:
head
head =
dlnode with properties:
Data: 1
Next: [1x1 dlnode]
Prev: []
head.Next
ans =
dlnode with properties:
Data: 2
Next: [1x1 dlnode]
Prev: [1x1 dlnode]

You can call clearList to remove the whole list:

clearList(head)

The only nodes that have not been deleted by MATLAB are those for which there exists
an explicit reference. In this case, those references are head and nextNode:
3-49

MATLAB Classes Overview

head
head =
dlnode with properties:
Data: 1
Next: []
Prev: []
nextNode
nextNode =
dlnode with properties:
Data: 2
Next: []
Prev: []

You can remove these nodes by clearing the variables:

clear head nextNode

The delete Method

The delete method simply calls the clearList method:
methods (Access = private)
function delete(node)
clearList(node)
end
end

The delete method has private access to prevent users from calling delete when
intending to delete a single node. MATLAB calls delete implicitly when the list is
destroyed.
To delete a single node from the list, use the removeNode method.

Specialize the dlnode Class

The dlnode class implements a doubly linked list and provides a convenient starting
point for creating more specialized types of linked lists. For example, suppose you want
to create a list in which each node has a name.
3-50

Class to Implement Linked Lists

Rather than copying the code used to implement the dlnode class, and then expanding
upon it, you can derive a new class from dlnode (i.e., subclass dlnode). You can create
a class that has all the features of dlnode and also defines its own additional features.
And because dlnode is a handle class, this new class is a handle class too.
NamedNode Class Definition
To use the class, create a folder named @NamedNode and save NamedNode.m to this
folder. The parent folder of @NamedNode must be on the MATLAB path. Alternatively,
save NamedNode.m to a path folder.
The following class definition shows how to derive the NamedNode class from the dlnode
class:
classdef NamedNode < dlnode
properties
Name = '';
end
methods
function n = NamedNode (name,data)
if nargin == 0
name = '';
data = [];
end
n = n@dlnode(data);
n.Name = name;
end
end
end

The NamedNode class adds a Name property to store the node name.
The constructor calls the class constructor for the dlnode class, and then assigns a value
to the Name property.
Use NamedNode to Create a Doubly Linked List
Use the NamedNode class like the dlnode class, except that you specify a name for each
node object. For example:
n(1) = NamedNode('First Node',100);
n(2) = NamedNode('Second Node',200);
n(3) = NamedNode('Third Node',300);

3-51

MATLAB Classes Overview

Now use the insert methods inherited from dlnode to build the list:
n(2).insertAfter(n(1))
n(3).insertAfter(n(2))

A single node displays its name and data when you query its properties:
n(1).Next
ans =
NamedNode with properties:
Name:
Data:
Next:
Prev:

'Second Node'
200
[1x1 NamedNode]
[1x1 NamedNode]

n(1).Next.Next
ans =
NamedNode with properties:
Name:
Data:
Next:
Prev:

'Third Node'
300
[]
[1x1 NamedNode]

n(3).Prev.Prev
ans =
NamedNode with properties:
Name:
Data:
Next:
Prev:

'First Node'
100
[1x1 NamedNode]
[]

More About

3-52

The Handle Superclass on page 7-13

Class for Graphing Functions

Class for Graphing Functions

In this section...
Class Definition Block on page 3-53
Using the topo Class on page 3-54
Behavior of the Handle Class on page 3-55
The class block is the code that starts with the classdef key word and terminates with
the end key word. The following example illustrated a simple class definition that uses:
Handle class
Property set and get functions
Use of a delete method for the handle object
Static method syntax

Class Definition Block

The following code defines a class called topo. It is derived from handle so it is a handle
class, which means it references the data it contains. See Using the topo Class on page
3-54 for information on how this class behaves.
classdef topo < handle
% topo is a subclass of handle
properties
FigHandle % Store figure handle
FofXY % function handle
Lm = [-2*pi 2*pi]; % Initial limits
end % properties
properties (Dependent, SetAccess = private)
Data
end % properties Dependent = true, SetAccess = private
methods
function obj = topo(fnc,limits)
% Constructor assigns property values
obj.FofXY = fnc;
obj.Lm = limits;
end % topo
function set.Lm(obj,lim)
% Lm property set function
if ~(lim(1) < lim(2))
error('Limits must be monotonically increasing')
else

3-53

MATLAB Classes Overview

obj.Lm = lim;
end
end % set.Lm
function data = get.Data(obj)
% get function calculates Data
% Use class name to call static method
[x,y] = topo.grid(obj.Lm);
matrix = obj.FofXY(x,y);
data.X = x;
data.Y = y;
data.Matrix = matrix;% Return value of property
end % get.Data
function surflight(obj)
% Graph function as surface
obj.FigHandle = figure;
surfc(obj.Data.X,obj.Data.Y,obj.Data.Matrix,...
'FaceColor',[.8 .8 0],'EdgeColor',[0 .2 0],...
'FaceLighting','gouraud');
camlight left; material shiny; grid off
colormap copper
end % surflight method
function delete(obj)
% Delete the figure
h = obj.FigHandle;
if ishandle(h)
delete(h);
else
return
end
end % delete
end % methods
methods (Static = true) % Define static method
function [x,y] = grid(lim)
inc = (lim(2)-lim(1))/35;
[x,y] = meshgrid(lim(1):inc:lim(2));
end % grid
end % methods Static = true
end % topo class

Using the topo Class

This class is designed to display a combination surface/contour graph of mathematical
functions of two variables evaluated on a rectangular domain of x and y. For example,
any of the following functions can be evaluated over the specified domain (note that x
and y have the same range of values in this example just for simplicity).
x.*exp(-x.^2 - y.^2); [-2 2]
sin(x).*sin(y); [-2*pi 2*pi]

3-54

Class for Graphing Functions

sqrt(x.^2 + y.^2); [-2*pi 2*pi]

To create an instance of the class, passing a function handle and a vector of limits to the
constructor. The easiest way to create a function handle for these functions is to use an
anonymous function:
tobj = topo(@(x,y) x.*exp(-x.^2-y.^2),[-2 2]);

The class surflight method uses the object to create a graph of the function. The actual
data required to create the graph is not stored. When the surflight method accesses
the Data property, the property's get function performs the evaluation and returns the
data in the Data property structure fields. This data is then plotted. The advantage of
not storing the data is the reduced size of the object.

Behavior of the Handle Class

The topo class is defined as a handle class. This means that instances of this class are
handle objects that reference the underlying data store created by constructing the
object. For example, suppose you create an instance of the class and create a copy of the
object:
tobj = topo(@(x,y) x.*exp(-x.^2-y.^2),[-2 2]);
a = tobj;
surflight(a)

3-55

MATLAB Classes Overview

Now suppose you change the FofXY property so that it contains a function handle that
points to another function:
tobj.FofXY = @(x,y) y.*exp(-x.^2-y.^2);
surflight(a)

Because a is a copy of the handle object tobj, changes to the data referenced by tobj
also change the data referenced by a.
How a Value Class Differs
If topo were a value class, the objects tobj and a would not share data; each would have
its own copy of the property values.

3-56

4
Static Data

Static Data

Static Data
In this section...
What Is Static Data on page 4-2
Static Variable on page 4-2
Static Data Object on page 4-3
Constant Data on page 4-5

What Is Static Data

Static data refers to data that all objects of the class share and that you can modified
after creation.
Use static data to define counters used by class instances or other data that is shared
among all objects of a class. Unlike instance data, static data does not vary from one
object to another. MATLAB provides several ways to define static data, depending on
your requirements.

Static Variable
Classes can use a persistent variable to store static data. Define a static method or local
function in which you create a persistent variable. The method or function provides
access to this variable. Use this technique when you want to store one or two variables.
Saving an object of the class defining the persistent variable does not save the static data
associated with the class. To save your static data in an object, or define more extensive
data, use the static data object technique Static Data Object on page 4-3
Implementation
The StoreData class defines a static method that declares a persistent variable Var.
The setgetVar method provides set and get access to the data in the persistent
variable. Because the setgetVar method has public access, you can set and get the
data stored in the persistent variable globally. Control the scope of access by setting the
method Access attribute.
classdef StoreData
methods (Static)

4-2

Static Data

function out = setgetVar(data)

persistent Var;
if nargin
Var = data;
end
out = Var;
end
end
end

Set the value of the variable by calling setgetVar with an input argument. The method
assigns the input value to the persistent variable:
StoreData.setgetVar(10);

Get the value of the variable by calling setgetVar with no input argument:
a = StoreData.setgetVar
a =
10

Clear the persistent variable by calling clear on the StoreData class:

clear StoreData
a = StoreData.setgetVar
a =
[]

Add a method like setgetVar to any class in which you want the behavior of a static
property.

Static Data Object

To store more extensive data, define a handle class with public properties. Assign an
object of the class to a constant property of the class that uses the static data. This
technique is useful when you want to:
Add more properties or methods that modify the data.
Save objects of the data class and reload the static data.
4-3

Static Data

Implementation
The SharedData class is a handle class, which enables you to reference the same object
data from multiple handle variables:
classdef SharedData < handle
properties
Data1
Data2
end
end

The UseData class is the stub of a class that uses the data stored in the SharedData
class. The UseData class stores the handle to a SharedData object in a constant
property.
classdef UseData
properties (Constant)
Data = SharedData;
end
% Class code here
end

The Data property contains the handle of the SharedData object. MATLAB constructs
the SharedData object when loading the UseData class. All subsequently created
instances of the UseData class refer to the same SharedData object.
To initialize the SharedData object properties, load theUseData class by referencing the
constant property.
h = UseData.Data
h =
SharedData with properties:
Data1: []
Data2: []

Use the handle to the SharedData object to assign data to property values:
h.Data1 = 'MyData1';
h.Data2 = 'MyData2';

Each instance of the UseData class refers to the same handle object:
4-4

Static Data

a1 = UseData;
a2 = UseData;

Reference the data using the object variable:

a1.Data.Data1
ans =
MyData1

Assign a new value to the properties in the SharedData object:

a1.Data.Data1 = rand(3);

All new and existing objects of the UseData class share the same SharedData object. a2
now has the rand(3) data that was assigned to a1 in the previous step:
a2.Data.Data1
ans =
0.8147
0.9058
0.1270

0.9134
0.6324
0.0975

0.2785
0.5469
0.9575

To reinitialize the constant property, clear all instances of the UseData class and then
clear the class:
clear a1 a2
clear UseData

Constant Data
To store constant values that do not change, assign the data to a constant property. All
instances of the class share the same value for that property. Control the scope of access
to constant properties by setting the property Access attribute.
The only way to change the value of a constant property is to change the class definition.
Use constant properties like public final static fields in Java.

See Also

clear | persistent
4-5

Static Data

Related Examples

Properties with Constant Values on page 15-2

Static Methods on page 9-28

More About

4-6

Method Attributes on page 9-5

Property Attributes on page 8-7

Static Properties on page 5-63

5
Class DefinitionSyntax Reference
Class Files and Folders on page 5-2
Class Components on page 5-5
Classdef Block on page 5-10
Properties on page 5-12
Methods and Functions on page 5-15
Events and Listeners on page 5-20
Attribute Specification on page 5-22
Call Superclass Methods on Subclass Objects on page 5-25
Representative Class Code on page 5-27
MATLAB Code Analyzer Warnings on page 5-32
Objects In Conditional Statements on page 5-34
Operations on Objects on page 5-41
Use of Editor and Debugger with Classes on page 5-45
Automatic Updates for Modified Classes on page 5-47
Compatibility with Previous Versions on page 5-55
Comparison of MATLAB and Other OO Languages on page 5-58

Class DefinitionSyntax Reference

Class Files and Folders

In this section...
Class Definition Files on page 5-2
Options for Class Folders on page 5-2
Options for Class Files on page 5-2
Group Classes with Package Folders on page 5-3

Class Definition Files

Place class definition code in .m files, similarly to how you define function files. The
name of the file is the name of the class followed by the .m extension. For information on
the code that defines a class, see Class Components on page 5-5.

Options for Class Folders

There are two ways create folders that contain class-definition files:
Path folder a folder that is on the MATLAB path.
Class folder a folder that is in a path folder and is name with the @ character and
the class name. For example:
@MyClass

Class folders are not directly on the MATLAB path. The path folder that contains the
class folder is on the MATLAB path.

Options for Class Files

There are two ways to specify classes with respect to files and folders:
Create a single, self-contained class definition file in a path folder or a class folder
Define a class in multiple files, which requires you to use a class folder inside a path
folder
Create a Single, Self-Contained Class Definition File
Create a single, self-contained class definition file in a folder on the MATLAB path.
The name of the file must match the class (and constructor) name and must have the .m
5-2

Class Files and Folders

extension. Define the class entirely in this file. You can put other single-file classes in
this folder.
The following diagram shows an example of this folder organization. pathfolder is a
folder on the MATLAB path.
pathfolder
ClassNameA.m
ClassNameB.m
ClassNameC.m
...
ordinaryFunction.m

Contains classdef and methods for ClassNameA

Contains classdef and methods for ClassNameB
Contains classdef and methods for ClassNameC
A function on the path

Distribute the Class Definition to Multiple Files

If you use multiple files to define a class, put all the class-definition files (the file
containing the classdef and all class method files) in a single @ClassName folder. That
class folder must be inside a folder that is on the MATLAB path. You can define only one
class in a class folder.
pathfolder
@ClassNameA
ClassNameA.m
classMethod.m
ClassNameB.m

Contains classdef
Class method in separate file
Contains entire class definition

A path folder can contain classes defined in both class folders and single files without a
class folder.

Group Classes with Package Folders

The parent folder to a package folder is on the MATLAB path, but the package folder
is not. Package folders (which always begin with a + character) can contain multiple
class definitions, package-scoped functions, and other packages. A package folder
defines a new name space in which you can reuse class names. Use the package
name to refer to classes and functions defined in package folders (for example,
packagefld1.ClassNameA(), packagefld2.packageFunction()).
5-3

Class DefinitionSyntax Reference

pathfolder
+packagefld1
@ClassNameA
ClassNameA.m
classMethod.m
ClassNameB.m
+packagefld2

Contains classdef
Class method in separate file
Contains entire class definition
Defines a new name space

packageFunction.m
ClassNameA.m
ClassNameB.m

More About

5-4

Folders Containing Class Definitions on page 6-16

Packages Create Namespaces on page 6-24

Methods In Separate Files on page 9-10

Class Components

Class Components
In this section...
Class Building Blocks on page 5-5
Class Definition Block on page 5-5
Properties Block on page 5-6
Methods Block on page 5-6
Events Block on page 5-7
A Complete Class on page 5-7
Enumeration Classes on page 5-8
Related Information on page 5-9

Class Building Blocks

MATLAB organizes class definition code into modular blocks, delimited by keywords. All
keywords have an associated end statement:
classdef...end Definition of all class components
properties...end Declaration of property names, specification of property
attributes, assignment of default values
methods...end Declaration of method signatures, method attributes, and
function code
events...end Declaration of event name and attributes
enumeration...end Declaration of enumeration members and enumeration
values for enumeration classes.
properties, methods, events, and enumeration are keywords only within a
classdef block.

Class Definition Block

The classdef block contains the class definition within a file that starts with the
classdef keyword and terminates with the end keyword.
classdef (ClassAttributes) ClassName < SuperClass
...
end

5-5

Class DefinitionSyntax Reference

For example, this classdef defines a class called MyClass that subclasses the handle
class, but cannot be used to derive subclasses:
classdef (Sealed) MyClass < handle
...
end

See, Classdef Block on page 5-10 for more syntax information.

Properties Block
The properties block (one for each unique set of attribute specifications) contains
property definitions, including optional initial values. The properties block starts with
the properties keyword and terminates with the end keyword.
classdef ClassName
properties (PropertyAttributes)
...
end
...
end

For example, this class defines a property called Prop1 that has private access and has a
default value equal to the output of the date function.
classdef MyClass
properties (Access = private)
Prop1 = date;
end
...
end

See Defining Properties on page 8-13 for more information.

Methods Block
The methods block (one for each unique set of attribute specifications) contains function
definitions for the class methods. The methods block starts with the methods keyword
and terminates with the end keyword.
classdef ClassName
methods (MethodAttributes)
...
end

5-6

Class Components

...
end

For example:
classdef MyClass
methods (Access = private)
function obj = myMethod(obj)
...
end
end
end

See Methods and Functions on page 5-15 for more information.

Events Block
The events block (one for each unique set of attribute specifications) contains the names
of events that this class declares. The events block starts with the events keyword and
terminates with the end keyword.
classdef ClassName
events (EventAttributes)
EventName
end
...
end

For example, this class defined an event called StateChange with a ListenAccess set
to protected:
classdef EventSource
events (ListenAccess = protected)
StateChanged
end
...
end

See Events and Listeners on page 5-20 for more information.

A Complete Class
A complete class definition contains any combination of properties, methods, and events
code blocks.
5-7

Class DefinitionSyntax Reference

classdef (Sealed) MyClass < handle

properties (Access = private)
Prop1 = datenum(date);
end
properties
Prop2
end
methods
function obj = MyClass(x)
obj.Prop2 = x;
end
end
methods (Access = {?MyOtherClass})
function d = myMethod(obj)
d = obj.Prop1 + x;
end
end
events (ListenAccess = protected)
StateChanged
end
end

Enumeration Classes
Enumeration classes are specialized classes that define a fixed set of names representing
a single type of value. Enumeration classes use an enumeration block that contains the
enumeration members defined by the class.
The enumeration block starts with the enumeration keyword and terminates with the
end keyword.
classdef ClassName < SuperClass
enumeration
EnumerationMember
end
...
end

For example, this class defines two enumeration members that represent logical false
and true:
classdef Boolean < logical
enumeration

5-8

Class Components

No (0)
Yes (1)
end
end

See, Define Enumeration Classes on page 14-5 for more information.

Related Information
Folders Containing Class Definitions on page 6-16

5-9

Class DefinitionSyntax Reference

Classdef Block
In this section...
How to Specify Attributes and Superclasses on page 5-10
Class Attribute Syntax on page 5-10
Superclass Syntax on page 5-11
Local Functions in Class File on page 5-11

How to Specify Attributes and Superclasses

The classdef block contains the class definition. The classdef line is where you
specify:
Class attributes
Superclasses
The classdef block contains the properties, methods, and events subblocks.

Class Attribute Syntax

Class attributes modify class behavior in some way. Assign values to class attributes only
when you want to change their default value.
No change to default attribute values:
classdef ClassName
...
end

One or more attribute values assigned:

classdef (attribute1 = value,...)
...
end

For example, the TextString class specifies that it cannot be used to derive subclasses:
classdef TextString (Sealed)
...

5-10

Classdef Block

end

See Class Attributes on page 6-6 for a list of attributes and a discussion of the
behaviors they control.

Superclass Syntax
Derive a class from one or more other classes by specifying the superclasses on the
classdef line:
classdef ClassName < SuperclassName
...
end

For example, the LinkedList class inherits from classes called Array and handle:
classdef LinkedList < Array & handle
...
end

Local Functions in Class File

You can define only one class per file. However, you can add local functions to a file
containing the classdef block. Local functions are scoped to the classdef file and have
access to private and protected class members.
classdef ClassName
...
end
function localFunction
...
end

Related Examples

User-Defined Classes on page 6-2

Create Subclasses Syntax and Techniques on page 12-7

Local Functions

5-11

Class DefinitionSyntax Reference

Properties
In this section...
The Properties Block on page 5-12
Access to Property Values on page 5-13

The Properties Block

Define class properties within a properties block:
classdef ClassName
properties (PropertyAttributes)
PropertyName = DefaultValue;
end
end

Property attributes apply to all properties defined within the block. To define properties
with different attributes, use multiple properties block. All property attributes
have default values. For a list of property attributes, see Property Attributes on page
8-7.
Optionally assign default values to the property in the properties block. MATLAB
evaluates the assignment statement when the class is first referenced or when loading a
saved object.
Note: Evaluation of property default values occurs only when the value is first needed,
and only once when MATLAB first initializes the class. MATLAB does not reevaluate the
expression each time you create an instance of the class.
For more information on the evaluation of expressions that you assign as property
default values, see When MATLAB Evaluates Expressions on page 6-12.
Properties with Different Attributes
The following class defines three properties. Model and Color use default attribute
values, resulting in public read and write access. SerialNumber has read-only access
by object users. Assign the SerialNumber property value from a class member function,
such as the constructor or other class method.
5-12

Properties

classdef NewCar
properties
Model
Color
end
properties (SetAccess = private, GetAccess = public)
SerialNumber
end
methods
...
end
end

Access to Property Values

Use dot notation to access property value.
A = NewCar
A =
NewCar with properties:
Model: []
Color: []
SerialNumber: []

Set the Model and Color properties:

A.Model = 'XGT7000';
A.Color = 'Red';

Add a constructor to the NewCar class to set property values:

classdef NewCar
properties
Model
Color
end
properties (SetAccess = private, GetAccess = public)
SerialNumber
end
methods
function obj = NewCar(model,color)

5-13

Class DefinitionSyntax Reference

obj.Model = model;
obj.Color = color;
obj.SerialNumber = datenum(datetime('now'));
end
end
end
A = NewCar('XGT7000','Red')
A =
NewCar with properties:
Model: 'XGT7000'
Color: 'Red'
SerialNumber: 7.362456078531134e+05

Related Examples

5-14

How to Use Properties on page 8-2

Restrict Class of Properties on page 8-20

Methods and Functions

Methods and Functions

In this section...
The Methods Block on page 5-15
Method Calling Syntax on page 5-15
Private Methods on page 5-17
More Detailed Information On Methods on page 5-17
Class-Related Functions on page 5-17
How to Overload Functions and Operators on page 5-18
Rules for Defining Methods in Separate Files on page 5-18

The Methods Block

Define methods as MATLAB functions within a methods block, inside the classdef
block. The constructor method has the same name as the class and returns an object. You
can assign values to properties in the class constructor. Terminate all method functions
with an end statement.
classdef ClassName
properties
PropertyName
end
methods
function obj = ClassName(arg1,...)
obj.PropertyName = arg1;
...
end
function ordinaryMethod(obj,arg1,...)
...
end
end
methods (Static)
function staticMethod(arg1,...)
...
end
end
end

Method Calling Syntax

MATLAB differs from languages like C++ and Java in that there is no special hidden
class object passed to all methods. You must pass an object of the class explicitly to the
5-15

Class DefinitionSyntax Reference

method. The left most argument does not need to be the class object, and the argument
list can have multiple objects. MATLAB dispatches to the method defined by the class of
the dominant argument. For more information, see Method Invocation on page 9-14.
Methods must on the MATLAB path when called. For example, if you create an object
and then change your current folder to a folder from which the method file is not visible,
MATLAB errors when you to call that method.
Always use case sensitive method names in your MATLAB code.
Ordinary Methods
Call ordinary methods using MATLAB function syntax or dot notation. For example,
suppose you have a class that defines ordinaryMethod. Pass an object of the defining
class and whatever arguments are required.
classdef MyClass
methods
function out = ordinaryMethod(obj,arg1)
...
end
end
end

Call ordinaryMethod using the object obj of the class and either syntax:
obj = MyClass;
r = ordinaryMethod(obj,arg1);
r = obj.ordinaryMethod(arg1);

Static Methods
Static methods do not require an object of the class. To call a static method, prefix the
method name with the class name so that MATLAB can determine what class defines the
method.
classdef MyClass
methods (Static)
function out = staticMethod(arg1)
...
end
end
end

5-16

Methods and Functions

Call staticMethod using the syntax classname.methodname:

r = MyClass.staticMethod(arg1);

See Static Methods on page 9-28 for information on methods that do not require
objects of their class.

Private Methods
Use the Access method attribute to create a private method. You do not need to use a
private folder.
See Method Attributes on page 9-5 for a list of method attributes.

More Detailed Information On Methods

Methods

Class-Related Functions
You can define functions that are not class methods in the file that contains the class
definition (classdef). Define local functions outside of the classdef - end block, but
in the same file as the class definition. Functions defined in classdef files work like
local functions. You can call these functions from anywhere in the same file, but they are
not visible outside of the file in which you define them.
Local functions in classdef files are useful for utility functions that you use only within
that file. These functions can take or return arguments that are instances of the class
but, it is not necessary, as in the case of ordinary methods. For example, the following
code defines myUtilityFcn outside the classdef block:
classdef MyClass
properties
PropName
end
methods
function obj = MyClass(arg1)
obj.PropName = arg1;
end
end
end % End of classdef

5-17

Class DefinitionSyntax Reference

function myUtilityFcn
...
end

You also can create package functions, which require the use of the package name when
calling these functions.

How to Overload Functions and Operators

Overload MATLAB functions for your class by defining a class method with the same
name as the function that you want to overload. MATLAB dispatches to the class method
when the function is called with an instance of the class.
You can overload MATLAB arithmetic, logical, relational, and indexing operators by
defining class methods with the appropriate names.
See the handle class for a list of operations defined for that class. All classes deriving
from handle inherit these methods.

Rules for Defining Methods in Separate Files

The following rules apply to methods defined in separate files:
To specify attributes for a method defined in a separate file, declare this method in
a methods block in the classdef file. Specify the attribute values with the methods
block.
The syntax declared in the methods block (if used) must match the method's
function line.
The separate file must be in the class folder.
The class constructor method must be defined in the classdef file. The constructor
cannot be in a separate file.
Handle class delete methods must be defined in the classdef file. The delete
method cannot be in a separate file.
All functions that use dots in their names must be defined in the classdef file,
including:
Converter methods that must use the package name as part of the class name
because the class is contained in packages
5-18

Methods and Functions

Property set and get access methods

For more information on defining methods in separate files, see Methods In Separate
Files on page 9-10

More About

How to Use Methods on page 9-2

5-19

Class DefinitionSyntax Reference

Events and Listeners

In this section...
Define and Trigger Events on page 5-20
Listen for Events on page 5-20

Define and Trigger Events

To define an event, declare a name for the event in an events block. Trigger the event
using the handle class notify method. Only classes derived from the handle class can
define events.
For example, MyClass class:
Subclasses handle
Defines an event named StateChange
Triggers the event using the inherited notify method in its upDateUI method.
classdef MyClass < handle
events
StateChange
end
...
methods
function upDateUI(obj)
...
notify(obj,'StateChange');
end
end
end

Listen for Events

Any number of objects can listen to the StateChange event. When notify executes,
MATLAB calls all registered listener callbacks. MATLAB passes the handle of the object
generating the event and event data to the callback functions. To create a listener, use
the addlistener method of the handle class.
addlistener(event_obj,'StateChange',@myCallback)

Related Examples

5-20

Overview Events and Listeners on page 11-2

Events and Listeners

Events and Listeners Syntax on page 11-21

5-21

Class DefinitionSyntax Reference

Attribute Specification
In this section...
Attribute Syntax on page 5-22
Attribute Descriptions on page 5-22
Attribute Values on page 5-23
Simpler Syntax for true/false Attributes on page 5-23

Attribute Syntax
Attributes modify the behavior of classes and class components (properties, methods, and
events). Attributes enable you to define useful behaviors without writing complicated
code. For example, you can create a read-only property by setting its SetAccess
attribute to private, but leaving its GetAccess attribute set to public:
properties (SetAccess = private)
ScreenSize = getScreenSize;
end

All class definition blocks (classdef, properties, methods, and events) support
specific attributes. All attributes have default values. Specify attribute values only in
cases where you want to change from the default value to another predefined value.
Note: Specify the value of a particular attribute only once in any component block.

Attribute Descriptions
For lists of supported attributes, see:
Class Attributes on page 6-6
Property Attributes on page 8-7
Method Attributes on page 9-5
Event Attributes on page 11-19

5-22

Attribute Specification

Attribute Values
When you specify attribute values, those values affect all the components defined within
the defining block. For example, the following property definition blocks set the:
AccountBalance property SetObservable attribute to true
SSNumber and CreditCardNumber properties' Hidden attribute to true and
SetAccess attribute to private.
Defining properties with different attribute settings requires multiple properties
blocks.
properties (SetObservable = true)
AccountBalance
end
properties (SetAccess = private, Hidden = true)
SSNumber
CreditCardNumber
end

Specified multiple attributes in a comma-separated list, as shown in the previous

example.
When specifying class attributes, place the attribute list directly after the classdef
keyword:
classdef (AttributeName = attributeValue) ClassName
...
end

Simpler Syntax for true/false Attributes

You can use a simpler syntax for attributes whose values are true or false the
attribute name alone implies true and adding the not operator (~) to the name implies
false. For example:
methods (Static)
...
end

Is the same as:

methods (Static = true)
...

5-23

Class DefinitionSyntax Reference

end

Use the not operator before an attribute name to define it as false:

methods (~Static)
...
end

Is the same as:

methods (Static = false)
...
end

All attributes that take a logical value (that is, true or false) have a default value of
false. Therefore, specify an attribute only if you want to set it to true.

Related Examples

5-24

Evaluation of Expressions in Class Definitions on page 6-9

Call Superclass Methods on Subclass Objects

Call Superclass Methods on Subclass Objects

In this section...
How to Call Superclass Constructor on page 5-25
How to Call Superclass Methods on page 5-26

How to Call Superclass Constructor

If you create a subclass object, MATLAB calls the superclass constructor to initialize
the superclass part of the subclass object. By default, MATLAB calls the superclass
constructor without arguments. If you want the superclass constructor called with
specific arguments, explicitly call the superclass constructor from the subclass
constructor. The call to the superclass constructor must come before any other references
to the object.
The syntax for calling the superclass constructor uses an @ symbol:

obj = obj@MySuperClass(SuperClassArguments);

Object returned
from superclass

Name of superclass
Object being
constructed

Superclass constructor
arugment list

In the following class, the MySub object is initialized by the MySuperClass constructor.
The superclass constructor constructs the MySuperClass part of the object using the
specified arguments.
classdef MySub < MySuperClass
methods
function obj = MySub(arg1,arg2,...)
obj = obj@MySuperClass(SuperClassArguments);
...
end

5-25

Class DefinitionSyntax Reference

end
end

See Constructing Subclasses on page 9-23 for more information.

How to Call Superclass Methods

Subclass methods can call superclass methods if both methods have the same name.
From the subclass, reference the method name and superclass name with the @ symbol.
This diagram illustrates how to call the superMethod defined by MySuperClass.

superMethod@MySuperClass(obj)

Superclass name
Superclass method

Object passed to the

superclass method

For example, a subclass can call a superclass disp method to implement the display of
the superclass part of the object. Then the subclass adds code to display the subclass part
of the object:
classdef MySub < MySuperClass
methods
function disp(obj)
disp@MySuperClass(obj)
...
end
end
end

Related Examples

5-26

Modify Superclass Methods on page 12-15

Representative Class Code

Representative Class Code

In this section...
Class Calculates Area on page 5-27
Description of Class Definition on page 5-29

Class Calculates Area

The CircleArea class shows the syntax of a typical class definition. This class stores a
value for the radius of a circle and calculates the area of the circle when you request this
information. CircleArea also implements methods to graph, display, and create objects
of the class.
To use the CircleArea class, copy this code into a file named CircleArea.m and save
this file in a folder that is on the MATLAB path.
classdef CircleArea
properties
Radius
end
properties (Constant)
P = pi;
end
properties (Dependent)
Area
end
methods
function obj = CircleArea(r)
if nargin > 0
obj.Radius = r;
end
end
function val = get.Area(obj)
val = obj.P*obj.Radius^2;
end
function obj = set.Radius(obj,val)
if val < 0
error('Radius must be positive')
end
obj.Radius = val;
end
function plot(obj)

5-27

Class DefinitionSyntax Reference

r = obj.Radius;
d = r*2;
pos = [0 0 d d];
curv = [1 1];
rectangle('Position',pos,'Curvature',curv,...
'FaceColor',[.9 .9 .9])
line([0,r],[r,r])
text(r/2,r+.5,['r = ',num2str(r)])
title(['Area = ',num2str(obj.Area)])
axis equal
end
function disp(obj)
rad = obj.Radius;
disp(['Circle with radius: ',num2str(rad)])
end
end
methods (Static)
function obj = createObj
prompt = {'Enter the Radius'};
dlgTitle = 'Radius';
rad = inputdlg(prompt,dlgTitle);
r = str2double(rad{:});
obj = CircleArea(r);
end
end
end

Use the CircleArea Class

Create an object using the dialog box:
ca = CircleArea.createObj

Add a value for radius and click OK.

Query the area of the defined circle:

5-28

Representative Class Code

ca.Area
ans =
164.2202

Call the overloaded plot method:

plot(ca)

Description of Class Definition

Class definition code begins with the classdef keyword followed by the class name:
classdef CircleArea

5-29

Class DefinitionSyntax Reference

Define the Radius property within the properties-end keywords. Use default
attributes:
properties
Radius
end

Define the P property as Constant (Properties with Constant Values on page

15-2). Call the pi function only once when class is initialized.
properties (Constant)
P = pi;
end

Define the Area property as Dependent because its value depends on the Radius
property.
properties (Dependent)
Area
end
methods % Begin defining methods

The CircleArea class constructor method has the same name as the class and
accepts the value of the circle radius as an argument. This method also allows no input
arguments. (Class Constructor Methods on page 9-20)
function obj = CircleArea(r)
if nargin > 0
obj.Radius = r;
else
obj.Radius = 0;
end
end

Because the Area property is Dependent, it does not store its value. The get.Area
method calculates the value of the Area property whenever it is queried. (Access
Methods for Dependent Properties on page 8-34)
function val = get.Area(obj)
val = obj.P*obj.Radius^2;
end

The set.Radius method tests the value assigned to the Radius property to ensure
the value is not less than zero. MATLAB calls set.Radius to assign a value to Radius.
(Property Set Methods on page 8-29.

5-30

Representative Class Code

function obj = set.Radius(obj,val)

if val < 0
error('Radius must be positive')
end
obj.Radius = val;
end

The CircleArea class overloads the plot function. The plot method uses the
rectangle function to create a circle and draws the radius. (Overload Functions in
Class Definitions on page 9-30
function plot(obj)
r = obj.Radius;
d = r*2;
pos = [0 0 d d];
curv = [1 1];
rectangle('Position',pos,'Curvature',curv)
line([0,r],[r,r])
text(r/2,r+.5,['r = ',num2str(r)])
axis equal
end

The CircleArea class overloads the disp function to change the way MATLAB
displays objects in the command window.
function disp(obj)
rad = obj.Radius;
disp(['Circle with radius: ',num2str(rad)])
end
end
methods (Static)

The CircleArea class defines a Static method that uses a dialog box to create an
object. (Static Methods on page 9-28
function obj = createObj
prompt = {'Enter the Radius'};
dlgTitle = 'Radius';
rad = inputdlg(prompt,dlgTitle);
r = str2double(rad{:});
obj = CircleArea(r);
end

End of Static methods block and end of classdef block.

end
end

5-31

Class DefinitionSyntax Reference

MATLAB Code Analyzer Warnings

In this section...
Syntax Warnings and Property Names on page 5-32
Variable/Property Name Conflict Warnings on page 5-32
Exception to Variable/Property Name Rule on page 5-33

Syntax Warnings and Property Names

The MATLAB Code Analyzer helps you optimize your code and avoid syntax errors
while you write code. It is useful to understand some of the rules that the Code Analyzer
applies in its analysis of class definition code. This understanding helps you avoid
situations in which MATLAB allows code that is undesirable.

Variable/Property Name Conflict Warnings

The Code Analyzer warns about the use of variable names in methods that match
the names of properties. For example, suppose a class defines a property called
EmployeeName and in this class, there is a method that uses EmployeeName as a
variable:
properties
EmployeeName
end
methods
function someMethod(obj,n)
EmployeeName = n;
end
end

While the previous function is legal MATLAB code, it results in Code Analyzer warnings
for two reasons:
The value of EmployeeName is never used
EmployeeName is the name of a property that is used as a variable
If the function someMethod contained the following statement instead:
obj.EmployeeName = n;

5-32

MATLAB Code Analyzer Warnings

The Code Analyzer generates no warnings.

If you change someMethod to:
function EN = someMethod(obj)
EN = EmployeeName;
end

The Code Analyzer returns only one warning, suggesting that you might actually want to
refer to the EmployeeName property.
While this version of someMethod is legal MATLAB code, it is confusing to give a
property the same name as a function. Therefore, the Code Analyzer provides a warning
suggesting that you might have intended the statement to be:
EN = obj.EmployeeName;

Exception to Variable/Property Name Rule

Suppose you define a method that returns a value of a property and uses the name of the
property for the output variable name. For example:
function EmployeeName = someMethod(obj)
EmployeeName = obj.EmployeeName;
end

The Code Analyzer does not warn when a variable name is the same as a property name
when the variable is:
An input or output variable
A global or persistent variable
In these particular cases, the Code Analyzer does not warn you that you are using a
variable name that is also a property name. Therefore, a coding error like the following:
function EmployeeName = someMethod(obj)
EmployeeName = EmployeeName; % Forgot to include obj.
end

does not trigger a warning from the Code Analyzer.

Related Examples

Use of Editor and Debugger with Classes on page 5-45

5-33

Class DefinitionSyntax Reference

Objects In Conditional Statements

In this section...
Enable Use of Objects In Conditional Statements on page 5-34
How MATLAB Evaluates Switch Statements on page 5-34
How to Define the eq Method on page 5-36
Enumerations in Switch Statements on page 5-38

Enable Use of Objects In Conditional Statements

Enable the use of objects in conditional statements by defining relational operators
for the class of the object. Classes that derive from the handle class inherit relational
operators. Value classes can implement operators to support the use of conditional
statements involving objects. For information on defining operators for your class, see
Operator Overloading on page 17-48.

How MATLAB Evaluates Switch Statements

MATLAB enables you to use objects in switch statements when the objects class defines
an eq method. The eq method implements the == operation on objects of that class.
For objects, switch_expression == case_expression defines how MATLAB
evaluates switch and cases statements.
Note: You do not need to define eq methods for enumeration classes. See Enumerations
in Switch Statements on page 5-38.
Handle Objects in Switch Statements
All classes derived from the handle class inherit an eq method. The expression,
h1 == h2

is true if h1 and h2 are handles for the same object.

For example, the BasicHandle class derives from handle:
5-34

Objects In Conditional Statements

classdef BasicHandle < handle

properties
Prop1
end
methods
function obj = BasicHandle(val)
if nargin > 0
obj.Prop1 = val;
end
end
end
end

Create a BasicHandle object and use it in a switch statement:

h1 = BasicHandle('Handle Object');
h2 = h1;

Here is the switch statement code:

switch h1
case h2
disp('h2 is selected')
otherwise
disp('h2 not selected')
end

The result is:

h2 is selected

Object Must Be Scalar

The switch statements work only with scalar objects. For example:
h1(1) = BasicHandle('Handle Object');
h1(2) = BasicHandle('Handle Object');
h1(3) = BasicHandle('Handle Object');
h2 = h1;
switch h1
case h2
disp('h2 is selected')
otherwise
disp('h2 not selected')

5-35

Class DefinitionSyntax Reference

end

The result is:

SWITCH expression must be a scalar or string constant.

In this case, h1 is not scalar. Use isscalar to determine if an object is scalar before
entering a switch statement.

How to Define the eq Method

To enable the use of value-class objects in switch statements, implement an eq method
for the class. Use the eq method to determine what constitutes equality of two object of
the class.
Behave Like a Built-in Type
Some MATLAB functions also use the built-in == operator in their implementation.
Therefore, your implementation of eq should be replaceable with the built-in eq to enable
objects of your class work like built-in types in MATLAB code.
Design of eq
Implement the eq method to returns a logical array representing the result of the ==
comparison.
For example, the SwitchOnVer class implements an eq method that returns true
for the == operation if the value of the Version property is the same for both objects.
In addition, eq works with arrays the same way as the built-in eq. For the following
expression:
obj1 == obj2

The eq method works like this:

If both obj1 and obj2 are scalar, eq returns a scalar value.
If both obj1 and obj2 are nonscalar arrays, then these arrays must have the same
dimensions, and eq returns an array of the same size.
If one input argument is scalar and the other is a nonscalar array, then eq treats the
scalar object as if it is an array having the same dimensions as the nonscalar array.
5-36

Objects In Conditional Statements

Implementation of eq
Here is a class that implements an eq method. Ensure your implementation contains
appropriate error checking for the intended use.
classdef SwitchOnVer
properties
Version
end
methods
function obj = SwitchOnVer(ver)
if nargin > 0
obj.Version = ver;
end
end
function bol = eq(obj1,obj2)
if ~strcmp(class(obj1),class(obj2))
error('Objects are not of the same class')
end
s1 = numel(obj1);
s2 = numel(obj2);
if s1 == s2
bol = false(size(obj1));
for k=1:s1
if obj1(k).Version == obj2(k).Version
bol(k) = true;
else
bol(k) = false;
end
end
elseif s1 == 1
bol = scalarExpEq(obj2,obj1);
elseif s2 == 1
bol = scalarExpEq(obj1,obj2);
else
error('Dimension missmatch')
end
function ret = scalarExpEq(ns,s)
% ns is nonscalar array
% s is scalar array
ret = false(size(ns));
n = numel(ns);
for kk=1:n
if ns(kk).Version == s.Version

5-37

Class DefinitionSyntax Reference

ret(kk) = true;
else
ret(kk) = false;
end
end
end
end
end
end

Use SwitchOnVer objects in switch statements:

% Create known versions of objects
ov1 = SwitchOnVer(1.0);
ov2 = SwitchOnVer(2.0);
ov3 = SwitchOnVer(3.0);
...
...
if isscalar(objIn)
switch(objIn)
case ov1
disp('This is version 1.0')
case ov2
disp('This is version 2.0')
case ov3
disp('This is version 3.0')
otherwise
disp('There is no version')
end
else
error('Input object must be scalar')
end

Enumerations in Switch Statements

MATLAB enables you to use enumerations in switch statements without requiring an
explicitly defined eq method for the enumeration class.
For example, the WeeklyPlanner class defines enumerations for five days of the week.
The switch/case statements in the todaySchedule static method dispatch on the
enumeration member corresponding to the current day of the week. The date and
datestr functions return a char vector with the name of the current day.
5-38

Objects In Conditional Statements

classdef WeeklyPlanner
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday
end
methods (Static)
function todaySchedule
dayName = datestr(date,'dddd');
dayEnum = WeeklyPlanner.(dayName);
switch dayEnum
case WeeklyPlanner.Monday
disp('Monday schedule')
case WeeklyPlanner.Tuesday
disp('Tuesday schedule')
case WeeklyPlanner.Wednesday
disp('Wednesday schedule')
case WeeklyPlanner.Thursday
disp('Thursday schedule')
case WeeklyPlanner.Friday
disp('Friday schedule')
end
end
end
end

Call todaySchedule to display todays schedule:

WeeklyPlanner.todaySchedule

Enumerations Derived from Built-In Types

Enumeration classes that derived from built-in types inherit the superclass eq method.
For example, the FlowRate class derives from int32:
classdef FlowRate < int32
enumeration
Low
(10)
Medium (50)
High
(100)
end
end

The switchEnum function switches on the input argument, which can be a FlowRate
enumeration value.
function switchEnum(inpt)

5-39

Class DefinitionSyntax Reference

switch inpt
case 10
disp('Flow = 10 cfm')
case 50
disp('Flow = 50 cfm')
case 100
disp('Flow = 100 cfm')
end
end

Call switchEnum with an enumerated value:

switchEnum(FlowRate.Medium)
Flow = 50 cfm

5-40

Operations on Objects

Operations on Objects
In this section...
Object Operations on page 5-41
Help on Objects on page 5-42
Functions to Test Objects on page 5-44
Functions to Query Class Components on page 5-44

Object Operations
A fundamental purpose of objects is to contain data and facilitate ways to manipulate
that data. Objects often define their own version of ordinary MATLAB functions that
work with the object. For example, you can create a timeseries object and pass the object
to plot:
ts = timeseries(rand(100,1),.01:.01:1,'Name','Data1');
plot(ts)

5-41

Class DefinitionSyntax Reference

However, MATLAB does not call the standard plot function. MATLAB calls the
timeseries plot method, which can extract the data from the timeseries object and
create a customized graph.

Help on Objects
Suppose you use an audioplayer object to play audio with MATLAB. To do this, load
audio data into MATLAB and create an audioplayer:
load('handel','Fs','y')
chorus = audioplayer(y,Fs);

5-42

Operations on Objects

The audioplayer function creates an object that you access using the object variable
chorus. MATLAB stores the audio source and other information in the object properties.
Here are the properties and values for thechorus instance of the audioplayer:
chorus
chorus =

Click the link to get the documentation on audioplayer objects.

The objects documentation discusses the purpose of the object and describes the
properties and methods that you use when working with objects of that class.
You can also list the methods to see what operations you can perform. Pass the object to
the methods function to see the list:
methods(chorus)
Methods for class audioplayer:
audioplayer

getdisp

pause

resume

stop

5-43

Class DefinitionSyntax Reference

delete
get

horzcat
isplaying

play
playblocking

set
setdisp

vertcat

To play the audio, use the play method:

play(chorus)

Functions to Test Objects

These functions provide logical tests, which are useful when using objects in ordinary
functions.
Function

Description

isa

Determine whether an argument is an object of specific class.

isequal

Determine if two objects are equal, which means both objects are of
the same class and size and their corresponding property values are
equal.

a == b (eq)

Determine if handle variable a refers to the same object as handle

variable b.

isobject

Determine whether input is a MATLAB object

Functions to Query Class Components

These functions provide information about object class components.

5-44

Function

Description

class

Return class of object.

enumeration

Display class enumeration members and names.

events

List event names defined by the class.

methods

List methods implemented by the class.

methodsview

List methods in separate window.

properties

List class property names.

Use of Editor and Debugger with Classes

Use of Editor and Debugger with Classes

In this section...
Write Class Code in the Editor on page 5-45
How to Refer to Class Files on page 5-45
How to Debug Class Files on page 5-46

Write Class Code in the Editor

The MATLAB code editor provides an effective environment for class development.
The Code Analyzer, which is built into the editor, check code for problems and provides
information on fixing these problems. For information on editor use and features, see
Code Editor.

How to Refer to Class Files

Define classes in files just like scripts and functions. To use the editor or debugger with a
class file, use the full class name. For example, suppose the file for a class, myclass.m is
in the following location:
+PackFld1/+PackFld2/@myclass/myclass.m

To open myclass.m in the MATLAB editor, you could reference the file using dotseparated package names:
edit PackFld1.PackFld2.myclass

You could also use path notation:

edit +PackFld1/+PackFld2/@myclass/myclass

If myclass.m is not in a class folder, then enter:

edit +PackFld1/+PackFld2/myclass

To refer to functions inside a package folder, use dot or path separators:

edit PackFld1.PackFld2.packFunction
edit +PackFld1/+PackFld2/packFunction

To refer to a function defined in its own file inside of a class folder, use:
5-45

Class DefinitionSyntax Reference

edit +PackFld1/+PackFld2/@myclass/myMethod

How to Debug Class Files

For debugging, dbstop accepts any of the file specifications used by the edit command.
See Automatic Updates for Modified Classes on page 5-47 for information about
clearing class.

Related Examples

5-46

MATLAB Code Analyzer Warnings on page 5-32

Automatic Updates for Modified Classes

Automatic Updates for Modified Classes

In this section...
When MATLAB Loads Class Definitions on page 5-47
Consequences of Automatic Update on page 5-48
What Happens When Class Definitions Change on page 5-48
Actions That Do Not Trigger Updates on page 5-49
Multiple Updates to Class Definitions on page 5-49
Object Validity with Deleted Class File on page 5-49
When Updates Are Not Possible on page 5-49
Potential Consequences of Class Updates on page 5-50
Updates to Class Attributes on page 5-50
Updates to Property Definitions on page 5-51
Updates to Method Definitions on page 5-52
Updates to Event Definitions on page 5-53

When MATLAB Loads Class Definitions

MATLAB loads a class definition:
The first time the class is referenced, such as creating an instance, accessing a
constant property, or calling a static method of the class.
Whenever the definition of a loaded class changes and MATLAB returns to the
command prompt.
When you change the MATLAB path and cause a different definition of the class to be
used.
Whenever you access the class metadata.
MATLAB allows only one definition for a class to exist at any time. Therefore, MATLAB
attempts to update all existing objects of a class automatically to conform to the new
class definition. You do not need to call clear classes to remove existing objects when
you change their defining class.

5-47

Class DefinitionSyntax Reference

Note: Using an editor other than the MATLAB editor or using MATLAB Online can
result in delays to automatic updating.

Consequences of Automatic Update

MATLAB follows a set of basic rules when updating existing objects. An automatic
update can result in:
Existing objects being updated to the new class definition.
An error if MATLAB cannot convert the objects to the new class definition or if there
is an error in the class definition itself.
Here is an example of what happens when you create an instance of a concrete class edit
the class definition to make the class abstract.
a = MyClass;
% Edit MyClass to make it Abstract
a
Error using MyClass/display
Cannot update object because the class 'MyClass' is now abstract.

Note: MATLAB does not update metaclass instances when you change the definition of a
class. You must get new metaclass data after updating a class definition.

What Happens When Class Definitions Change

MATLAB updates existing objects when a class definition changes, including the
following situations:
Value change to handle Existing objects become independent handles referring to
different objects.
Enumeration member added Existing objects preserve the enumeration members
they had previously, even if the underlying values have changed.
Enumeration member removed Existing objects that are not using the removed
member have the same enumeration members that they had previously. Existing
objects that use the removed member replace the removed member with the default
member of the enumeration.
5-48

Automatic Updates for Modified Classes

Enumeration block removed Enumeration members are taken out of use.

Superclass definition changed Changes applied to all subclasses in the hierarchy of
that superclass.
Superclass added or removed Change of superclass applied to all existing objects.

Actions That Do Not Trigger Updates

These actions do not update existing objects:
Calling the class function on an out-of-date object
Assigning an out-of-date object to a variable
Calling a method that does not access class data
Objects do not update until referenced in a way that exposes the change, such as
invoking the object display.

Multiple Updates to Class Definitions

Updates do not occur incrementally. Updates conform to the latest version of the class.

Object Validity with Deleted Class File

Deleting a class definition file does not make instances of that class invalid. However,
you cannot call methods on existing objects of that class.

When Updates Are Not Possible

Some class updates result in an invalid class definition. In these cases, objects do not
update until the error is resolved:
Adding a superclass can result in a property or method being defined twice.
Changing a superclass to be Sealed when objects of one of its subclasses exists
results in an invalid subclass definition.
Some class updates cause situations in which MATLAB cannot update existing objects
to conform to a modified class definition. These cases result in errors until you delete the
objects:
Adding an enumeration block to a non-enumeration class
5-49

Class DefinitionSyntax Reference

Redefining a class to be abstract

Removing a class from a heterogeneous hierarchy that results in there being no
default object to replace existing objects in a heterogeneous array
Updating a class to restrict array formation behavior, such as overloading array
indexing and concatenation.
Inheriting a subsref, subsasgn, cat, vertcat, or horzcat method
Redefining a handle class to be a value class.

Potential Consequences of Class Updates

Following an update, existing objects can be incompatible with the new class
definition. For example, a newly added property can require execution of the
constructor to be valid.
Removing or renaming properties can lose the data held in the property. For example,
if a property holds the only reference to another object and you remove that property
from the class, the MATLAB deletes the object because there are no longer any
references to it.
Removing a class from a heterogeneous class hierarchy can result in invalid
heterogeneous array elements. In this case, the default object for the heterogeneous
hierarchy replaces these array elements.

Updates to Class Attributes

Changing class attributes can change existing object behavior or make the objects
invalid. MATLAB returns an error when you access the invalid objects.
Change

Effect

Make Abstract = true

Accessing existing objects returns an error.

Change AllowedSubclasses Newly created objects can inherit from different

superclasses than existing objects.

5-50

Change ConstructOnLoad

Loading classes obeys the current value of

ConstructOnLoad.

Change HandleCompatible

Newly created objects can have different class hierarchy

than existing objects.

Change Hidden

Appearance of class in list of superclasses and access by

help function can change

Automatic Updates for Modified Classes

Change

Effect

Change InferiorClasses

Method dispatching for existing objects can change.

Make Sealed = true

Existing subclass objects return errors when accessed.

Updates to Property Definitions

When you change the definition of class properties, MATLAB applies the changes to
existing objects of the class.
Change

Effect

Add property

Adds the new property to existing objects of the class.

Sets the property values to the default value (which is
[] if the class definition does not specify a default).

Remove property

Removes the property from existing objects of the class.

Attempts to access the removed property fail.

Change property default value Does not apply the new default value to existing objects
of the class.
Move property between
subclass and superclass

Does not apply different default value when property

definition moves between superclass and subclass.

Change property attribute

value

Applies changes to existing objects of the class.

Some cases require transitional steps:
Abstract Existing objects of a class that becomes
abstract cannot be updated. Delete these objects.
Access Changes to the public, protected, or
private property access settings affect access to
existing objects.
Changes to the access lists do not change existing
objects. However, if you add classes to the access
list, instances of those classes have access to this
property. If you remove classes from the access list,
objects of those classes no longer have access to this
property.
Dependent If changed to true, existing objects
no longer store property values. If you want to query
5-51

Class DefinitionSyntax Reference

Change

Effect
the property value, add a property get method for
the property.
Transient If changed to true, objects already
saved, reload this property value. If changed to
false, objects already saved reload this property
using the default value.

Updates to Method Definitions

When you change the definition of class methods, MATLAB changes the affected class
member in existing objects as follows.
Change

Effect

Add method

You can call the new method on existing objects of the

class.

Modify method

Modifications are available to existing objects.

Remove method

You can on longer call deleted method on existing

objects.

Change method attribute

value

Apply changes to existing objects of the class.

Some cases require transitional steps:
Abstract Existing objects of a class that becomes
abstract cannot be updated. Delete these objects.
Access Changes to method public, protected,
or private access settings affect access to existing
objects.
Changes to the access lists do not change existing
instances. However, if you add classes to the access
list, instances of those classes have access to this
method. If you remove classes from the access list,
objects of those classes no longer have access to this
method.
Sealed If changed to true and existing
subclasses already have defined the method,

5-52

Automatic Updates for Modified Classes

Change

Effect
MATLAB returns an error because the new class
definition cannot be applied to existing subclasses.

Updates to Event Definitions

Change

Effect

Add event

Existing objects of the class support the new event.

Change event name

New event name is visible to existing objects of the

class. MATLAB:
Does not update existing metaclass objects
Does update newly acquired metaclass objects
Does not update listeners to use new event name

Remove event

Existing objects no longer support deleted event.

Change event attribute value

Apply changes to existing objects of the class.

Some cases require transitional steps:
ListenAccess Changes to event public,
protected, or private listen access settings affect
access to existing objects.
Changes to the access list do not change existing
objects. However, if you add classes to the access
list, objects of those classes can create listeners for
this event. If you remove classes from the access
list, objects of those classes are not allowed to create
listeners for this event.
NotifyAccess Changes to event public,
protected, or private notify access settings affect
access to existing objects.
Changes to the access list do not change existing
objects. However, if you add classes to the access list,
instances of those classes can trigger this event. If
5-53

Class DefinitionSyntax Reference

Change

Effect
you remove classes, objects of those classes are not
able to trigger this event.

Related Examples

5-54

Use of Editor and Debugger with Classes on page 5-45

Compatibility with Previous Versions

Compatibility with Previous Versions

In this section...
New Class-Definition Syntax Introduced with MATLAB Software Version 7.6 on page
5-55
Changes to Class Constructors on page 5-56
New Features Introduced with Version 7.6 on page 5-56
Examples of Old and New on page 5-57

New Class-Definition Syntax Introduced with MATLAB Software Version

7.6
MATLAB software Version 7.6 introduces a new syntax for defining classes. This new
syntax includes:
The classdef keyword begins a block of class-definitions code. An end statement
terminates the class definition.
Within the classdef code block, properties, methods, and events are also
keywords delineating where you define the respective class members.
Cannot Mix Class Hierarchy
It is not possible to create class hierarchies that mix classes defined before Version 7.6
and current class definitions that use classdef. Therefore, you cannot subclass an old
class to create a version of the new class.
Only One @ Class Folder per Class
For classes defined using the new classdef keyword, a class folder shadows all class
folders that occur after it on the MATLAB path. Classes defined in class folders must
locate all class files in that single folder. However, classes defined in class folders
continue to take precedence over functions and scripts having the same name, even those
functions and scripts that come before them on the path.
Private Methods
You do not need to define private folders in class folders in Version 7.6. You can set the
method's Access attribute to private instead.
5-55

Class DefinitionSyntax Reference

Changes to Class Constructors

Class constructor methods have two major differences. Class constructors:
Do not use the class function.
Must call the superclass constructor only if you want to pass arguments to its
constructor. Otherwise, no call to the superclass constructor is necessary.
Example of Old and New Syntax
Compare the following two Stock constructor methods. The Stock class is a subclass of
the Asset class, which requires arguments passed to its constructor.
Constructor Function Before Version 7.6
function s = Stock(description,num_shares,share_price)
s.NumShares = num_shares;
s.SharePrice = share_price;
% Construct Asset object
a = Asset(description,'stock',share_price*num_shares);
% Use the class function to define the stock object
s = class(s,'Stock',a);

Write the same Stock class constructor as shown here. Define the inheritance on the
classdef line and define the constructor within a methods block.
Constructor Function for Version 7.6
classdef Stock < Asset
...
methods
function s = Stock(description,num_shares,share_price)
% Call superclass constructor to pass arguments
s = s@Asset(description,'stock',share_price*num_shares);
s.NumShares = num_shares;
s.SharePrice = share_price;
end % End of function
end % End of methods block
end % End of classdef block

New Features Introduced with Version 7.6

5-56

Compatibility with Previous Versions

Properties: How to Use Properties on page 8-2

Handle classes: Comparison of Handle and Value Classes on page 7-2
Events and listeners: Event and Listener Concepts on page 11-14
Class member attributes: Attribute Specification on page 5-22
Abstract classes: Abstract Classes on page 12-82
Dynamic properties: Dynamic Properties Adding Properties to an Instance on
page 8-41
Ability to subclass MATLAB built-in classes: Create Subclasses Syntax and
Techniques on page 12-7
Packages for scoping functions and classes: Packages Create Namespaces on page
6-24. MATLAB does not support packages for classes created before MATLAB
Version 7.6 (that is, classes that do not use classdef).
The JIT/Accelerator supports objects defined only by classes using classdef.

Examples of Old and New

The MATLAB Version 7.6 implementation of classes uses different syntax from previous
releases. However, classes written in previous versions continue to work. Most of the code
you use to implement the methods is likely to remain the same, except where you take
advantage of new features.
The following sections reimplement examples using the latest syntax. The original
MATLAB Classes and Objects documentation implemented these same examples and
provide a comparison of old and new syntax.
Class Design for Polynomials on page 19-2
A Simple Class Hierarchy on page 20-2
Containing Assets in a Portfolio on page 20-20

5-57

Class DefinitionSyntax Reference

Comparison of MATLAB and Other OO Languages

In this section...
Some Differences from C++ and Java Code on page 5-58
Object Modification on page 5-59
Static Properties on page 5-63
Common Object-Oriented Techniques on page 5-64

Some Differences from C++ and Java Code

The MATLAB programming language differs from other object-oriented languages, such
as C++ or Java in some important ways.
Public Properties
Unlike fields in C++ or the Java language, you can use MATLAB properties to define
a public interface separate from the implementation of data storage. You can provide
public access to properties because you can define set and get access methods that
execute automatically when assigning or querying property values. For example, the
following statement:
myobj.Material = 'plastic';

assigns the char vector plastic to the Material property of myobj. Before making
the actual assignment, myobj executes a method called set.Material (assuming the
class of myobj defines this method), which can perform any necessary operations. See
Property Access Methods on page 8-23 for more information on property access
methods.
You can also control access to properties by setting attributes, which enable public,
protected , or private access. See Property Attributes on page 8-7 for a full list of
property attributes.
No Implicit Parameters
In some languages, one object parameter to a method is always implicit. In MATLAB,
objects are explicit parameters to the methods that act on them.
5-58

Comparison of MATLAB and Other OO Languages

Dispatching
In MATLAB classes, method dispatching is not based on method signature, as it is in C+
+ and Java code. When the argument list contains objects of equal precedence, MATLAB
uses the left-most object to select the method to call.
However, if the class of an argument is superior to the class of the other arguments,
MATLAB dispatches to the method of the superior argument, regardless of its position
within the argument list.
See Class Precedence on page 6-22 for more information.
Calling Superclass Method
In C++, you call a superclass method using the scoping operator:
superclass::method
In Java code, you use: superclass.method
The equivalent MATLAB operation is method@superclass.
Other Differences
In MATLAB classes, there is no equivalent to C++ templates or Java generics. However,
MATLAB is weakly typed and it is possible to write functions and classes that work with
different types of data.
MATLAB classes do not support overloading functions using different signatures for the
same function name.

Object Modification
MATLAB classes can define public properties, which you can modify by explicitly
assigning values to those properties on a given instance of the class. However, only
classes derived from the handle class exhibit reference behavior. Modifying a property
value on an instance of a value classes (classes not derived from handle), changes the
value only within the context in which the modification is made.
The sections that follow describe this behavior in more detail.
Objects Passed to Functions
MATLAB passes all variables by value. When you pass an object to a function, MATLAB
copies the value from the caller into the parameter variable in the called function.
5-59

Class DefinitionSyntax Reference

However, MATLAB supports two kinds of classes that behave differently when copied:
Handle classes a handle class instance variable refers to an object. A copy of a
handle class instance variable refers to the same object as the original variable. If
a function modifies a handle object passed as an input argument, the modification
affects the object referenced by both the original and copied handles.
Value classes the property data in an instance of a value class are independent of
the property data in copies of that instance (although, a value class property could
contain a handle). A function can modify a value object that is passed as an input
argument, but this modification does not affect the original object.
See Comparison of Handle and Value Classes on page 7-2 for more information on
the behavior and use of both kinds of classes.
Passing Value Objects

When you pass a value object to a function, the function creates a local copy of the
argument variable. The function can modify only the copy. If you want to modify the
original object, return the modified object and assign it to the original variable name. For
example, consider the value class, SimpleClass :
classdef SimpleClass
properties
Color
end
methods
function obj = SimpleClass(c)
if nargin > 0
obj.Color = c;
end
end
end
end

Create an instance of SimpleClass, assigning a value of red to its Color property:

obj = SimpleClass('red');

Pass the object to the function g, which assigns blue to the Color property:
function y = g(x)
x.Color = 'blue';
y = x;
end

5-60

Comparison of MATLAB and Other OO Languages

y = g(obj);

The function g modifies its copy of the input object and returns that copy, but does not
change the original object.
y.Color
ans =
blue
obj.Color
ans =
red

If the function g did not return a value, the modification of the object Color property
would have occurred only on the copy of obj within the function workspace. This copy
would have gone out of scope when the function execution ended.
Overwriting the original variable actually replaces it with a new object:
obj = g(obj);
Passing Handle Objects

When you pass a handle to a function, the function makes a copy of the handle variable,
just like when passing a value object. However, because a copy of a handle object refers to
the same object as the original handle, the function can modify the object without having
to return the modified object.
For example, suppose you modify the SimpleClass class definition to make a class
derived from the handle class:
classdef SimpleHandleClass < handle
properties
Color
end
methods
function obj = SimpleHandleClass(c)
if nargin > 0
obj.Color = c;
end
end

5-61

Class DefinitionSyntax Reference

end
end

Create an instance of SimpleHandleClass, assigning a value of red to its Color

property:
obj = SimpleHandleClass('red');

Pass the object to the function g, which assigns blue to the Color property:
y = g(obj);

The function g sets the Color property of the object referred to by both the returned
handle and the original handle:
y.Color
ans =
blue
obj.Color
ans =
blue

The variables y and obj refer to the same object:

y.Color = 'yellow';
obj.Color
ans =
yellow

The function g modified the object referred to by the input argument (obj) and returned
a handle to that object in y.
MATLAB Passes Handles by Value

A handle variable is a reference to an object. MATLAB passes this reference by value.

Handles do not behave like references in C++. If you pass an object handle to a function
and that function assigns a different object to that handle variable, the variable in the
caller is not affected. For example, suppose you define a function g2:
5-62

Comparison of MATLAB and Other OO Languages

function y = g2(x)
x = SimpleHandleClass('green');
y = x;
end

Pass a handle object to g2:

obj = SimpleHandleClass('red');
y = g2(obj);
y.Color
ans =
green
obj.Color
ans =
red

The function overwrites the handle passed in as an argument, but does not overwrite
the object referred to by the handle. The original handle obj still references the original
object.

Static Properties
In MATLAB, classes can define constant properties, but not "static" properties in the
sense of other languages like C++. You cannot change constant properties from the initial
value specified in the class definition.
MATLAB has long-standing rules that variables always take precedence over the names
of functions and classes. Assignment statements introduce a variable if one does not
exist.
Expressions of this form
A.B = C

Introduce a new variable, A, that is a struct containing a field B whose value is C. If A.B
= C could refer to a static property of class A, then class A would take precedence over
variable A.
5-63

Class DefinitionSyntax Reference

This behavior would be a significant incompatibility with prior releases of MATLAB.

For example, the introduction of a class named A on the MATLAB path could change the
meaning of an assignment statement like A.B = C inside a .m code file.
In other languages, classes rarely use static data, except as private data within the
class or as public constants. In MATLAB, you can use constant properties the same way
you use public final static fields in Java. To use data that is internal to a class in
MATLAB, create persistent variables in private or protected methods or local functions
used privately by the class.
Avoid static data in MATLAB. If a class has static data, using the same class in multiple
applications causes conflicts among applications. Conflicts are less of an issue in some
other languages. These languages compile applications into executables that run in
different processes. Each process has its own copy of the class static data. MATLAB,
frequently runs many different applications in the same process and environment with a
single copy of each class.
For ways to define and use static data in MATLAB, see Static Data on page 4-2.

Common Object-Oriented Techniques

This table provides links to sections that discuss object-oriented techniques commonly
used by other object-oriented languages.

5-64

Technique

How to Use in MATLAB

Operator overloading

Operator Overloading on page 17-48

Multiple inheritance

Subclass Multiple Classes on page 12-20

Subclassing

Create Subclasses Syntax and Techniques on page

12-7

Destructor

Handle Class Destructor on page 7-16

Data member scoping

Property Attributes on page 8-7

Packages (scoping
classes)

Packages Create Namespaces on page 6-24

Named constants

See Properties with Constant Values on page 15-2 and

Named Values on page 14-2

Enumerations

Define Enumeration Classes on page 14-5

Static methods

Static Methods on page 9-28

Comparison of MATLAB and Other OO Languages

Technique

How to Use in MATLAB

Static properties

Not supported. See persistent variables. For the equivalent

of Java static final or C++ static const properties, use
Constant properties. See Properties with Constant Values
on page 15-2
For mutable static data, see Static Data on page 4-2

Constructor

Class Constructor Methods on page 9-20

Copy constructor

No direct equivalent

Reference/reference
classes

Comparison of Handle and Value Classes on page 7-2

Abstract class/Interface

Abstract Classes on page 12-82

Garbage collection

Object Lifecycle on page 7-18

Instance properties

Dynamic Properties Adding Properties to an Instance on

page 8-41

Importing classes

Import Classes on page 6-29

Events and Listeners

Event and Listener Concepts on page 11-14

5-65

6
Defining and Organizing Classes
User-Defined Classes on page 6-2
Class Attributes on page 6-6
Evaluation of Expressions in Class Definitions on page 6-9
Folders Containing Class Definitions on page 6-16
Class Precedence on page 6-22
Packages Create Namespaces on page 6-24
Import Classes on page 6-29

Defining and Organizing Classes

User-Defined Classes
In this section...
What Is a Class Definition on page 6-2
Attributes for Class Members on page 6-2
Kinds of Classes on page 6-3
Constructing Objects on page 6-3
Class Hierarchies on page 6-3
classdef Syntax on page 6-3
Class Code on page 6-4

What Is a Class Definition

A MATLAB class definition is a template whose purpose is to provide a description of
all the elements that are common to all instances of the class. Class members are the
properties, methods, and events that define the class.
Define MATLAB classes in code blocks, with subblocks delineating the definitions of
various class members. For syntax information on these blocks, see Class Components
on page 5-5.

Attributes for Class Members

Attributes modify the behavior of classes and the members defined in the class-definition
block. For example, you can specify that methods are static or that properties are private.
The following sections describe these attributes:
Class Attributes on page 6-6
Method Attributes on page 9-5
Property Attributes on page 8-7
Event Attributes on page 11-19
Class definitions can provide information, such as inheritance relationships or the names
of class members without actually constructing the class. See Class Metadata on page
16-2.
6-2

User-Defined Classes

See Specifying Attributes on page 6-7 for more on attribute syntax.

Kinds of Classes
There are two kinds of MATLAB classeshandle classes and value classes.
Value classes represent independent values. Value objects contain the object data and
do not share this data with copies of the object. MATLAB numeric types are value
classes. Values objects passed to and modified by functions must return a modified
object to the caller.
Handle classes create objects that reference the object data. Copies of the instance
variable refer to the same object. Handle objects passed to and modified by functions
affect the object in the callers workspace without returning the object.
For more information, see Comparison of Handle and Value Classes on page 7-2.

Constructing Objects
For information on class constructors, see Class Constructor Methods on page 9-20.
For information on creating arrays of objects, see Construct Object Arrays on page
10-2.

Class Hierarchies
For more information on how to define class hierarchies, see Hierarchies of Classes
Concepts on page 12-2.

classdef Syntax
Class definitions are blocks of code that are delineated by the classdef keyword at the
beginning and the end keyword at the end. Files can contain only one class definition.
The following diagram shows the syntax of a classdef block. Only comments and blank
lines can precede the classdef keyword.

6-3

Defining and Organizing Classes

classdef keyword begins definition block.

classdef (ConstructOnLoad = true) PositiveIntegers < Integers & Positives

...
end
classdef block

Class attribute

Attribute value
(logical true)

Class name

Super classes

end keyword terminates definition block.

Class Code
Here is a simple class definition with one property and a constructor method that sets
the value of the property when there is an input argument supplied.
classdef MyClass
properties
Prop
end
methods
function obj = MyClass(val)
if nargin > 0
obj.Prop = val;
end
end
end

To create an object of MyClass, save the class definition in a .m file having the same
name as the class and call the constructor with any necessary arguments:
d = datestr(now);
o = MyClass(d);

Use dot notation to access the property value:

6-4

User-Defined Classes

o.Prop
ans =
10-Nov-2005 10:38:14

The constructor should support a no argument syntax so MATLAB can create default
objects. For more information, see No Input Argument Constructor Requirement on
page 9-22.
For more information on the components of a class definition, see Class Components on
page 5-5

Related Examples

A Simple Class on page 2-2

Developing Classes Typical Workflow on page 3-8

Class to Represent Structured Data on page 3-24

6-5

Defining and Organizing Classes

Class Attributes
In this section...
Specifying Class Attributes on page 6-6
Specifying Attributes on page 6-7

Specifying Class Attributes

All classes support the attributes listed in the following table. Attributes enable you
to modify the behavior of class. Attribute values apply to the class defined within the
classdef block.
classdef (Attribute1 = value1, Attribute2 = value2,...) ClassName
...
end

For more information on attribute syntax, see Attribute Specification on page 5-22.
Class Attributes
Attribute Name

Class

Description

Abstract

logical

If specified as true, this class is an abstract class (cannot be

instantiated).

(default =
false)
AllowedSubclassesmeta.class
object or
cell array of
meta.class
objects

See Abstract Classes on page 12-82 for more

information.
List classes that can subclass this class. Specify subclasses as
meta.class objects in the form:
A single meta.class object
A cell array of meta.class objects. An empty cell array,
{}, is the same as a Sealed class (no subclasses).
Specify meta.class objects using the ?ClassName syntax
only.
See Specify Allowed Subclasses on page 12-22 for more
information.

6-6

Class Attributes

Attribute Name

Class

Description

ConstructOnLoad

logical

If true, MATLAB calls the class constructor when loading an

object from a MAT-file. Therefore, implement the constructor
so it can be called with no arguments without producing an
error.

(default =
false)

See Initialize Objects When Loading on page 13-28 for

more information.
HandleCompatible logical
(default =
false) for
value classes
Hidden

logical
(default =
false)

InferiorClasses

meta.class
object or
cell array of
meta.class
objects

If specified as true, this class can be used as a superclass for

handle classes. All handle classes are HandleCompatible by
definition. See Support Both Handle and Value Subclasses
on page 12-36 for more information.
If true, this class does not appear in the output of the
superclasses or help functions.
Use this attribute to establish a precedence relationship
among classes. Specify a cell array of meta.class objects
using the ? operator.
The fundamental classes are always inferior to user-defined
classes and do not show up in this list.
See Class Precedence on page 6-22 and Dominant
Argument in Overloaded Graphics Functions on page
9-46.

Sealed

logical

If true, this class cannot be subclassed.

(default =
false)

Specifying Attributes
Attributes are specified for class members in the classdef, properties, methods, and
events definition blocks. The particular attribute setting applies to all members defined
within that particular block. You can use multiple properties definition blocks to apply
different attribute setting to different properties.
6-7

Defining and Organizing Classes

Superclass Attributes Are Not Inherited

Class attributes are not inherited, so superclass attributes do not affect subclasses.
Attribute Syntax
Specify class attribute values in parentheses, separating each attribute name/attribute
value pair with a comma. The attribute list always follows the classdef or class
member keyword, as shown:
classdef (attribute-name = expression, ...) ClassName
properties (attribute-name = expression, ...)
...
end
methods (attribute-name = expression, ...)
...
end
events (attribute-name = expression, ...)
...
end
end

More About

6-8

Expressions in Attribute Specifications on page 6-10

Evaluation of Expressions in Class Definitions

Evaluation of Expressions in Class Definitions

In this section...
Why Use Expressions on page 6-9
Where to Use Expressions in Class Definitions on page 6-9
How MATLAB Evaluates Expressions on page 6-12
When MATLAB Evaluates Expressions on page 6-12
Expression Evaluation in Handle and Value Classes on page 6-12

Why Use Expressions

An expression used in a class definition can be any valid MATLAB statement that
evaluates to a single array. Use expressions to define property default values and in
attribute specifications. Expressions are useful to derive values in terms of other values.
For example, suppose you want to define a constant property with the full precision value
of 2. You can assign the property the value returned by the expression 2*pi. MATLAB
evaluates the function the when first loading the class.
For information on assign property default values and attribute values, see the following
topics:
Defining Properties on page 8-13
Attribute Specification on page 5-22

Where to Use Expressions in Class Definitions

Here are some examples of expressions used in a class definition:
classdef MyClass
% Some attributes are set to logical values
properties (Constant = true)
CnstProp = 2*pi;
end
properties
% Static method of this class
Prop1 = MyClass.setupAccount;
% Constant property from this class
Prop2 = MyClass.CnstProp;
% Function that returns a value

6-9

Defining and Organizing Classes

Prop3 = datestr(now)
% A class constructor
Prop4 = AccountManager;
end
methods (Static)
function accNum = setupAccount
accNum = randi(9,[1,12]);
end
end
end

MATLAB does not call property set methods when assigning the result of default
value expressions to properties. (See Property Access Methods on page 8-23 for
information about these special methods.)
Enumerations that derived from MATLAB types can use expression to assign a value:
classdef FlowRate < int32
enumeration
Low
(10)
Medium (FlowRate.Low*5)
High
(FlowRate.Low*10)
end
end

MATLAB evaluates these expressions only once when enumeration members are first
accessed.
Expressions in Attribute Specifications
For attributes values that are logical true or false, class definitions can specify
attribute values using expressions. For example, this assignment makes MyClass sealed
(cannot be subclassed) for versions of MATLAB before R2014b (verLessThan)
classdef

(Sealed = verLessThan('matlab','R2014b')) MyClass

The expression on the right side of the equal sign (=) must evaluate to true or false.
You cannot use any definitions from the class file in this expression, including any
constant properties, static methods, and local functions.
While you can use conditional expression to set attribute values, doing so can cause the
class definition to change based on external conditions. Ensure that this behavior is
consistent with your class design.
6-10

Evaluation of Expressions in Class Definitions

Note: The AllowedSubclasses and the InferiorClasses attributes require an

explicit specification of a cell array of meta.class objects as their values. You cannot
use expressions to return these values.
See Attribute Specification on page 5-22 for more information on attribute syntax.
Expressions That Specify Default Property Values
Property definitions allow you to specify default values for properties using any
expression that has no reference to variables. For example, VectorAngle defines a
constant property (Rad2Deg) and uses it in an expression that defines the default value
of another property (Angle). The default value expression also uses a static method
(getAngle) defined by the class:
classdef VectorAngle
properties (Constant)
Rad2Deg = 180/pi;
end
properties
Angle = VectorAngle.Rad2Deg*VectorAngle.getAngle([1 0],[0 1]);
end
methods
function obj = VectorAngle(vx,vy)
obj.Angle = VectorAngle.getAngle(vx,vy);
end
end
methods (Static)
function r = getAngle(vx,vy)
% Calculate angle between 2D vectors
cr = vx(1)*vy(1) + vx(2)*vy(2)/sqrt(vx(1)^2 + vx(2)^2) * ...
sqrt(vy(1)^2 + vy(2)^2);
r = acos(cr);
end
end
end

You cannot use the input variables to the constructor to define the default value of the
Angle property. For example, this definition for the Angle property is not valid:
properties
Angle = VectorAngle.Rad2Deg*VectorAngle.getAngle(vx,vy);
end

6-11

Defining and Organizing Classes

Attempting to create an instance causes an error:

a = VectorAngle([1,0],[0,1])
Error using VectorAngle
Unable to update the class 'VectorAngle' because the new definition contains an
error:
Undefined function or variable 'vx'.

Expressions in Class Methods

Expression in class methods execute like expressions in any function. MATLAB evaluates
an expression within the function workspace when the method executes. Therefore,
expressions used in class methods are not considered part of the class definition and are
not discussed in this section.

How MATLAB Evaluates Expressions

MATLAB evaluates the expressions used in the class definition without any workspace.
Therefore, these expressions cannot reference variables of any kind.
MATLAB evaluates expressions in the context of the class file, so these expressions can
access any functions, static methods, and constant properties of other classes that are
on your path at the time MATLAB initializes the class. Expressions defining property
default values can access constant properties defined in their own class.

When MATLAB Evaluates Expressions

MATLAB evaluates the expressions in class definitions only when initializing the class.
Initialization occurs before the first use of the class.
After initialization, the values returned by these expressions are part of the class
definition and are constant for all instances of the class. Each instance of the class uses
the results of the initial evaluation of the expressions without re-evaluation.
If you clear a class, then MATLAB reinitializes the class by reevaluating the expressions
that are part of the class definition. (see Automatic Updates for Modified Classes on
page 5-47)

Expression Evaluation in Handle and Value Classes

The following example shows how value and handle object behave when assigned to
properties as default values. Suppose that you have the following classes.
6-12

Evaluation of Expressions in Class Definitions

Expressions in Value Classes

The ClassExp class has a property that contains a ContClass object:
classdef ContClass
properties
% Assign current date and time
TimeProp = datestr(now);
end
end
classdef ClassExp
properties
ObjProp = ContClass;
end
end

When you first use the ClassExp class, MATLAB creates an instance of the ContClass
class. MATLAB initializes both classes at this time. All instances of ClassExp include a
copy of this same instance of ContClass.
a = ClassExp;
a.ObjProp.TimeProp
ans =
08-Oct-2003 17:16:08

The TimeProp property of the ContClass object contains the date and time when
MATLAB initialized the class. Creating additional instances of the ClassExp class
shows that the date string has not changed:
b = ClassExp;
b.ObjProp.TimeProp
ans =
08-Oct-2003 17:16:08

Because this example uses a value class for the contained object, each instance of the
ClassExp has its own copy of the object. For example, suppose that you change the value
of the TimeProp property on the object contained by ClassExp objectb:
b.ObjProp.TimeProp = datestr(now)

6-13

Defining and Organizing Classes

ans =
08-Oct-2003 17:22:49

The copy of the object contained by object a is unchanged:

a.ObjProp.TimeProp
ans =
08-Oct-2003 17:16:08

Expressions in Handle Classes

Now consider the behavior if the contained object is a handle object:
classdef ContClass < handle
properties
TimeProp = datestr(now);
end
end

Creating two instances of the ClassExp class shows that MATLAB created an object
when it initialized the ContClass. MATLAB used a copy of the objects handle for
each instance of the ClassExp class. Therefore, there is one ContClass object and the
ObjProp property of each ClassExp object contains a copy of its handle.
Create an instance of the ClassExp class and note the time of creation:
a = ClassExp;
a.ObjProp.TimeProp
ans =
08-Oct-2003 17:46:01

Create a second instance of the ClassExp class. The ObjProp contains the handle of the
same object:
b = ClassExp;
b.ObjProp.TimeProp
ans =
08-Oct-2003 17:46:01

6-14

Evaluation of Expressions in Class Definitions

Reassign the value of the contained object TimeProp property:

b.ObjProp.TimeProp = datestr(now);
b.ObjProp.TimeProp
ans =
08-Oct-2003 17:47:34

The ObjProp property of object b contains a handle to the same object as the ObjProp
property of object a. The value of the TimeProp property has changed on this object as
well:
a.ObjProp.TimeProp
ans =
08-Oct-2003 17:47:34

More About

Comparison of Handle and Value Classes on page 7-2

6-15

Defining and Organizing Classes

Folders Containing Class Definitions

In this section...
Class and Path Folders on page 6-16
Using Path Folders on page 6-16
Using Class Folders on page 6-17
Access to Functions Defined in Private Folders on page 6-17
Class Precedence and MATLAB Path on page 6-18
Changing Path to Update Class Definition on page 6-19

Class and Path Folders

There are two types of folders that can contain class definition files.
Path folders The folder is on the MATLAB path and the folder name does not begin
with an @ character. Use this type of folder when you want multiple classes in one
folder. However, the entire class definition must be contained in one .m file.
Class folders The folder name begins with an @ character followed by the class
name. The folder is not on the MATLAB path, but its parent folder is on the path. Use
this type of folder when you want to use multiple files for one class definition.
See the path function for information about the MATLAB path.

Using Path Folders

The class definition files in the folders are on the MATLAB path. Therefore, class
definitions placed in path folders behave like any ordinary function with respect to
precedencethe first occurrence of a name on the MATLAB path takes precedence over
all subsequent occurrences of the same name.
The name of each class definition file must match the name of the class that is specified
with the classdef keyword. Using a path folder eliminates the need to create a separate
class folder for each class. However, the entire class definition, including all methods,
must be contained within a single file.
Suppose that you have three classes defined in a single folder:
6-16

Folders Containing Class Definitions

.../path_folder/MyClass1.m
.../path_folder/MyClass2.m
.../path_folder/MyClass2.m

To use these classes, add path_folder to your MATLAB path:

addpath path_folder

Using Class Folders

A class folder name always begins with the @ character followed by the class name for the
folder name. A class folder must be contained in a path folder, but the class folder is not
on the MATLAB path. Place the class definition file inside the class folder, which also can
contain separate method files. The class definition file must have the same name as the
class folder (without the @ character). The class definition (beginning with the classdef
keyword) must appear in the file before any other code (white space and comments do not
constitute code).
.../parent_folder/@MyClass/MyClass.m
.../parent_folder/@MyClass/myMethod1.m
.../parent_folder/@MyClass/myMethod2.m

Define only one class per folder. All files must have a .m extension.
Use a class folder when you want to use more than one file for your class definition.
MATLAB treats any .m file in the class folder as a method of the class. Class files provide
the advantage that MATLAB can explicitly identify any file in the folder as a method
of that class. For more information, see Changing Path to Update Class Definition on
page 6-19.
The base name of each file must be a valid MATLAB function name. Valid function
names begin with an alphabetic character and can contain letters, numbers, or
underscores. For more information, see Methods In Separate Files on page 9-10.

Access to Functions Defined in Private Folders

Private folders contain functions that are accessible only from functions defined in
folders immediately above the private folder. If a class folder contains a private
folder, only the class (or classes) defined in that folder can access functions defined in the
private folder. Subclasses do not have access to superclass private functions. For more
information on private folders, see Private Functions.
6-17

Defining and Organizing Classes

If you want a subclass to have access to the private functions of the superclass, a better
approach is to define the functions as protected methods of the superclass. Define the
methods with the Access attribute set to protected.
No Class Definitions in Private Folders
You cannot put class definitions in private folders because doing so would not meet the
requirements for class or path folders.

Class Precedence and MATLAB Path

When there are multiple class definition files with the same name, the file location on the
MATLAB path determines the file precedence. All class definition files before a class on
the path take precedence, whether or not the definitions are contained in a class folder.
The class takes precedence over all class definition files occurring later on the path.
For example, consider a path with the following folders, containing the files indicated.
Order in Path

Folder and File

File Defines

fldr1/Foo.m

Class Foo

fldr2/Foo.m

Function Foo

fldr3/@Foo/Foo.m

Class Foo

fldr4/@Foo/bar.m

Method bar

fldr5/Foo.m

Class Foo

Here is the logic that MATLAB applies to determine which version of Foo to call:
Class fldr1/Foo.m takes precedence over the class fldr3/@Foo because:
fldr1/Foo.m is before fldr3/@Foo on the path
Class fldr3/@Foo takes precedence over function fldr2/Foo.m because:
fldr3/@Foo is a class in a class folder
fldr2/Foo.m is not a class
Classes in class folders take precedence over functions
Function fldr2/Foo.m takes precedence over class fldr5/Foo.m because:
6-18

Folders Containing Class Definitions

fldr2/Foo.m comes before class fldr5/Foo.m on the path

fldr5/Foo.m is not in a class folder
Classes that are not defined in class folders obey the path order with respect to
functions.
Class fldr3/@Foo takes precedence over class fldr4/@Foo because:
The method bar is not recognized as part of the Foo class defined in fldr3/@Foo.
If fldr3/@Foo/Foo.m does not contain a classdef keyword (that is, it is a MATLAB
class prior to Version 7.6), then fldr4/@Foo/bar.m becomes a method of the Foo class
defined in fldr3/@Foo
Previous Behavior of Classes Defined in Class Folders
In MATLAB Versions 5 through 7, class folders do not shadow other class folders having
the same name, but residing in later path folders. Instead, the class uses the combination
of methods from all class folders having the same name to define the class. This behavior
is no longer supported.
For backward compatibility, classes defined in class folders always take precedence over
functions and scripts having the same name. This precedence applies to functions and
scripts that come before these classes on the path.

Changing Path to Update Class Definition

Changing your MATLAB path can change the class definition file for a class (see path).
However, for classes that are defined in path folders (that is, not in class @ folders),
you must clear the class before MATLAB recognizes the new folder as the current class
definition.
Class Definitions in Class Folders
Suppose that you define two versions of a class named Foo in two folders, fldA and
fldB.
fldA/+FooPkg/@Foo/Foo.m
fldB/+FooPkg/@Foo/Foo.m

Add folder fldA to the top of the path.

addpath fldA

6-19

Defining and Organizing Classes

Create an instance of class FooPkg.Foo. MATLAB uses fldA/+FooPkg/@Foo/Foo.m as

the class definition.
a = FooPkg.Foo;

Change the current folder to fldB.

cd fldB

The current folder is always first on the path. Therefore, MATLAB finds fldB/
+FooPkg/@Foo/Foo.m as the definition for class FooPkg.Foo.
b = FooPkg.Foo;

MATLAB automatically updates the existing instance, a, to use the new class definition
in fldB.
Class Definitions in Path Folders
Suppose that you define two versions of a class named Foo in two folders, fldA and
fldB, but do not use a class folder.
fldA/+FooPkg/Foo.m
fldB/+FooPkg/Foo.m

Add folder fldA to the top of the path.

addpath fldA

Create an instance of class FooPkg.Foo. MATLAB uses fldA/+FooPkg/@Foo/Foo.m as

the class definition.
a = FooPkg.Foo;

Change the current folder to fldB.

cd fldB

The current folder is effectively the top of the path. However, MATLAB does not identify
fldB/+FooPkg/Foo.m as the definition for class FooPkg.Foo. MATLAB continues to
use the original class definition until you clear the class.
To use the definition of FooPkg.Foo in foldB, clear FooPkg.Foo.
6-20

Folders Containing Class Definitions

clear FooPkg.Foo

MATLAB automatically updates the existing objects to conform to the class definition in
fldB. In most cases, clearing instance variables is unnecessary.

More About

Packages Create Namespaces on page 6-24

Automatic Updates for Modified Classes on page 5-47

6-21

Defining and Organizing Classes

Class Precedence
In this section...
Use of Class Precedence on page 6-22
Why Mark Classes as Inferior on page 6-22
InferiorClasses Attribute on page 6-22

Use of Class Precedence

MATLAB uses class precedence to determine which method to call when multiple classes
have the same method. You can specifying the relative precedence of user-defined classes
with the class InferiorClasses attribute.
The material presented in this topic builds on an understanding of the following
information:
Class Metadata on page 16-2
Attribute Specification on page 5-22

Why Mark Classes as Inferior

When more than one class defines methods with the same name or when classes overload
functions, MATLAB determines which method or function to call based on the dominant
argument. Here is how MATLAB determines the dominant argument:
1

Determine the dominant argument based on the class of arguments.

If there is a dominant argument, call the method of the dominant class.

If arguments are of equal precedence, use the leftmost argument as the dominant
argument.

If the class of the dominant argument does not define a method with the name of the
called function, call the first function on the path with that name.

InferiorClasses Attribute
Specify the relative precedence of user-defined classes using the class InferiorClasses
attribute. To specify classes that are inferior to the class you are defining, assign a cell
array of class meta.class objects to this attribute.
6-22

Class Precedence

For example, the following classdef declares that MyClass is dominant over
ClassName1 and ClassName2.
classdef (InferiorClasses = {?ClassName1,?ClassName2}) MyClass
...
end

The ? operator combined with a class name creates a meta.class object. See
metaclass.
MATLAB built-in classes are always inferior to user-defined classes and should not be
used in this list.
The built-in classes include: double, single, char, logical, int64, uint64, int32,
uint32, int16, uint16, int8, uint8, cell, struct, and function_handle.
Dominant Class
MATLAB uses class dominance when evaluating expressions involving objects of more
than one class. The dominant class determines:
Which class method to call when more than one class defines methods with the same
names.
The class of arrays that are formed by combining objects of different classes, assuming
MATLAB can convert the inferior objects to the dominant class.
No Attribute Inheritance
Subclasses do not inherit a superclass InferiorClasses attribute. Only classes
specified in the subclass InferiorClasses attribute are inferior to subclass objects.

More About

Class Precedence and MATLAB Path on page 6-18

Dominant Argument in Overloaded Graphics Functions on page 9-46

6-23

Defining and Organizing Classes

Packages Create Namespaces

In this section...
Package Folders on page 6-24
Internal Packages on page 6-25
Referencing Package Members Within Packages on page 6-25
Referencing Package Members from Outside the Package on page 6-26
Packages and the MATLAB Path on page 6-27

Package Folders
Packages are special folders that can contain class folders, function, and class definition
files, and other packages. The names of classes and functions are scoped to the package
folder. A package is a namespace within which names must be unique. Function and
class names must be unique only within the package. Using a package provides a means
to organize classes and functions. Packages also enable you to reuse the names of classes
and functions in different packages.
Note: Packages are not supported for classes created prior to MATLAB Version 7.6 (that
is, classes that do not use classdef).
Package folders always begin with the + character. For example,
+mypack
+mypack/pkfcn.m % a package function
+mypack/@myClass % class folder in a package

The parent of the top-level package folder must be on the MATLAB path.
Listing the Contents of a Package
List the contents of a package using the help command:
help event
Contents of event:
EventData

6-24

- event.EVENTDATA

Base class for event data

Packages Create Namespaces

PropertyEvent
listener
proplistener

- event.PROPERTYEVENT
Event data for object property
- event.LISTENER
Listener object
- event.PROPLISTENER
Listener object for property eve

You can also use the what command:

what event
Classes in directory Y:xxx\matlab\toolbox\matlab\lang\+event
EventData

PropertyEvent

listener

proplistener

Internal Packages
MathWorks reserves the use of packages named internal for utility functions used
by internal MATLAB code. Functions that belong to an internal package are intended
for MathWorks use only. Using functions or classes that belong to an internal package
is discouraged. These functions and classes are not guaranteed to work in a consistent
manner from one release to the next. Any of these functions and classes might be
removed from the MATLAB software in any subsequent release without notice and
without documentation in the product release notes.

Referencing Package Members Within Packages

All references to packages, functions, and classes in the package must use the package
name prefix, unless you import the package. (See Import Classes on page 6-29.) For
example, call this package function:
+mypack/pkfcn.m

With this syntax:

z = mypack.pkfcn(x,y);

Definitions do not use the package prefix. For example, the function definition line of the
pkfcn.m function would include only the function name:
function z = pkfcn(x,y)

Define a package class with only the class name:

classdef myClass

6-25

Defining and Organizing Classes

but call it with the package prefix:

obj = mypack.myClass(arg1,arg2,...);

Calling class methods does not require the package name because you have an object of
the class. You can use dot or function notation:
obj.myMethod(arg)
myMethod(obj,arg)

A static method requires the full class name, which includes the package name:
mypack.myClass.stMethod(arg)

Referencing Package Members from Outside the Package

Functions, classes, and other packages contained in a package are scoped to that
package. To reference any of the package members, prefix the package name to the
member name, separated by a dot. For example, the following statement creates an
instance of MyClass, which is contained in mypack package.
obj = mypack.MyClass;

Accessing Class Members Various Scenarios

This section shows you how to access various package members from outside a package.
Suppose that you have a package mypack with the following contents:
+mypack
+mypack/myfcn.m
+mypack/@MyFirstClass
+mypack/@MyFirstClass/myFcn.m
+mypack/@mMyFirstClass/otherFcn.m
+mypack/@MyFirstClass/MyFirstClass.m
+mypack/@MySecondClass
+mypack/@MySecondClass/MySecondClass.m
+mypack/+mysubpack
+mypack/+mysubpack/myFcn.m

Invoke the myFcn function in mypack:

mypack.myFcn(arg)

Create an instance of each class in mypack:

6-26

Packages Create Namespaces

obj1 = mypack.MyFirstClass;
obj2 = mypack.MySecondClass(arg);

Invoke the myFcn function that is in the package mysubpack:

mypack.mysubpack.myFcn(arg1,arg2);

If mypack.MyFirstClass has a method called myFcn, call it like any method call on an
object:
obj = mypack.MyFirstClass;
myFcn(obj,arg);

If mypack.MyFirstClass has a property called MyProp, assign it using dot notation

and the object:
obj = mypack.MyFirstClass;
obj.MyProp = x;

Packages and the MATLAB Path

You cannot add package folders to the MATLAB path, but you must add the package
parent folder to the MATLAB path. Package members are not accessible if the package
parent folder is not on the MATLAB path, even if the package folder is the current folder.
Making the package folder the current folder is not sufficient to add the package parent
folder to the path.
Package members remain scoped to the package. Always refer to the package members
using the package name. Alternatively, import the package into the function in which
you call the package member, see Import Classes on page 6-29.
Package folders do not shadow other package folders that are positioned later on the
path, unlike classes, which do shadow other classes. If two or more packages have the
same name, MATLAB treats them all as one package. If redundantly named packages
in different path folders define the same function name, then MATLAB finds only one of
these functions.
Resolving Redundant Names
Suppose a package and a class have the same name. For example:
fldr_1/+foo
fldr_2/@foo/foo.m

6-27

Defining and Organizing Classes

A call to which foo returns the path to the executable class constructor:
>> which foo
fldr_2/@foo/foo.m

A function and a package can have the same name. However, a package name by itself is
not an identifier. Therefore, if a redundant name occurs alone, it identifies the function.
Executing a package name alone returns an error.
Package Functions vs. Static Methods
In cases where a package and a class have the same name, a static method takes
precedence over a package function. For example, path folder fldrA contains a package
function and path folder fldrB contains a class static method:
fldrA/+foo/bar.m % bar is a function in package foo
fldrB/@foo/bar.m % bar is a static method of class foo

A call to which foo.bar returns the path to the static method:

which foo.bar
fldrB/@foo/bar.m

In cases where the same path folder contains both package and class folders with the
same name, the class static method takes precedence over the package function.
fldr/@foo/bar.m % bar is a static method of class foo
fldr/+foo/bar.m % bar is a function in package foo

A call to which foo.bar returns the path to the static method:

which foo.bar
fldr/@foo/bar.m

More About

6-28

Folders Containing Class Definitions on page 6-16

Class Precedence on page 6-22

Import Classes

Import Classes
In this section...
Syntax for Importing Classes on page 6-29
Import Package Functions on page 6-29
Package Function and Class Method Name Conflict on page 6-30
Clearing Import List on page 6-30

Syntax for Importing Classes

Import classes into a function to simplify access to class members. For example, suppose
that there is a package that contains several classes and you need to use only one of
these classes in your function, or even just a static method from that class. Use the
import command to simplify code. Once you have imported the class, you do not need to
reference the package name:
function myFunc
import pkg.cls1
obj = cls1(arg,...);
% call cls1 constructor
obj.Prop = cls1.staticMethod(arg,...); % call cls1 static method
end

Import all classes in a package using the syntax pkg.*:

function myFunc
import pkg.*
obj1 = cls1(arg,...); % call pkg.cls1 constructor
obj2 = cls2(arg,...); % call pkg.cls2 constructor
a = pkgFunction(); % call package function named pkgFunction
end

Import Package Functions

Use import to import package functions:
function myFunc
import pkg.pkfcn
pkfcn(arg,...); % call imported package function
end

6-29

Defining and Organizing Classes

Package Function and Class Method Name Conflict

Avoid importing an entire package using the * wildcard syntax. Doing so imports an
unspecified set of names into the local scope. For example, suppose that you have the
following folder organization:
+pkg/timedata.m
% package function
+pkg/@MyClass/MyClass.m % class definition file
+pkg/@MyClass/timedata.m % class method

Import the package and call timedata on an instance of MyClass:

import pkg.*
myobj = pkg.MyClass;
timedata(myobj)

A call to timedata finds the package function, not the class method because MATLAB
applies the import and finds pkg.timedata first. Do not use a package in cases where
you have name conflicts and plan to import the package.

Clearing Import List

You cannot clear the import list from a function workspace. To clear the base workspace
only, use:
clear import

More About

6-30

Packages Create Namespaces on page 6-24

7
Value or Handle Class Which to
Use
Comparison of Handle and Value Classes on page 7-2
Which Kind of Class to Use on page 7-11
The Handle Superclass on page 7-13
Handle Class Destructor on page 7-16
Find Handle Objects and Properties on page 7-24
Implement Set/Get Interface for Properties on page 7-25
Customize Class Copy Behavior on page 7-32
Control Number of Instances on page 7-38

Value or Handle Class Which to Use

Comparison of Handle and Value Classes

In this section...
Basic Difference on page 7-2
Behavior of MATLAB Built-In Classes on page 7-3
User-Defined Value Classes on page 7-4
User-Defined Handle Classes on page 7-5
Determining Equality of Objects on page 7-7
Functionality Supported by Handle Classes on page 7-9

Basic Difference
A value class constructor returns an object that is associated with the variable to which
it is assigned. If you reassign this variable, MATLAB creates an independent copy of the
original object. If you pass this variable to a function for the purpose of modifying it, the
function must return the modified object as an output argument.
A handle class constructor returns a handle object that is a reference to the object
created. You can assign the handle object to multiple variables or pass it to functions
without causing MATLAB to make a copy of the original object. A function that modifies
a handle object passed as an input argument does not need to return the object.
All handle classes are derived from the abstract handle class.
Create a Value Class
By default, MATLAB classes are value classes. The following definition creates a value
class named MyValueClass:
classdef MyValueClass
...
end

Create a Handle Class

To create a handle class, derive the class from the handle class.
classdef MyHandleClass < handle

7-2

Comparison of Handle and Value Classes

...
end

Behavior of MATLAB Built-In Classes

MATLAB fundamental classes are value classes (Fundamental MATLAB Classes). For
example, if you create an object of the class int32 and make a copy of this object, the
result is two independent objects. When you change the value of a, the value of b does not
change. This behavior is typical of classes that represent values.
a = int32(7);
b = a;
a = a^4;
b
7

MATLAB graphics objects are implemented as handle objects because they represent
visual elements. For example, create a graphics line object and copy its handle to another
variable. Both variables refer to the same line object.
x = 1:10; y = sin(x);
l1 = line(x,y);
l2 = l1;

Set the properties of the line object using either copy of the handle.
set(l2,'Color','red')
set(l1,'Color','green')
get(l2,'Color')
ans =
0

Calling the delete function on the l2 handle destroys the line object. If you attempt to
set the Color property on the line l1, the set function returns an error.
delete(l2)
set(l1,'Color','blue')
Error using matlab.graphics.primitive.Line/set
Invalid or deleted object.

7-3

Value or Handle Class Which to Use

If you delete the object by deleting any one of the existing handles, all copies are now
invalid because you deleted the single object to which all handles refer.
Deleting a handle object is not the same as clearing the handle variable. In the graphics
object hierarchy, the parent of the object holds a reference to the object. For example, the
parent axes hold a reference to the line object referred to by l1 and l2. If you clear both
variables from the workspace, the object still exists.
For more information on the behavior of handle objects, see Using Handles on page
1-12.

User-Defined Value Classes

MATLAB associates objects of value classes with the variables to which you assign
the object. When you copy a value object to another variable or pass a value object to a
function, MATLAB creates an independent copy of the object and all the data contained
by the object. The new object is independent of changes to the original object. Value
objects behave like MATLAB numeric and struct classes. Each property behaves
essentially like a MATLAB array
Value objects are always associated with one workspace or temporary variable. Value
objects go out of scope when their variable goes out of scope or is cleared. There are no
references to value objects, only copies that are independent objects.
Value Object Behavior
Here is a value class that stores a value in its Number property. The default property
value is the number 1.
classdef NumValue
properties
Number = 1;
end
end

Create a NumValue object assigned to the variable a.

a = NumValue
a =
NumValue with properties:

7-4

Comparison of Handle and Value Classes

Number: 1

Assign the value of a to another variable, b.

b = a
b =
NumValue with properties:
Number: 1

The variables a and b are independent. Changing the value of the Number property of a
does not affect the Number property of b.
a.Number = 7
a =
NumValue with properties:
Number: 7
b
b =
NumValue with properties:
Number: 1

Modifying Value Objects in Functions

When you pass a value object to a function, MATLAB creates a copy of that object in the
functions workspace. Because copies of value objects are independent, the function does
not modify the object in the callers workspace. Therefore, functions that modify value
objects must return the modified object to be reassigned in the callers workspace.
For more information, see Object Modification on page 5-59.

User-Defined Handle Classes

Instances of classes that derive from the handle class are references to the underlying
object data. When you copy a handle object, MATLAB copies the handle, but does not
copy the data stored in the object properties. The copy refers to the same object as the
7-5

Value or Handle Class Which to Use

original handle. If you change a property value on the original object, the copied handle
references the same change.
Handle Object Behavior
Here is a handle class that stores a value in its Number property. The default property
value is the number 1.
classdef NumHandle < handle
properties
Number = 1;
end
end

Create a NumHandle objects assigned to the variable a.

a = NumHandle
a =
NumHandle with properties:
Number: 1

Assign the value of a to another variable, b.

b = a
b =
NumHandle with properties:
Number: 1

The variables a and b refer to the same underlying object. Changing the value of the
Number property of a also changes the Number property of b. That is, a and b refer to the
same object.
a.Number = 7
a =
NumHandle with properties:
Number: 7

7-6

Comparison of Handle and Value Classes

b
b =
NumHandle with properties:
Number: 7

Modifying Handle Objects in Functions

When you pass a handle object to a function, MATLAB creates a copy of the handle
in the functions workspace. Because copies of handles reference the same underlying
object, functions that modify the handle object effectively modify the object in the callers
workspace as well. Therefore, functions that modify handle objects passed as input
arguments do not to return the modified object to the caller.
For more information, see Object Modification on page 5-59.
Deleting Handles
You can destroy handle objects by explicitly calling the handle delete method. Deleting
the handle of a handle class object makes all handles invalid. For example:
a = NumHandle;
b = a;
delete(a)
b.Number
Invalid or deleted object.

Calling delete on a handle object invokes the destructor function or functions for that
object. See Handle Class Destructor on page 7-16 for more information.
Initialize Properties to Contain Handle Objects
For information on the differences between initializing properties to default values in the
properties block and initializing properties from within the constructor, see Initialize
Property Values on page 8-13 and Initialize Arrays of Handle Objects on page
10-10.

Determining Equality of Objects

Equality for value objects means that the objects are of the same class and have the same
state.
7-7

Value or Handle Class Which to Use

Equality for handle objects means that the handle variables refer to the same object. You
also can identify handle variables that refer to different objects of the same class that
have the same state.
Equality of Value Objects
To determine if value objects are the same size and their contents are of equal value,
use isequal. For example, use the previously defined NumValue class to create two
instances and test for equality:
a = NumValue;
b = NumValue;
isequal(a,b)
ans =
1

a and b are independent and therefore are not the same object. However each represents
the same value.
If you change the value represented by a value object, the objects are no longer equal.
a = NumValue;
b = NumValue;
b.Number = 7;
isequal(a,b)
ans =
0

Value classes do not have a default eq method to implement the == operation.

Equality of Handle Objects
Handle objects inherit an eq method from the handle base class. You can use == and
isequal to test for two different relationships among handle objects:
The handles refer to the same object: == and isequal return true.
The handles refer to objects of the same class that have the same values, but are not
the same objects only isequal returns true.
Use the previously defined NumHandle class to create an object and copy the handle.
7-8

Comparison of Handle and Value Classes

a = NumHandle;
b = a;

Test for equality using == and isequal.

a == b
ans =
1
isequal(a,b)
ans =
1

Create two instances of the NumHandle class using the default values.
a = NumHandle;
b = NumHandle;

Determine if a and b refer to the same object.

a == b
ans =
0

Determine if a and b have the same values.

isequal(a,b)
ans =
1

Functionality Supported by Handle Classes

Deriving from the handle class enables your class to:
Inherit several useful methods (Handle Class Methods on page 7-13)
Define events and listeners (Events and Listeners Syntax on page 11-21)
7-9

Value or Handle Class Which to Use

Define dynamic properties (Dynamic Properties Adding Properties to an Instance

on page 8-41)
Implement set and get methods (Implement Set/Get Interface for Properties on page
7-25)
Customize copy behavior (Customize Class Copy Behavior on page 7-32)
See The Handle Superclass on page 7-13 for more information on the handle class
and its methods.

Related Examples

7-10

Which Kind of Class to Use on page 7-11

Customize Class Copy Behavior on page 7-32

Using Handles on page 1-12

Which Kind of Class to Use

Which Kind of Class to Use

In this section...
Examples of Value and Handle Classes on page 7-11
When to Use Handle Classes on page 7-11
When to Use Value Classes on page 7-12

Examples of Value and Handle Classes

Handle and value classes are useful in different situations. For example, value classes
enable you to create new array classes that have the same behavior as MATLAB numeric
classes.
Class Design for Polynomials on page 19-2 and Class to Represent Structured
Data on page 3-24 provides examples of value classes.
Handle classes enable you to create objects that more than one function or object can
share. Handle objects allow more complex interactions among objects because they allow
objects to reference each other.
Class to Implement Linked Lists on page 3-36 and Developing Classes Typical
Workflow on page 3-8 provides examples of a handle class.

When to Use Handle Classes

Use a handle class when:
No two instances of a class can have the same state, making it impossible to have
exact copies. For example:
A copy of a graphics object (such as a line) has a different position in its parents
list of children than the object from which it was copied. Therefore, the two objects
are not identical.
Nodes in lists or trees having specific connectivity to other nodesno 2 nodes can
have the same connectivity.
The class represents physical and unique objects like serial ports and printers.
The class represents visible objects like graphics components.
7-11

Value or Handle Class Which to Use

The class defines events and notifies listeners when an event occurs (notify is a
handle class method).
The class creates listeners by calling the handle class addlistener method.
The class subclasses the dynamicprops class (a subclass of handle) so that
instances can define dynamic properties.
The class subclasses the matlab.mixin.SetGet class (a subclass of handle) so that
it can implement a graphics object style set/get interface to access property values.
You want to create a singleton class or a class in which you track the number of
instances from within the constructor.
Instances of a class cannot share state, such as nodes in a linked list.

When to Use Value Classes

Value class objects behave like normal MATLAB variables. A typical use of value classes
is to define data structures. For example, suppose that you want to define a class to
represent polynomials. This class can define a property to contain a list of coefficients for
the polynomial. It can implement methods that enable you to perform various operations
on the polynomial object. For example, implement addition and multiplication without
converting the object to another class.
A value class is suitable because you can copy a polynomial object and have two objects
that are identical representations of the same polynomial. For an example of value
classes, see Class Design for Polynomials on page 19-2 and Subclasses of
MATLAB Built-In Types on page 12-44.

Related Examples

7-12

Support Both Handle and Value Subclasses on page 12-36

The Handle Superclass

The Handle Superclass

In this section...
Building on the Handle Class on page 7-13
Handle Class Methods on page 7-13
Event and Listener Methods on page 7-14
Relational Methods on page 7-14
Test Handle Validity on page 7-14
When MATLAB Destroys Objects on page 7-14

Building on the Handle Class

The handle class is an abstract class. Therefore, you cannot create objects of this class
directly. Use the handle class as a superclass to implement subclasses that inherit
handle behavior. MATLAB defines several classes that derive from the handle class.
These classes provide specialized functionality to subclasses.
Specialized Handle Base Classes
Derive your class from these handle classes to add both handle behavior and specific
functionality to your class:
matlab.mixin.SetGet Provides set and get methods to access property values.
dynamicprops Enables you to define properties that are associated with an object,
but not the class in general.
matlab.mixin.Copyable Provides a copy method that you can customize for your class.
For information on how to define subclasses, see Create Subclasses Syntax and
Techniques on page 12-7 .

Handle Class Methods

When you derive a class from the handle class, the subclass inherits methods that
enable you to work more effectively with handle objects.
List the methods of a class by passing the class name to the methods function:
methods('handle')

7-13

Value or Handle Class Which to Use

Methods for class handle:

addlistener
delete
eq

findobj
findprop
ge

gt
isvalid
le

lt
ne
notify

Event and Listener Methods

For information on how to use the notify and addlistener methods, see Events and
Listeners Syntax on page 11-21.

Relational Methods
TF
TF
TF
TF
TF
TF

=
=
=
=
=
=

eq(H1,H2)
ne(H1,H2)
lt(H1,H2)
le(H1,H2)
gt(H1,H2)
ge(H1,H2)

The handle class overloads these functions to support equality tests and sorting on
handles. For each pair of input arrays, these functions return a logical array of the same
size. Each element is an element-wise equality or comparison test result. The input
arrays must be the same size or one (or both) can be scalar. The method performs scalar
expansion as required. For more information on handle class relational methods, see
relationaloperators.

Test Handle Validity

Use the isvalid handle class method to determine if a variable is a valid handle object.
For example, in the statement:
B = isvalid(H)

B is a logical array in which each element is true if, and only if, the corresponding
element of H is a valid handle. B is always the same size as H.

When MATLAB Destroys Objects

MATLAB destroys objects in the workspace of a function when the function:
7-14

The Handle Superclass

Reassigns an object variable to a new value

Does not use an object variable for the remainder of a function
Function execution ends
When MATLAB destroys an object, it also destroys values stored in the properties of the
object. MATLAB frees computer memory associated with the object for use by MATLAB
or the operating system.
You do not need to free memory in handle classes. However, there can be other
operations that you want to perform when destroying an object. For example, closing a
file or shutting down an external program that the object constructor started. Define a
delete method in your handle subclass for these purposes.
See Handle Class Destructor on page 7-16 for more information.

Related Examples

Comparison of Handle and Value Classes on page 7-2

7-15

Value or Handle Class Which to Use

Handle Class Destructor

In this section...
Basic Knowledge on page 7-16
Syntax of Handle Class Destructor Method on page 7-16
When to Define a Destructor Method on page 7-17
Destructors in Class Hierarchies on page 7-18
Object Lifecycle on page 7-18
Restrict Access to Object Delete Method on page 7-20
Nondestructor Delete Methods on page 7-20
Java Objects Referencing MATLAB Objects on page 7-21

Basic Knowledge
Terms and Concepts
Class destructor a method named delete that MATLAB calls implicitly before
destroying an object of a handle class. Also, user-defined code can call delete explicitly
to destroy an object.
Nondestructor a method named delete that does not meet the syntax requirements
of a valid destructor. Therefore, MATLAB does not call this method implicitly when
destroying handle objects. A method named delete in a value class is not a destructor.
Object Lifecycle on page 7-18
Method Attributes on page 9-5

Syntax of Handle Class Destructor Method

MATLAB calls the destructor of a handle class when destroying objects of the class.
MATLAB recognizes a method named delete as the class destructor only if you define
delete as an ordinary method with the appropriate syntax.
To be a valid class destructor, the delete method:
Must define one, scalar input argument, which is an object of the class.
7-16

Handle Class Destructor

Must not define output arguments

Cannot be Sealed, Static, or Abstract
In addition, the delete method should not:
Throw errors, even if the object is invalid.
Create new handles to the object being destroyed
Call methods or access properties of subclasses
MATLAB does not call a noncompliant delete method when destroying objects of the
class. A delete method that is not a valid destructor shadows the handle base class
delete method. A noncompliant delete method can prevent the destruction of the
object by shadowing the handle class delete method.
Declare delete as an ordinary method:
methods
function delete(obj)
% obj is always scalar
...
end
end

delete Called Element-Wise on Array

MATLAB calls the delete method separately for each element in an array. Therefore, a
delete method is passed only one scalar argument with each invocation.
Calling delete on a deleted handle should not error and can take no action. This design
enables delete to work on object arrays containing a mix of valid and invalid objects.

When to Define a Destructor Method

Use a delete method to perform cleanup operations before MATLAB destroys the object.
For example, suppose that a method opens a file for writing and you want to close the file
in your delete method. For example, the following delete method calls fclose on a
file identifier that the object stores in its FileID property:
function delete(obj)
fclose(obj.FileID);
end

7-17

Value or Handle Class Which to Use

For a sample class, see Class to Manage Writable Files on page 3-19.

Destructors in Class Hierarchies

If you create a hierarchy of classes, each class can define its own delete method. When
destroying an object, MATLAB calls the delete method of each class in the hierarchy.
Defining a delete method in a handle subclass does not override the handle class
delete method. Subclass delete methods augment the superclass delete methods.
Inheriting a Sealed Delete Method
Classes cannot define a valid destructor that is Sealed. MATLAB returns an error when
you attempt to instantiate a class that defines a Sealed delete method.
Normally, declaring a method as Sealed prevents subclasses from overriding that
method. However, a Sealed method named delete that is not a valid destructor does
not prevent a subclass from defining its own destructor.
For example, if a superclass defines a method named delete that is not a valid
destructor, but is Sealed, then subclasses:
Can define valid destructors (which are always named delete).
Cannot define methods named delete that are not valid destructors.
Destructors in Heterogeneous Hierarchies
Heterogeneous class hierarchies require that all methods to which heterogeneous arrays
are passed must be sealed. However, the rule does not apply to class destructor methods.
Because destructor methods cannot be sealed, you can define a valid destructor in a
heterogeneous hierarchy that is not sealed, but does function as a destructor.
For information on heterogeneous hierarchies, see Heterogeneous Arrays on page
10-21

Object Lifecycle
MATLAB invokes the delete method when the lifecycle of an object ends. The lifecycle
of an object ends when the object is:
No longer referenced anywhere
Explicitly deleted by calling delete on the handle
7-18

Handle Class Destructor

Inside a Function
The lifecycle of an object referenced by a local variable or input argument exists from
the time the variable is assigned until the time it is reassigned, cleared, or no longer
referenced within that function or in any handle array.
A variable goes out of scope when you explicitly clear it or when its function ends. When
a variable goes out of scope and its value belongs to a handle class that defines a delete
method, MATLAB calls that method. MATLAB defines no ordering among variables in a
function. Do not assume that MATLAB destroys one value before another value when the
same function contains multiple values.
Sequence During Handle Object Destruction
MATLAB invokes the delete methods in the following sequence when destroying an
object:
1

The delete method for the class of the object

The delete method of each superclass class, starting with the immediate
superclasses and working up the hierarchy to the most general superclasses

MATLAB invokes the delete methods of superclasses at the same level in the
hierarchy in the order specified in the class definition. For example, the following class
definition specifies supclass1 before supclass2. MATLAB calls the delete method of
supclass1 before the delete method of supclass2.
classdef myClass < supclass1 & supclass2

After calling each delete method, MATLAB destroys the property values belonging
exclusively to the class whose method was called. The destruction of property values that
contain other handle objects can cause a call the delete methods for those objects when
there are no other references to those objects.
Superclass delete methods cannot call methods or access properties belonging to a
subclass.
Destruction of Objects with Cyclic References
Consider a set of objects that reference other objects of the set such that the references
form a cyclic graph. In this case, MATLAB:
Destroys the objects if they are referenced only within the cycle
7-19

Value or Handle Class Which to Use

Does not destroy the objects as long as there is an external reference to any of the
objects from a MATLAB variable outside the cycle
MATLAB destroys the objects in the reverse of the order of construction.

Restrict Access to Object Delete Method

Destroy handle objects by explicitly calling delete on the object:
delete(obj)

A class can prevent explicit destruction of an object by setting its delete method
Access attribute to private. However, a method of the class can call the private
delete method.
If the class delete method Access attribute is protected, only methods of the class
and of subclasses can explicitly delete objects of that class.
However, when an object lifecycle ends, MATLAB calls the objects delete method when
destroying the object regardless of methods Access attribute.
Inherited Private Delete Methods
Class destructor behavior differs from the normal behavior of an overridden method.
MATLAB executes each delete method of each superclass upon destruction, even if that
delete method is not public.
When you explicitly call an objects delete method, MATLAB checks the delete
method Access attribute in the class defining the object, but not in the superclasses of
the object. A superclass with a private delete method cannot prevent the destruction
of subclass objects.
Declaring a private delete method makes most sense for sealed classes. In the case where
classes are not sealed, subclasses can define their own delete methods with public access.
MATLAB calls a private superclass delete method as a result of an explicit call to a
public subclass delete method.

Nondestructor Delete Methods

A class can implement a method named delete that is not a valid class destructor.
MATLAB does not call this method implicitly when destroying an object. In this case,
delete behaves like an ordinary method.
7-20

Handle Class Destructor

For example, if the superclass implements a Sealed method named delete that is not a
valid destructor, then MATLAB does not allow subclasses to override this method.
A delete method defined by a value class cannot be a class destructor.

Java Objects Referencing MATLAB Objects

Java does not support the object destructors that MATLAB objects use. Therefore, it is
important to manage the lifecycle of all objects used in applications that include both
Java and MATLAB objects.
References Can Prevent Destructor Execution
Java objects that hold references to MATLAB objects can prevent deletion of the
MATLAB objects. In these cases, MATLAB does not call the handle object delete
method even when there is no handle variable referring to that object. To ensure your
delete method executes, call delete on the object explicitly before the handle variable
goes out of scope.
Problems can occur when you define callbacks for Java objects that reference MATLAB
objects.
For example, the CallbackWithJava class creates a Java
com.mathworks.jmi.Callback object and assigns a class method as the callback
function. The result is a Java object that has a reference to a handle object via the
function-handle callback.
classdef CallbackWithJava < handle
methods
function obj = CallbackWithJava
jo = com.mathworks.jmi.Callback;
set(jo,'DelayedCallback',@obj.cbFunc); % Assign method as callback
jo.postCallback
end
function cbFunc(obj,varargin)
c = class(obj);
disp(['Java object callback on class ',c])
end
function delete(obj)
c = class(obj);
disp(['ML object destructor called for class ',c])
end

7-21

Value or Handle Class Which to Use

end
end

Suppose that you create a CallbackWithJava object from within a function:

function testDestructor
cwj = CallbackWithJava
...
end

Creating an instance of the CallbackWithJava class creates the

com.mathworks.jmi.Callback object and executes the callback function:
testDestructor
cwj =
CallbackWithJava with no properties.
Java object callback on class CallbackWithJava

The handle variable, cwj, exists only in the function workspace. However,
MATLAB does not call the class delete method when the function ends. The
com.mathworks.jmi.Callback object still exists and holds a reference to the object of
the CallbackWithJava class, which prevents destruction of the MATLAB object.
clear classes
Warning: Objects of 'CallbackWithJava' class exist.
any of its superclasses.

Cannot clear this class or

To avoid causing inaccessible objects, call the delete explicitly before losing the handle to
the MATLAB object.
function testDestructor
cwj = CallbackWithJava
...
delete(cwj)
end

Manage Object Lifecycle in Applications

MATLAB applications that use Java objects should manage the lifecycle of the objects
involved. A typical user-interface application references Java objects from MATLAB
objects and creates callbacks on Java objects that reference MATLAB objects.
7-22

Handle Class Destructor

You can break these cyclic references in various ways:

Explicitly call delete on the MATLAB objects when they are no longer needed
Unregister the Java object callbacks that reference MATLAB objects
Use intermediate handle objects that reference both the Java callbacks and the
MATLAB objects.

More About

Using Handles on page 1-12

7-23

Value or Handle Class Which to Use

Find Handle Objects and Properties

In this section...
Find Handle Objects on page 7-24
Find Handle Object Properties on page 7-24

Find Handle Objects

The findobj method enables you to locate handle objects that meet certain conditions.
function HM = findobj(H,<conditions>)

The findobj method returns an array of handles matching the conditions specified.

Find Handle Object Properties

The findprop method returns the meta.property object for the specified object and
property.
function mp = findprop(h,'PropertyName')

The property can also be a dynamic property created by the addprop method of the
dynamicprops class.
Use the returned meta.property object to obtain information about the property, such
as the settings of any of its attributes. For example, the following statements determine
that the setting of the AccountStatus property Dependent attribute is false.
ba = BankAccount(007,50,'open');
mp = findprop(ba,'AccountStatus');
mp.Dependent
ans =
0

See Also
handle

Related Examples

7-24

Class Metadata on page 16-2

Implement Set/Get Interface for Properties

Implement Set/Get Interface for Properties

In this section...
The Standard Set/Get Interface on page 7-25
Subclass matlab.mixin.SetGet on page 7-25
Get Method Syntax on page 7-26
Set Method Syntax on page 7-26
Class Derived from matlab.mixin.SetGet on page 7-27

The Standard Set/Get Interface

Some MATLAB objects, such as graphics objects, implement an interface based on
set and get methods. These methods enable you to set or query the values of object
properties.
The matlab.mixin.SetGet class is an abstract base class that provides implementations
of these methods. Derive your class from matlab.mixin.SetGet to inherit set and get
functionality.
Note: The set and get methods referred to in this section are different from property set
access and property get access methods. See Property Access Methods on page 8-23
for information on property access methods.

Subclass matlab.mixin.SetGet
Classes inherit set and get methods from matlab.mixin.SetGet:
classdef MyClass < matlab.mixin.SetGet
...
end

Because matlab.mixin.SetGet derives from the handle class, your subclass is also a
handle class.

7-25

Value or Handle Class Which to Use

Get Method Syntax

The get method returns the value of an object property using the object handle and the
property name:
v = get(H,'PropertyName');

If you specify an array of handles with a single property name, get returns the property
value for each object as a cell array of values:
CV = get(H,'PropertyName');

The CV array is always a column regardless of the shape of H.

If you specify a cell array of char vector property names and an array of handles, get
returns a cell array of property values. Each row in the cell corresponds to an object in
the handle array. Each column in the cell corresponds to a property name.
props = {'PropertyName1','PropertyName2'};
CV = get(H,props);

get returns an m-by-n cell array, where m = length(H) and n = length(props).

If you specify a handle array, but no property names, get returns an array of type
struct in which each structure in the array corresponds to an object in H. Each field in
each structure corresponds to a property defined by the class of H. The value of each field
is the value of the corresponding property.
SV = get(H);

If you do not assign an output variable, then H must be scalar.

For an example, see Using get with Arrays of Handles on page 7-29.

Set Method Syntax

The set method assigns the specified value to the specified property for the object with
handle H. If H is an array of handles, MATLAB assigns the value to the property for each
object in the array H.
set(H,'PropertyName',PropertyValue)

You can pass a cell array of property names and a cell array of property values to set:
7-26

Implement Set/Get Interface for Properties

props = {'PropertyName1','PropertyName2'};
vals = {Property1Value,Property2Value};
set(H,props,vals)

If length(H) is greater than one, then the property value cell array (vals) can have
values for each property in each object. For example, suppose length(H) is 2 (two object
handles). You want to assign two property values on each object:
props = {'PropertyName1','PropertyName2'};
vals = {Property11Value,Property12Value;Property21Value,Property22Value};
set(H,props,vals))

The preceding statement is equivalent to the follow two statements:

set(H(1),'PropertyName1',Property11Value,'PropertyName2',Property12Value)
set(H(2),'PropertyName1',Property21Value,'PropertyName2',Property22Value)

If you specify a scalar handle, but no property names, set returns a struct with one
field for each property in the class of H. Each field contains an empty cell array.
SV = set(h);

Class Derived from matlab.mixin.SetGet

This sample class defines a set/get interface and illustrates the behavior of the inherited
methods:
classdef LineType < matlab.mixin.SetGet
properties
Style = '-';
Marker = 'o';
end
properties (SetAccess = protected)
Units = 'points';
end
methods
function obj = LineType(s,m)
if nargin > 0
obj.Style = s;
obj.Marker = m;
end
end
function obj = set.Style(obj,val)

7-27

Value or Handle Class Which to Use

if ~(strcmpi(val,'-') ||...
strcmpi(val,'--') ||...
strcmpi(val,'..'))
error('Invalid line style ')
end
obj.Style = val;
end
function obj = set.Marker(obj,val)
if ~isstrprop(val,'graphic')
error('Marker must be a visible character')
end
obj.Marker = val;
end
end
end

Create an instance of the class and save its handle:

h = LineType('--','*');

Query the value of any object property using the inherited get method:
get(h,'Marker')
ans =
*

Set the value of any property using the inherited set method:
set(h,'Marker','Q')

Property Access Methods Called with set and get

MATLAB calls property access methods (set.Style or set.Marker in the LineType
class) when you use the set and get methods.
set(h,'Style','-.-')
Error using LineType>LineType.set.Style
Invalid line style

For more information on property access methods, see Property Access Methods on
page 8-23
7-28

Implement Set/Get Interface for Properties

List All Properties

Return a struct containing object properties and their current values using get:
h = LineType('--','*');
SV = get(h)
SV =
Style: '--'
Marker: '*'
Units: 'points'

Return a struct containing the properties that have public SetAccess using set:
S = set(h)
S =
Style: {}
Marker: {}

The LineType class defines the Units property with SetAccess = protected.
Therefore, S = set(h) does not create a field for Units in S.
set cannot return possible values for properties.
Using get with Arrays of Handles
Suppose that you create an array of LineType objects:
H = [LineType('..','z'),LineType('--','q')]
H =
1x2 LineType with properties:
Style
Marker
Units

When H is an array of handles, get returns a (length(H)-by-1) cell array of property

values:
CV = get(H,'Style')

7-29

Value or Handle Class Which to Use

CV =
'..'
'--'

When H is an array of handles and you do not specify a property name, get returns a
struct array containing fields with names corresponding to property-names. Assign the
output of get to a variable when H is not scalar.
SV = get(H)
SV =
2x1 struct array with fields:
Style
Marker
Units

Get the value of the Marker property from the second array element in the SV array of
structures:
SV(2).Marker
ans =
q

Arrays of Handles, Names, and Values

You can pass an array of handles, a cell array of property names, and a cell array of
property values to set. The property value cell array must have one row of property
values for each object in H. Each row must have a value for each property in the property
name array:
H = [LineType('..','z'),LineType('--','q')];
set(H,{'Style','Marker'},{'..','o';'--','x'})

The results of this call to set is:

H(1)
ans =
LineType with properties:

7-30

Implement Set/Get Interface for Properties

Style: '..'
Marker: 'o'
Units: 'points
H(2)
ans =
LineType with properties:
Style: '--'
Marker: 'x'
Units: 'points'

Customize the Property List

Customize the way property lists display by redefining the following methods in your
subclass:
setdisp When you call set with no output argument and a single scalar handle
input, set calls setdisp to determine how to display the property list.
getdisp When you call get with no output argument and a single scalar handle
input, get calls getdisp to determine how to display the property list.

See Also
get | set

More About

How to Use Properties on page 8-2

7-31

Value or Handle Class Which to Use

Customize Class Copy Behavior

In this section...
Customize Copy Operation on page 7-32
Copy Properties That Contain Handles on page 7-33
Exclude Properties from Copy on page 7-35

Customize Copy Operation

Customize handle object copy behavior by deriving your class from
matlab.mixin.Copyable. The matlab.mixin.Copyable class is an abstract base class
that derives from the handle class. matlab.mixin.Copyable provides a template for
customizing object copy operations by defining:
copy Sealed method that defines the interface for copying objects
copyElement Protected method that subclasses can override to customize object
copy operations for the subclass
The matlab.mixin.Copyable copy method, calls the copyElement method. Your
subclass customizes the copy operation by defining its own version of copyElement.
The default implementation of copyElement makes shallow copies of all the
nondependent properties. copyElement copies each property value and assigns it to the
new (copied) property. If a property value is a handle object, copyElement copies the
handle, but not the underlying data.
Override copyElement to implement different copy behavior for different properties. For
example, the copyElement method of the SpecializedCopy class:
Creates a new class object
Copies the value of Prop1 to the new object
Reinitializes the default value of Prop2 by adding a timestamp when the copy is
made
classdef SpecializedCopy < matlab.mixin.Copyable
properties
Prop1
Prop2 = datestr(now);

7-32

Customize Class Copy Behavior

end
methods(Access = protected)
function cp = copyElement(obj)
cp = SpecializedCopy;
cp.Prop1 = obj.Prop1;
cp.Prop2 = datestr(now);
end
end
end

Create an object of the class and assign a value to Prop1:

a = SpecializedCopy;
a.Prop1 = 7
a =
SpecializedCopy with properties:
Prop1: 7
Prop2: '17-Feb-2015 17:51:23'

Use the inherited copy method to create a copy of a:

b = copy(a)
b =
SpecializedCopy with properties:
Prop1: 7
Prop2: '17-Feb-2015 17:51:58'

The copy (object b) has the same value for Prop1, but the subclass copyElement method
assigned a new value to Prop2. Notice the different timestamp.

Copy Properties That Contain Handles

Copying an object also copies the values of object properties. Object properties can
contain other objects, including handle objects. If you simply copy the value of a property
that contains a handle object, you are actually copying the handle, not the object itself.
Therefore, your copy references the same object as the original object. Classes that derive
from the matlab.mixin.Copyable class can customize the way the copy method copies
objects of the class.
7-33

Value or Handle Class Which to Use

Class to Support Handle Copying

Suppose that you define a class that stores a handle in an object property. You want to be
able to copy objects of the class and want each copy of an object to refer to a new handle
object. Customize the class copy behavior using these steps:
Create a subclass of matlab.mixin.Copyable.
Override copyElement to control how the property containing the handle is copied.
Because the property value is a handle, create a new default object of the same class.
Copy property values from the original handle object to the new handle object.
The HandleCopy on page 7-34 class customizes copy operations for the property
that contains a handle object. The ColorProp on page 7-35 class defines the handle
object to assign to Prop2:
Create an object and assign property values:
a = HandleCopy;
a.Prop1 = 7;
a.Prop2 = ColorProp;

Make a copy of the object using the copy method inherited from
matlab.mixin.Copyable:
b = copy(a);

Demonstrate that the handle object contained by object a and b are independent.
Changing the value on object a does not affect object b:
a.Prop2.Color = 'red';
b.Prop2.Color
ans =
blue

HandleCopy
The HandleCopy class customizes the copy operation for objects of this class.
classdef HandleCopy < matlab.mixin.Copyable
properties
Prop1 % Shallow copy
Prop2 % Handle copy

7-34

Customize Class Copy Behavior

end
methods (Access = protected)
function cp = copyElement(obj)
% Shallow copy object
cp = copyElement@matlab.mixin.Copyable(obj);
% Get handle from Prop2
hobj = obj.Prop2;
% Create default object
new_hobj = eval(class(hobj));
% Add public property values from orig object
HandleCopy.propValues(new_hobj,hobj);
% Assign the new object to property
cp.Prop2 = new_hobj;
end
end
methods (Static)
function propValues(newObj,orgObj)
pl = properties(orgObj);
for k = 1:length(pl)
if isprop(newObj,pl{k})
newObj.(pl{k}) = orgObj.(pl{k});
end
end
end
end
end

ColorProp
The ColorProp class defines a color by assigning an RGB value to its Color property.
classdef ColorProp < handle
properties
Color = 'blue';
end
end

Exclude Properties from Copy

Use the NonCopyable property attribute to indicate that you do not want a copy
operation to copy a particular property value. By default, NonCopyable is false,
indicating that the property value is copyable. You can set NonCopyable to true only on
properties of handle classes.
7-35

Value or Handle Class Which to Use

For classes that derive from matlab.mixin.Copyable, the default implementation

of copyElement honors the NonCopyable attribute. Therefore, if a property has its
NonCopyable attribute set to true, then copyElement does not copy the value of that
property. If you override copyElement in your subclass, you can choose how to use the
NonCopyable attribute.
Set the Attribute to Not Copy
Set NonCopyable to true in a property block:
properties (NonCopyable)
Prop1
end

Default Values
If a property that is not copyable has a default value assigned in the class definition, the
copy operation assigns the default value to the property. For example, the CopiedClass
assigns a default value to Prop2.
classdef CopiedClass < matlab.mixin.Copyable
properties (NonCopyable)
Prop1
Prop2 = datestr(now); % Assign current time
end
end

Create an object to copy and assign a value to Prop1:

a = CopiedClass;
a.Prop1 = 7
a =
CopiedClass with properties:
Prop1: 7
Prop2: '17-Feb-2015 15:19:34'

Copy a to b using the copy method inherited from matlab.mixin.Copyable:

b = copy(a)
b =

7-36

Customize Class Copy Behavior

CopiedClass with properties:

Prop1: []
Prop2: '17-Feb-2015 15:19:34'

In the copy b, the value of Prop1 is not copied. The value of Prop2 is set to its default
value, which MATLAB determined when first loading the class. The timestamp does not
change.
Objects with Dynamic Properties
Subclasses of the dynamicprops class allow you to add properties to an object
of the class. When a class derived from dynamicprops is also a subclass of
matlab.mixin.Copyable, the default implementation of copyElement does not copy
dynamic properties. The default value of NonCopyable is true for dynamic properties.
The default implementation of copyElement honors the value of a dynamic property
NonCopyable attribute. If you want to allow copying of a dynamic property, set its
NonCopyable attribute to false. Copying a dynamic property copies the property value
and the values of the property attributes.
For example, this copy operation copies the dynamic property, DynoProp, because its
NonCopyable attribute is set to false. The object obj must be an instance of a class
that derives from both dynamicprops and matlab.mixin.Copyable:
obj = MyDynamicClass;
p = addprop(obj,'DynoProp');
p.NonCopyable = false;
obj2 = copy(obj);

See Also

matlab.mixin.Copyable

Related Examples

Dynamic Properties Adding Properties to an Instance on page 8-41

7-37

Value or Handle Class Which to Use

Control Number of Instances

In this section...
Limit Instances on page 7-38
Singleton Class Implementation on page 7-38

Limit Instances
You can limit the number of instances of a class that can exist at any one time. For
example, a singleton class can have only one instance and must provide a way to access
this instance. Create a singleton class using a:
Persistent variable to contain the instance
Sealed class to prevent subclassing (class Sealed attribute set to true)
Private constructor (method Access attribute set to private)
Static method to return the handle to the instance, if one exists, or to create the
instance when needed.

Singleton Class Implementation

This skeletal class definition shows how you can approach the implementation of a class
that allows you to create only one instance at a time:
classdef (Sealed) SingleInstance < handle
methods (Access = private)
function obj = SingleInstance
end
end
methods (Static)
function singleObj = getInstance
persistent localObj
if isempty(localObj) || ~isvalid(localObj)
localObj = SingleInstance;
end
singleObj = localObj;
end
end
end

7-38

Control Number of Instances

The getInstance static method returns a handle to the object, which the class stores
in a persistent variable. getInstance creates an instance only the first time called in a
session or when the object becomes invalid. For example:
sobj = SingleInstance.getInstance
sobj =
SingleInstance with no properties

As long as sobj exists as a valid handle, calling getInstance returns a handle to the
same object. If you delete sobj, then calling getInstance creates an object and returns
the handle.
delete(sobj)
isvalid(sobj)
ans =
0

After deleting the object, you can create a new instance:

sobj = SingleInstance.getInstance;
isvalid(sobj)
ans =
1

See Also
persistent

More About

Handle Class Destructor on page 7-16

7-39

8
Properties Storing Class Data
How to Use Properties on page 8-2
Property Syntax on page 8-4
Property Attributes on page 8-7
Defining Properties on page 8-13
Mutable and Immutable Properties on page 8-18
Restrict Class of Properties on page 8-20
Property Access Methods on page 8-23
Property Set Methods on page 8-29
Property Get Methods on page 8-32
Access Methods for Dependent Properties on page 8-34
Properties Containing Objects on page 8-38
Dynamic Properties Adding Properties to an Instance on page 8-41
Access Methods for Dynamic Properties on page 8-45
Dynamic Property Events on page 8-47
Dynamic Properties and ConstructOnLoad on page 8-51

Properties Storing Class Data

How to Use Properties

In this section...
What Are Properties on page 8-2
Types of Properties on page 8-2

What Are Properties

Properties encapsulate the data that belongs to instances of classes. Data contained in
properties can be public, protected, or private. This data can be a fixed set of constant
values, or it can depend on other values and calculated only when queried. You control
these aspects of property behaviors by setting property attributes and by defining
property-specific access methods.
Flexibility of Object Properties
In some ways, properties are like fields of a struct object. However, storing data in an
object property provides more flexibility. Properties can:
Define a constant value that you cannot change outside the class definition. See
Properties with Constant Values on page 15-2
Calculate its value based on the current value of other data. See Property Get
Methods on page 8-32
Execute a function to determine if an attempt to assign a value meets a certain
criteria. See Property Set Methods on page 8-29
Trigger an event notification when any attempt is made to get or set its value. See
Property-Set and Query Events on page 11-17
Control access by code to the property values. See the SetAccess and GetAccess
attributes Property Attributes on page 8-7
Control whether its value is saved with the object in a MAT-file. See Save and Load
Objects on page 13-2

Types of Properties
There are two types of properties:
Stored properties Use memory and are part of the object
8-2

How to Use Properties

Dependent properties No allocated memory and the get access method calculates
the value when queried
Features of Stored Properties
Can assign an initial value in the class definition
Property value is stored when you save the object to a MAT-file
Can use a set access method to control possible values, but you are not required to use
such methods.
When to Use Stored Properties
You want to be able to save the property value in a MAT-file
The property value is not dependent on other property values
Features of Dependent Properties
Dependent properties save memory because property values that depend on other values
are calculated only when needed.
When to Use Dependent Properties
Define properties as dependent when you want to:
Compute the value of a property from other values (for example, you can compute
area from Width and Height properties).
Provide a value in different formats depending on other values. For example, the size
of a push button in values determined by the current setting of its Units property.
Provide a standard interface where a particular property is or is not used, depending
on other values. For example, different computer platforms can have different
components on a toolbar).

Related Examples

Property Attributes on page 8-7

Property Access Methods on page 8-23

Static Properties on page 5-63

8-3

Properties Storing Class Data

Property Syntax
In this section...
Property Definition Block on page 8-4
Access Property Values on page 8-5
Inheritance of Properties on page 8-6
Specify Property Attributes on page 8-6

Property Definition Block

The following illustration shows a typical property specification. The properties and
end keywords delineate a block of code that defines properties having the same attribute
settings.
properties keyword begins definition block. Attribute specification

properties (SetAccess = protected)

Coefficients = [0 0 1];
end
properties block
Property name

Default value

end keyword terminates definition block.

Note: Properties cannot have the same name as the class.

8-4

Property Syntax

Assigning a Default Value

The preceding example shows the Coefficients property specified as having a default
value of [0 0 1].
You can initialize property values with MATLAB expressions. However, these
expressions cannot refer to the class that you are defining in any way, except to call class
static methods. MATLAB executes expressions that create initial property values only
when initializing the class, which occurs just before first using the class. See Property
Default Values on page 8-14 for more information about how MATLAB evaluates
default value expressions.
Define One Property Per Line
Property names must be listed on separate lines. MATLAB interprets a name following a
property name as the name of a class.
Restrict Property Values
You can restrict property values by associating a class with the property in the property
definition. For example, the definition of MyData requires that values assigned to this
property must be of type int32 or types that are compatible with int32.
properties
MyData int32
end

For more information, see Restrict Class of Properties on page 8-20.

Access Property Values

Property access syntax is like MATLAB structure field syntax. For example, if obj is
an object of a class, then you can get the value of a property by referencing the property
name:
val = obj.PropertyName

Assign values to properties by putting the property reference on the left side of the equal
sign:
obj.PropertyName = val

8-5

Properties Storing Class Data

When you access a property, MATLAB executes any property set or get access method
and triggering any enabled property events.

Inheritance of Properties
When you derive one class from another class, the derived (subclass) class inherits all the
properties of the superclass. In general, subclasses define only properties that are unique
to that particular class. Superclasses define properties that more than one subclass use.

Specify Property Attributes

Attributes specified with the properties keyword apply to all property definitions that
follow in that block. If you want to apply attribute settings to certain properties only,
reuse the properties keyword and create another property block for those properties.
For example, the following code shows the SetAccess attribute set to private for the
IndependentVar and Order properties, but not for the Coefficients property:

properties
Coefficients = [0 0 1];
end
properties (SetAccess = private)
IndependentVar
Order = 0;
end
These properties (and any others placed in
this block) have private set access

For information about the properties of a specific class, use the properties function.

Related Examples

8-6

Restrict Class of Properties on page 8-20

Defining Properties on page 8-13

Property Attributes on page 8-7

Property Attributes

Property Attributes
In this section...
Purpose of Property Attributes on page 8-7
Specifying Property Attributes on page 8-7
Table of Property Attributes on page 8-7

Purpose of Property Attributes

Specifying attributes in the class definition enables you to customize the behavior of
properties for specific purposes. Control characteristics like access, data storage, and
visibility of properties by setting attributes. Subclasses do not inherit superclass member
attributes.

Specifying Property Attributes

Assign property attributes on the same line as the properties keyword:
properties (Attribute1 = value1, Attribute2 = value2,...)
...
end

For example, give the Data property private access:

properties (Access = private)
Data
end

For more information on attribute syntax, see Attribute Specification on page 5-22.

Table of Property Attributes

All properties support the attributes listed in the following table. Attribute values apply
to all properties defined within the properties...end code block that specifies the
nondefault values.
Property Attributes
8-7

Properties Storing Class Data

Attribute Name

Class

Description

AbortSet

logical

If true, MATLAB does not set the

property value if the new value is the same
as the current value. MATLAB does not
call the property set method, if one exists.

default = false

For handle classes, setting AbortSet

to true also prevent the triggering of
property PreSet and PostSet events.
See Abort Property Set Events on page
11-41
Abstract

logical
default = false

If true, the property has no

implementation, but a concrete subclass
must redefine this property without
Abstract being set to true.
Abstract properties cannot define set
or get access methods. See Property
Access Methods on page 8-23.
Abstract properties cannot define
initial values. See Assigning a Default
Value on page 8-5.
All subclasses must specify the same
values as the superclass for the
property SetAccess and GetAccess
attributes.
Abstract=true use with the class
attribute Sealed=false (the default).

Access

8-8

enumeration, default = public unrestricted access

public
protected access from class or
meta.class object
subclasses
cell array of
meta.class objects
private access by class members only
(not subclasses)

Property Attributes

Attribute Name

Class

Description
List of classes that have get and set
access to this property. Specify classes as
meta.class objects in the form:
A single meta.class object
A cell array of meta.class objects.
An empty cell array, {}, is the same as
private access.
See Control Access to Class Members on
page 12-25
Use Access to set both SetAccess and
GetAccess to the same value. Query the
values of SetAccess and GetAccess
directly (not Access).

Constant

logical
default = false

Set to true if you want only one value for

this property in all instances of the class:
Subclasses inherit constant properties,
but cannot change them.
Constant properties cannot be
Dependent.
SetAccess is ignored.
See Properties with Constant Values on
page 15-2 for more information.

Dependent

logical
default = false

If false, property value is stored in

object. If true, property value is not
stored in object. The set and get functions
cannot access the property by indexing
into the object using the property name.
MATLAB does not display in the
command window the names and values of
Dependent properties that do not define a
get method (scalar object display only).

8-9

Properties Storing Class Data

Attribute Name

Class

Description
Calculate Data on Demand on page
3-28
Property Get Methods on page
8-32
Avoid Property Initialization Order
Dependency on page 13-10

GetAccess

enumeration

public unrestricted access

default = public

protected access from class or

subclasses
private access by class members only
(not from subclasses)
List classes that have get access to this
property. Specify classes as meta.class
objects in the form:
A single meta.class object
A cell array of meta.class objects.
An empty cell array, {}, is the same as
private access.
See Control Access to Class Members on
page 12-25
MATLAB does not display in the
command window the names and values of
properties having protected or private
GetAccess or properties whose Hidden
attribute is true.
The struct function defines fields for
all properties when converting objects to
structs.

GetObservable

logical
default = false

8-10

If true, and it is a handle class property,

then you can create listeners for access
to this property. The listeners are called

Property Attributes

Attribute Name

Class

Description
whenever property values are queried. See
Property-Set and Query Events on page
11-17

Hidden

logical

Determines if the property should be

shown in a property list (e.g., Property
Inspector, call to set or get, etc.).

default = false

MATLAB does not display in the

command window the names and values
of properties whose Hidden attribute is
true or properties having protected or
private GetAccess.
NonCopyable

logical
default = false

Determine if property value should be

copied when object is copied.
You can set NonCopyable to false only in
handle classes.
For more information, see Exclude
Properties from Copy on page 7-35

SetAccess

enumeration

public unrestricted access

default = public

protected access from class or

subclasses
private access by class members only
(not from subclasses)
immutable property can be set only in
the constructor.
See Mutable and Immutable Properties
on page 8-18
List classes that have set access to this
property. Specify classes as meta.class
objects in the form:
A single meta.class object

8-11

Properties Storing Class Data

Attribute Name

Class

Description
A cell array of meta.class objects.
An empty cell array, {}, is the same as
private access.
See Control Access to Class Members on
page 12-25

SetObservable

logical
default = false

Transient

logical
default = false

8-12

If true, and it is a handle class property,

then you can create listeners for access
to this property. The listeners are called
whenever property values are modified.
See Property-Set and Query Events on
page 11-17
If true, property value is not saved
when object is saved to a file. See Save
and Load Process for Objects on page
13-2 for more about saving objects.

Defining Properties

Defining Properties
In this section...
What You Can Define on page 8-13
Initialize Property Values on page 8-13
Property Default Values on page 8-14
Assign Property Values from Constructor on page 8-14
Initialize Properties to Unique Values on page 8-15
Property Attributes on page 8-15
Property Access Methods on page 8-16
Reference Object Properties Using Variables on page 8-17

What You Can Define

Control aspects of property definitions in the following ways:
Specify a default value for each property individually
Assign property values in a class constructor
Define properties with constant values
Assign property attribute values on a per block basis
Define methods that execute when the property is set or queried
Define properties that do not store values, but whose values depend on other
properties
Note: Always use case sensitive property names in your MATLAB code. Properties
cannot have the same name as the class.

Initialize Property Values

There are two basic approaches to initializing property values:
In the property definition MATLAB evaluates the expression only once and assigns
the same value to the property of every instance.
8-13

Properties Storing Class Data

In a class constructor MATLAB evaluates the assignment expression for each

instance, which ensures that each instance has a unique value.
For more information on the evaluation of expressions that you assign as property
default values, see When MATLAB Evaluates Expressions on page 6-12.

Property Default Values

Within a properties block, you can control an individual property's default value.
Assign default values as a value or MATLAB expressions. Expressions cannot reference
variables. For example:
Prop1 No assignment results in empty [] default value
Prop2 Assign character array as default value
Prop3 Assign result of expression as default value
classdef ClassName
properties
Prop1
Prop2 = 'some text';
Prop3 = sin(pi/12);
end
end

If the class definition does not specify a default property value, MATLAB sets the
property value to empty double ([]).
Note: Evaluation of property default values occurs only when the value is first needed,
and only once when MATLAB first initializes the class. MATLAB does not reevaluate the
expression each time you create an instance of the class.
For more information on the evaluation of expressions that you assign as property
default values, see Evaluation of Expressions in Class Definitions on page 6-9 and
Properties Containing Objects on page 8-38.

Assign Property Values from Constructor

To assign values to a property from within the class constructor, reference the object that
the constructor returns (the output variable obj):
8-14

Defining Properties

classdef MyClass
properties
Prop1
end
methods
function obj = MyClass(intval)
obj.Prop1 = intval;
end
end
end

When you assign a property in the class constructor, MATLAB evaluates the assignment
statement for each object you create. Assign property values in the constructor if you
want each object to contain a unique value for that property.
For example, suppose you want to assign a unique handle object to the property of
another object each time you create one of those objects. Assign the handle object to the
property in the constructor. Call the handle object constructor to create a unique handle
object with each instance of your class.
For more information on constructor methods, see Referencing the Object in a
Constructor on page 9-22.

Initialize Properties to Unique Values

MATLAB assigns properties to the specified default values only once when MATLAB
loads the class definition. Therefore, if you initialize a property value with a handle-class
constructor, MATLAB calls this constructor only once and every instance references the
same handle object. If you want a property value to be initialized to a new instance of a
handle object each time you create an object, assign the property value in the constructor.

Property Attributes
All properties have attributes that modify certain aspects of the property's behavior.
Specified attributes apply to all properties in a particular properties block. For example:
classdef ClassName
properties (PropertyAttribute = value)
Prop1
Prop2
end
end

8-15

Properties Storing Class Data

For example, only methods in the same class definition can modify and query the Salary
and Password properties.
classdef EmployeeInfo
properties (Access = private)
Salary
Password
end
end

This restriction exists because the class defines these properties in a properties block
with the Access attribute set to private.
Property Attributes
For a description of property attributes you can specify, see, Property Attributes on
page 8-7.

Property Access Methods

MATLAB calls whenever setting or querying a property value. Define property set
access or get access methods in methods blocks that specify no attributes and have the
following syntax:
methods
function obj = set.PropertyName(obj,value)
...
end
function value = get.PropertyName(obj)
...
end
end

MATLAB does not call the property set access method when assigning the default value
specified in the property's definition block.
For example, the set.Password method tests the length of the character array assigned
to a property named Password. If there are less than seven characters in the value
assigned to the property, MATLAB returns the error. Otherwise, MATLAB assigns the
specified value to the property.
8-16

Defining Properties

function obj = set.Password(obj,pw)

if numel(pw) < 7
error('Password must have at least 7 characters')
else
obj.Password = pw;
end

For more information on property access methods, see Property Access Methods on
page 8-23.

Reference Object Properties Using Variables

MATLAB can resolve a property name from a char variable using an expression of the
form:
object.(PropertyNameVar)

where PropertyNameVar is a variable containing the name of a valid object property.

Use this syntax when passing property names as arguments. For example, the
getPropValue function returns the value of the KeyType property:
PropName = 'KeyType';
function o = getPropValue(obj,PropName)
o = obj.(PropName);
end

Related Examples

Evaluation of Expressions in Class Definitions on page 6-9

How to Use Properties on page 8-2

8-17

Properties Storing Class Data

Mutable and Immutable Properties

In this section...
Set Access to Property Values on page 8-18
Define Immutable Property on page 8-18

Set Access to Property Values

The property SetAccess attribute enables you to determine under what conditions code
can modify object property values. There are four levels of set access that provide varying
degrees of access to object property values:
SetAccess = public Any code with access to an object can set public property
values. There are differences between the behavior of handle and value classes with
respect to modifying object properties.
SetAccess = protected Only code executing from within class methods or
methods of subclasses can set property values. You cannot change the value of an
object property unless the class or any of its subclasses defines a method to do so.
SetAccess = private Only the defining class can set property values. You can
change the value of an object property only if the class defines a method that sets the
property.
SetAccess = immutable Property value is set during construction. You cannot
change the value of an immutable property after the object is created. Set the value of
the property as a default or in the class constructor.

Define Immutable Property

In this class definition, only the Immute class constructor can set the value of the
CurrentDate property:
classdef Immute
properties (SetAccess = immutable)
CurrentDate
end
methods
function obj = Immute
obj.CurrentDate = date;
end

8-18

Mutable and Immutable Properties

end
end
a = Immute
a =
Immute with properties:
CurrentDate: '19-Oct-2005'

Related Examples

Property Attributes on page 8-7

Object Modification on page 5-59

8-19

Properties Storing Class Data

Restrict Class of Properties

In this section...
Restrict Property Values to Specific Classes on page 8-20
Property Restriction Syntax on page 8-20
Restricted Property Implementation on page 8-21

Restrict Property Values to Specific Classes

Restricting the class of a property value can reduce the need for type checking in
methods and functions that access the data in the property. You can define a default
value for a property in the class definition, but any assignment can overwrite this value
with a new value that is of a different type. To restrict the possible values of a property,
use either of these techniques:
Define a property set method. See Property Access Methods on page 8-23.
Associate a class with the property in the class definition. This association restricts
the values of the property to objects that class. Assignment to restricted properties
follows MATLAB coercion rules for array assignment. See Valid Combinations of
Unlike Classes.
You can restrict a property to any MATLAB fundamental class or to a user-defined class
that is created with the classdef syntax.

Property Restriction Syntax

To restrict property values to a specific class, follow the property name with the name
of the specific class in the property definition block. Optionally assign a default value
after the class name. The default value must be compatible with the class specified in the
property definition.
classdef Myclass
properties
Property Class = defaultValue;
end
end

If you do not specify a default value, MATLAB assigns an empty object of the restricting
class to the property.
8-20

Restrict Class of Properties

Restricted Property Implementation

The RestrictProp class defines two properties with class restriction.
Number Values must be of type double or convertible to double.
Today Values must be of type char or convertible to char. The default value is the
char vector returned by the date function.
classdef RestrictProp
properties
Number double
Today char = date;
end
end

Create an object of the RestrictProp class.

p = RestrictProp
p =
RestrictProp with properties:
Number: []
Today: '10-Sep-2013'

MATLAB performs conversions from any compatible type to the restricting class. For
example, assign a datetime array to the Today property.
p.Today = [datetime('now'),datetime('tomorrow')];
class(p.Today)
ans =
char

Because the datetime class has a char converter, you can assign a datetime array to
the Today property.
Assigning a noncompatible value to a restricted property causes an error.
p.Number = datetime('now');
While setting the 'Number' property of 'RestrictProp':

8-21

Properties Storing Class Data

The following error occurred converting from datetime to double:

Undefined function 'double' for input arguments of type 'datetime'.

Related Examples

8-22

Restrict Property Values to Enumerations on page 14-17

Valid Combinations of Unlike Classes

Property Access Methods

Property Access Methods

In this section...
Properties Provide Access to Class Data on page 8-23
Property Setter and Getter Methods on page 8-23
Set and Get Method Execution and Property Events on page 8-26
Access Methods and Properties Containing Arrays on page 8-27
Access Methods and Arrays of Objects on page 8-27
Modify Property Values with Access Methods on page 8-27

Properties Provide Access to Class Data

In MATLAB, properties can have public access. Therefore, properties can provide access
to data that the class design exposes to users.
Use property access methods to provide error checking or to implement side effects
resulting from property access. Examples of access methods include functions that
update other property values when setting the property or translate the format of a
property value before returning the value.
Performance Considerations with Access Methods
Property access methods do add the overhead of a function call whenever accessing
property values. If performance-critical access to properties occurs inside methods of
the class, define private properties to store values. Use these values inside methods
without any error checking. For less frequent access from outside the class, define public
Dependent properties that use access methods for error checking.
For information on access methods used with Dependent properties, see Access
Methods for Dependent Properties on page 8-34.

Property Setter and Getter Methods

Property access methods execute specific code whenever the property value is queried or
assigned a value. These methods enable you to perform various operations:
8-23

Properties Storing Class Data

Execute code before assigning property values to perform actions such as:
Impose value range restrictions (Restrict Properties to Specific Values on page
3-26)
Check for proper types and dimensions
Provide error handling
Execute code before returning the current values of properties to perform actions such
as:
Calculate the value of properties that do not store values (see Calculate Data on
Demand on page 3-28)
Change the value of other properties
Trigger events (see Overview Events and Listeners on page 11-2)
To control what code can access properties, see Property Attributes on page 8-7.
MATLAB Calls Access Methods
Note: You cannot call property access methods directly. MATLAB calls these
methods when you access property values.
Property access methods execute automatically whenever you set or query the
corresponding property values from outside the access method. MATLAB does not call
access methods recursively. That is, MATLAB does not call the set method when setting
the property from within its set method. Similarly, MATLAB does not call the get method
when querying the property value from within its get method.
Obtain the function handle for the set and get access methods from the property
meta.property object. The meta.property SetMethod and GetMethod properties
contain the function handles that refer to these methods.
Restrictions on Access Methods
Define property access methods only:
For concrete properties (that is, properties that are not abstract)
Within the class that defines the property (unless the property is abstract in that
class, in which case the concrete subclass must define the access method).
8-24

Property Access Methods

MATLAB has no default set or get property access methods. Therefore, if you do not
define property access methods, MATLAB software does not invoke any methods before
assigning or returning property values.
Once defined, only the set and get methods can set and query the actual property values.
See Set Method Behavior on page 8-30 for information on cases where MATLAB
does not call property set methods.
Note: Property set and get access methods are not equivalent to user-callable set and
get methods used to set and query property values from an instance of the class. See
Implement Set/Get Interface for Properties on page 7-25 for information on usercallable set and get methods.
Access Methods Cannot Call Functions to Access Properties
You can set and get property values only from within your property set or get access
method. You cannot call another function from the set or get method and attempt to
access the property value from that function.
For example, an anonymous function that calls another function to do the actual work
cannot access the property value. Similarly, an access function cannot call another
function to access the property value.
Defining Access Methods
Access methods have special names that include the property name. Therefore,
get.PropertyName executes whenever PropertyName is referenced and
set.PropertyName executes whenever PropertyName is assigned a value.
Define property access methods in a methods block that specifies no attributes. You
cannot call these methods directly. MATLAB calls these methods when any code accesses
the properties.
Property access methods do not appear in the list of class methods returned by the
methods command and are not included in the meta.class object Methods property.
Access Method Function Handles
The property meta.property object contains function handles to the property set and
get methods. SetMethod contains a function handle to the set method. GetMethod
contains a function handle to the get method.
8-25

Properties Storing Class Data

Obtain these handles from the meta.property object:

mc = ?ClassName;
mp = findobj(mc.PropertyList,'Name','PropertyName');
fh = mp.GetMethod;

For example, if the class MyClass defines a get method for its Text property, you can
obtain a function handle to this function from the meta.class object:
mc = ?MyClass;
mp = findobj(mc.PropertyList,'Name','Text');
fh = mp.GetMethod;

The returned value, fh, contains a function handle to the get method defined for the
specified property name for the specified class.
For information on defining function handles, see Create Function Handle

Set and Get Method Execution and Property Events

MATLAB software generates events before and after set and get operations. You can use
these events to inform listeners that property values have been referenced or assigned.
The timing of event generation is as follows:
PreGet Triggered before calling the property get method
PostGet Triggered after the property get method has returned its value
If a class computes a property value (Dependent = true), then the behaviors of its set
events are like the get events:
PreSet Triggered before calling the property set method
PostSet Triggered after calling the property set method
If a property is not computed (Dependent = false, the default), then the assignment
statement with the set method generates the events:
PreSet Triggered before assigning the new property value within the set method
PostSet Triggered after assigning the new property value within the set method
For information about using property events, see Create Property Listeners on page
11-37.
8-26

Property Access Methods

Access Methods and Properties Containing Arrays

You can use array indexing with properties that contain arrays without interfering with
property set and get methods.
For indexed reference:
val = obj.PropName(n);

MATLAB calls the get method to get the referenced value.

For indexed assignment:
obj.PropName(n) = val;

MATLAB:
Invokes the get method to get the property value
Performs the indexed assignment on the returned property
Passes the new property value to the set method

Access Methods and Arrays of Objects

When reference or assignment occurs on an object array, MATLAB calls the set and get
methods in a loop. In this loop, MATLAB always passes scalar objects to set and get
methods.

Modify Property Values with Access Methods

Property access methods are useful in cases where you want to perform some additional
steps before assigning or returning a property value. For example, the Testpoint class
uses a property set method to check the range of a value. It then applies scaling if it is
within a particular range, and set it to NaN if it is not.
The property get methods applies a scale factor before returning its current value:
classdef Testpoint
properties
expectedResult = [];
end
properties(Constant)

8-27

Properties Storing Class Data

scalingFactor = 0.001;
end
methods
function obj = set.expectedResult(obj,erIn)
if erIn >= 0 && erIn <= 100
erIn = erIn.*obj.scalingFactor;
obj.expectedResult = erIn;
else
obj.expectedResult = NaN;
end
end
function er = get.expectedResult(obj)
er = obj.expectedResult/obj.scalingFactor;
end
end
end

More About

8-28

Properties Containing Objects on page 8-38

Property Set Methods

Property Set Methods

In this section...
Overview of Property Access Methods on page 8-29
Property Set Method Syntax on page 8-29
Validate Property Set Value on page 8-30
Set Method Behavior on page 8-30

Overview of Property Access Methods

For an overview of property access methods, see Property Access Methods on page 8-23

Property Set Method Syntax

MATLAB calls a property's set method whenever a value is assigned to the property.
Property set methods have the following syntax, where PropertyName is the name of
the property.
For a value class:
methods
function obj = set.PropertyName(obj,value)
...
end

obj Object whose property is being assigned a value

value The new value that is assigned to the property
Value class set functions must return the modified object to the calling function. Handle
classes do not need to return the modified object.
For a handle class:
methods
function set.PropertyName(obj,value)
...
end

8-29

Properties Storing Class Data

Use default method attributes for property set methods. The methods block defining the
set method cannot specify attributes.

Validate Property Set Value

Use the property set method to validate the value being assigned to the property. The
property set method can perform actions like error checking on the input value before
taking whatever action is necessary to store the new property value.
classdef MyClass
properties
Prop1
end
methods
function obj = set.Prop1(obj,value)
if (value > 0)
obj.Prop1 = value;
else
error('Property value must be positive')
end
end
end
end

For an example of a property set method, see Restrict Properties to Specific Values on
page 3-26 .

Set Method Behavior

If a property set method exists, MATLAB calls it whenever a value is assigned to that
property. However, MATLAB does NOT call property set methods in the following cases:
Assigning a value to a property from within its own property set method, to prevent
recursive calling of the set method. However, property assignments made from
functions called by a set method do call the set method.
Initializing default values in class definitions when loading the class
Assigning a property to its default value that is specified in the class definition
Copying a value object (that is, not derived from the handle class). MATLAB does not
call the set or get method when copying property values from one object to another.
8-30

Property Set Methods

Assigning a property value that is the same as the current value when the propertys
AbortSet attribute is true. See Abort Property Set Events on page 11-41 for
more information on this attribute.
A set method for one property can assign values to other properties of the object. These
assignments do call any set methods defined for the other properties. For example, a
graphics window object can have a Units property and a Size property. Changing the
Units property can also require a change to the values of the Size property to reflect the
new units.

8-31

Properties Storing Class Data

Property Get Methods

In this section...
Overview of Property Access Methods on page 8-32
Property Get Method Syntax on page 8-32
Calculate Value for Dependent Property on page 8-32
Errors Not Returned from Get Method on page 8-33
Get Method Behavior on page 8-33

Overview of Property Access Methods

For an overview of property access methods, see Property Access Methods on page 8-23

Property Get Method Syntax

MATLAB calls a property's get method whenever the property value is queried.
Property get methods have the following syntax, where PropertyName is the name of
the property. The function must return the property value.
methods
function value = get.PropertyName(obj)
...
end

Calculate Value for Dependent Property

The SquareArea class defines a dependent property Area. MATLAB does not store a
value for the dependent Area property. When you query the value of the Area property,
MATLAB calls the get.Area method calculates the value based on the Width and
Height properties.
classdef SquareArea
properties
Width
Height
end
properties (Dependent)

8-32

Property Get Methods

Area
end
methods
function a = get.Area(obj)
a = obj.Width * obj.Height;
end
end
end

Errors Not Returned from Get Method

The MATLAB default object display suppresses error messages returned from property
get methods. MATLAB does not allow an error issued by a property get method to
prevent the display of the entire object.
Use the property set method to validate the property value. Validating the value when
setting a property ensures that the object is in a valid state. Use the property get method
only to return the value that the set method has validated.

Get Method Behavior

MATLAB does NOT call property get methods in the following cases:
Getting a property value from within its own property get method, which prevents
recursive calling of the get method
Copying a value object (that is, not derived from the handle class). Neither the set or
get method is called when copying property values from one object to another.

Related Examples

Access Methods for Dependent Properties on page 8-34

8-33

Properties Storing Class Data

Access Methods for Dependent Properties

In this section...
Set and Get Methods for Dependent Properties on page 8-34
Get Method for Dependent Property on page 8-35
When to Use Set Methods with Dependent Properties on page 8-35
Private Set Access with Dependent Properties on page 8-36

Set and Get Methods for Dependent Properties

Dependent properties do not store data because the value of a dependent property
depends on the current state of something else, like a concrete property value. Dependent
properties must define a get method to determine the value for the property, when
queried.
Typically, the property get method queries other property values to determine what
value to return for the dependent property.
For example, the Account class returns a value for the dependent Balance property
that depends on the value of the Currency property. The get.Balance method queries
the Currency property before calculating a value for the Balance property.
MATLAB calls the get.Balance method when the Balance property is queried. You
cannot call get.Balance explicitly.
Here is a partial listing of the class showing a dependent property and its get method:
classdef Account
properties
Currency
DollarAmount
end
properties (Dependent)
Balance
end
...
methods
function value = get.Balance(obj)
c = obj.Currency;
switch c

8-34

Access Methods for Dependent Properties

case 'E'
v = obj.DollarAmount / 1.3;
case 'P'
v = obj.DollarAmount / 1.5;
otherwise
v = obj.DollarAmount;
end
format bank
value = v;
end
end
end

Get Method for Dependent Property

One application of a property get method is to determine the value of a property only
when you need it, and avoid storing the value. To use this approach, set the property
Dependent attribute to true:
properties (Dependent = true)
PropertyName
end

Now the get method for the PropertyName property determines the value of that
property and assigns it to the object from within the method:
function value = get.PropertyName(obj)
value = calculateValue;
...
end

The get method calls a function or static method calculateValue to calculate the
property value and returns value to the code accessing the property. The property get
method can take whatever action is necessary within the method to produce the output
value.
Calculate Data on Demand on page 3-28 provide an example of a property get method.

When to Use Set Methods with Dependent Properties

Although a dependent property does not store its value, there are situations in which you
want to define a set method for a dependent property.
8-35

Properties Storing Class Data

For example, suppose that you have a class that changes the name of a property from
OldPropName to NewPropName. To continue to allow the use of the old name without
exposing it to new users, make OldPropName a dependent property with set and get
methods:
properties
NewPropName
end
properties (Dependent, Hidden)
OldPropName
end
methods
function obj = set.OldPropName(obj,val)
obj.NewPropName = val;
end
function value = get.OldPropName(obj)
value = obj.NewPropName;
end
end

There is no memory wasted by storing both old and new property values, and code that
accesses OldPropName continues to work as expected.
It is sometimes useful for a set method of a dependent property to assign values to
other properties of the object. Assignments made from property set methods cause
the execution of any set methods defined for those properties. See Calculate Data on
Demand on page 3-28 for an example.

Private Set Access with Dependent Properties

If you use a dependent property only to return a value, then do not define a set access
method for the dependent property. Instead, set the SetAccess attribute of the
dependent property to private. For example, consider the following get method for the
MaxValue property:
methods
function mval = get.MaxValue(obj)
mval = max(obj.BigArray(:));
end
end

This example uses the MaxValue property to return a value that it calculates only when
queried. For this application, define the MaxValue property as dependent and private:
8-36

Access Methods for Dependent Properties

properties (Dependent, SetAccess = private)

MaxValue
end

Related Examples

Property Attributes on page 8-7

8-37

Properties Storing Class Data

Properties Containing Objects

In this section...
Assigning Objects as Default Property Values on page 8-38
Assigning to Read-Only Properties Containing Objects on page 8-38
Assignment Behavior on page 8-38

Assigning Objects as Default Property Values

MATLAB evaluates property default values only once when loading the class. MATLAB
does not reevaluate the assignment each time you create an object of that class. If you
assign an object as a default property value in the class definition, MATLAB calls the
constructor for that object only once when loading the class.
Note: Evaluation of property default values occurs only when the value is first needed,
and only once when MATLAB first initializes the class. MATLAB does not reevaluate the
expression each time you create an instance of the class.
For more information on the evaluation of expressions that you assign as property
default values, see When MATLAB Evaluates Expressions on page 6-12.

Assigning to Read-Only Properties Containing Objects

When a class defines a property with private or protected SetAccess, and that property
contains an object which itself has properties, assignment behavior depends on whether
the property contains a handle or a value object:
Handle object you can set properties on handle objects contained in read-only
properties
Value object you cannot set properties on value object contained in read-only
properties.

Assignment Behavior
These classes illustrate the assignment behavior:
8-38

Properties Containing Objects

ReadOnlyProps class with two read-only properties. The class constructor assigns
a handle object of type HanClass to the PropHandle property and a value object of
type ValClass to the PropValue property.
HanClass handle class with public property
ValClass value class with public property
classdef ReadOnlyProps
properties(SetAccess = private)
PropHandle
PropValue
end
methods
function obj = ReadOnlyProps
obj.PropHandle = HanClass;
obj.PropValue = ValClass;
end
end
end
classdef HanClass < handle
properties
Hprop
end
end
classdef ValClass
properties
Vprop
end
end

Create an instance of the ReadOnlyProps class:

a = ReadOnlyProps
a =
ReadOnlyProps with properties:
PropHandle: [1x1 HanClass]
PropValue: [1x1 ValClass]

8-39

Properties Storing Class Data

Use the private PropHandle property to set the property of the HanClass object it
contains:
class(a.PropHandle.Hprop)
ans =
double
a.PropHandle.Hprop = 7;

Attempting to make an assignment to the value class object property is not allowed:
a.PropValue.Vprop = 11;
You cannot set the read-only property 'PropValue' of ReadOnlyProps.

More About

8-40

Mutable and Immutable Properties on page 8-18

Dynamic Properties Adding Properties to an Instance

Dynamic Properties Adding Properties to an Instance

In this section...
What Are Dynamic Properties on page 8-41
Define Dynamic Properties on page 8-42

What Are Dynamic Properties

You can add properties to instances of classes that derive from the dynamicprops
class. These dynamic properties are sometimes referred to as instance properties. Use
dynamic properties to attach temporary data to objects or to assign data that you want to
associate with an instance of a class, but not all objects of that class.
It is possible for more than one program to define dynamic properties on the same object.
In these cases, avoid name conflicts. Dynamic property names must be valid MATLAB
identifiers (see Variable Names) and cannot be the same name as a method of the class.
Characteristics of Dynamic Properties
Once defined, dynamic properties behave much like class-defined properties:
Set and query the values of dynamic properties using dot notation. (See Assign Data
to the Dynamic Property on page 8-43.)
MATLAB saves and loads dynamic properties when you save and load the objects to
which they are attached. (See Dynamic Properties and ConstructOnLoad on page
8-51.)
Define attributes for dynamic property. (See Set Dynamic Property Attributes on
page 8-42).
MATLAB does not save property attribute values when you save objects that have
dynamic properties. Therefore, any nondefault attribute setting are not retained when
you load the object. (See Save and Load Dynamic Properties on page 13-36.)
By default, dynamic properties have their NonCopyable attribute set to true. If you
copy an object containing a dynamic property, the dynamic property is not copied.
(See Objects with Dynamic Properties on page 7-37)
Add property set and get access methods. (See Access Methods for Dependent
Properties on page 8-34.)
Listen for dynamic property events. (See Dynamic Property Events on page
8-47.)
8-41

Properties Storing Class Data

Access dynamic property values from object arrays, with restricted syntax. (See
Object Arrays with Dynamic Properties on page 10-13.)
The isequal function always returns false when comparing objects that have
dynamic properties, even if the properties have the same name and value. To compare
objects that contain dynamic properties, overload isequal for your class.

Define Dynamic Properties

Any class that is a subclass of the dynamicprops class (which is itself a subclass of the
handle class) can define dynamic properties using the addprop method. The syntax is:
P = addprop(H,'PropertyName')

where:
P is an array of meta.DynamicProperty objects
H is an array of handles
PropertyName is the name of the dynamic property you are adding to each object
Name Dynamic Properties
Use only valid names when naming dynamic properties (see Variable Names). In
addition, do not use names that:
Are the same as the name of a class method
Are the same as the name of a class event
Contain a period (.)
Set Dynamic Property Attributes
To set property attributes, use the meta.DynamicProperty object associated with the
dynamic property. For example, if P is the object returned by addprop, this statement
sets the propertys Hidden attribute to true:
P.Hidden = true;

The property attributes Constant and Abstract have no meaning for dynamic
properties. Setting the value of these attributes to true has no effect.
8-42

Dynamic Properties Adding Properties to an Instance

Remove a Dynamic Property

Remove the dynamic property by deleting its meta.DynamicProperty object:
delete(P);

Assign Data to the Dynamic Property

Suppose, you are using a predefined set of user interface widget classes (buttons,
sliders, check boxes, etc.). You want to store the location of each instance of the widget
class. Assume that the widget classes are not designed to store location data for your
particular layout scheme. You want to avoid creating a map or hash table to maintain
this information separately.
Assuming the button class is a subclass of dynamicprops, add a dynamic property to
store your layout data. Here is a simple class to create a uicontrol button:
classdef button < dynamicprops
properties
UiHandle
end
methods
function obj = button(pos)
if nargin > 0
if length(pos) == 4
obj.UiHandle = uicontrol('Position',pos,...
'Style','pushbutton');
else
error('Improper position')
end
end
end
end
end

Create an instance of the button class, add a dynamic property, and set its value:
b1 = button([20 40 80 20]);
b1.addprop('myCoord');
b1.myCoord = [2,3];

Access the dynamic property just like any other property, but only on the object on which
you defined it:
b1.myCoord

8-43

Properties Storing Class Data

ans =
2

Related Examples

8-44

Access Methods for Dynamic Properties on page 8-45

Dynamic Property Events on page 8-47

Dynamic Properties and ConstructOnLoad on page 8-51

Access Methods for Dynamic Properties

Access Methods for Dynamic Properties

In this section...
Create Access Methods for Dynamic Properties on page 8-45
Shared Set and Get Methods on page 8-46
You can define property set access or get access methods for dynamic properties without
creating additional class methods. For general information on the use of access methods,
see Property Access Methods on page 8-23.

Create Access Methods for Dynamic Properties

Use these steps to create a property access method:
Define a function that implements the operations you want to perform before the
property set or get occurs. These methods must have the following signatures:
mySet(obj,val) or val = myGet(obj)
Obtain the dynamic property's corresponding meta.DynamicProperty object.
Assign a function handle referencing your set or get property function to the
meta.DynamicProperty object's GetMethod or SetMethod property. This function
does not need to be a method of the class. You cannot use a naming scheme like
set.PropertyName. Instead, use any other valid function name.
Suppose that you want to create a property set function for the myCoord dynamic
property of the button class created previously. Write the function as follows.
function set_myCoord(obj,val)
if ~(length(val) == 2)
error('myCoords require two values')
end
obj.myCoord = val;
end

Because button is a handle class, the property set function does not need to return the
object as an output argument.
To get the meta.DynamicProperty object, use the handle class findprop method:
mb1 = b1.findprop('myCoord');
mb1.SetMethod = @set_myCoord;

8-45

Properties Storing Class Data

MATLAB calls the property set function whenever you set this property:
b1.myCoord = [1 2 3] % length must be two
Error using button.set_myCoord
myCoords require two values

You can set and get the property values only from within your property access methods.
You cannot call another function from the set or get method, and then attempt to access
the property value from that function.

Shared Set and Get Methods

You can use the same function handle for the set or get method of multiple dynamic
properties. However, reference or assignment to a property from within its set or get
method does not invoke the set or get method again. Therefore, if you use a handle to the
same function for multiple dynamic properties, then a single function is the set or get
method for multiple properties. That function is not invoked when accessing any of those
properties from within that function.

Related Examples

8-46

Dynamic Properties Adding Properties to an Instance on page 8-41

Dynamic Property Events

Dynamic Property Events

In this section...
Dynamic Properties and Ordinary Property Events on page 8-47
Dynamic-Property Events on page 8-47
Listen for a Specific Property Name on page 8-48
PropertyAdded Event Callback Execution on page 8-49
PropertyRemoved Event Callback Execution on page 8-50
How to Find meta.DynamicProperty Objects on page 8-50

Dynamic Properties and Ordinary Property Events

Dynamic properties support property set and get events so you can define listeners for
these properties. Listeners are bound to the particular dynamic property for which they
are defined.
If you delete a dynamic property, and then create another dynamic property with the
same name, the listeners do not respond to events generated by the new property. A
listener defined for a dynamic property that has been deleted does not cause an error, but
the listener callback is never executed.
Property-Set and Query Events on page 11-17 provides more information on how to
define listeners for these events.

Dynamic-Property Events
To respond to the addition and removal of dynamic properties, attach listeners to objects
containing the dynamic properties. The dynamicprops class defines events for this
purpose:
PropertyAdded Triggered when you add a dynamic property to an object derived
from the dynamicprops class.
PropertyRemoved Triggered when you delete the object or the
meta.DynamicProperty object associated with a dynamic property.
ObjectBeingDestroyed Triggered when the object is destroyed. This event is
inherited from the handle class.
8-47

Properties Storing Class Data

These events have public listen access (ListenAccess attribute) and private notify
access (NotifyAccess attribute).
The PropertyAdded and PropertyRemoved events pass an
event.DynamicPropertyEvent object to listener callbacks. The event data object has three
properties:
PropertyName Name of the dynamic property that is added or removed
Source Handle to the object that is the source of the event
EventName Name of the event (PropertyAdded, PropertyRemoved, or
ObjectBeingDestroyed)

Listen for a Specific Property Name

Suppose that you have an application that creates a dynamic property under certain
conditions. You want to:
Set the value of a hidden property to true when a property named SpecialProp is
added.
Set the value of the hidden property to false when SpecialProp is removed.
Use the event.DynamicPropertyEvent event data to determine the name of the
property and whether it is added or deleted.
The DynamTest class derives from dynamicprops. It defines a hidden property,
HiddenProp.
classdef DynamTest < dynamicprops
properties (Hidden)
HiddenProp
end
end

Define a callback function that uses the EventName property of the event data to
determine if a property is added or removed. Obtain the name of the property from
the PropertyName property of the event data. If a dynamic property is named
SpecialProp, change the value of the hidden property.
function DyPropEvtCb(src,evt)
switch evt.EventName

8-48

Dynamic Property Events

case 'PropertyAdded'
switch evt.PropertyName
case 'SpecialProp'
% Take action based on the addition of this property
%...
%...
src.HiddenProp = true;
disp('SpecialProp added')
otherwise
% Other property added
% ...
disp([evt.PropertyName,' added'])
end
case 'PropertyRemoved'
switch evt.PropertyName
case 'SpecialProp'
% Take action based on the removal of this property
%...
%...
src.HiddenProp = false;
disp('SpecialProp removed')
otherwise
% Other property removed
% ...
disp([evt.PropertyName,' removed'])
end
end
end

Create an object of the DynamTest class.

dt = DynamTest;

Add a listener for both PropertyAdded and PropertyRemoved events.

lad = addlistener(dt,'PropertyAdded',@DyPropEvtCb);
lrm = addlistener(dt,'PropertyRemoved',@DyPropEvtCb);

PropertyAdded Event Callback Execution

Adding a dynamic property triggers the PropertyAdded event. This statement adds a
dynamic property to the object and saves the returned meta.DynamicProperty object.
ad = addprop(dt,'SpecialProp');

8-49

Properties Storing Class Data

The addition of the dynamic property causes the listener to execute its callback function,
DyPropEvtCb. The callback function assigns a value of true to the HiddenProp
property.
dt.HiddenProp
ans =
1

PropertyRemoved Event Callback Execution

Remove a dynamic property by calling delete on the meta.DynamicProperty object
that is returned by the addprop method. Removing the meta.DynamicProperty object
triggers the PropertyRemoved event.
Delete the meta.DynamicProperty object returned when adding the dynamic property
SpecialProp.
delete(ad)

The callback executes:

SpecialProp removed

The value of HiddenProp is now false.

dt.HiddenProp
ans =
0

How to Find meta.DynamicProperty Objects

You can obtain the meta.DynamicProperty object for a dynamic property using
findprop. Use findprop if you do not have the object returned by addprop.
ad = findprop(dt,'SpecialProp');

Related Examples

8-50

Dynamic Properties Adding Properties to an Instance on page 8-41

Dynamic Properties and ConstructOnLoad

Dynamic Properties and ConstructOnLoad

Setting the class ConstructOnLoad attribute to true causes MATLAB to call the class
constructor when loading the class. MATLAB saves and restores dynamic properties
when loading an object.
If you create dynamic properties from the class constructor, you can cause a conflict if
you also set the class ConstructOnLoad attribute to true. Here is the sequence:
A saved object saves the names and values of properties, including dynamic properties
When loaded, a new object is created and all properties are restored to the values at
the time the object was saved
Then, the ConstructOnLoad attribute causes a call to the class constructor, which
would create another dynamic property with the same name as the loaded property.
See Save and Load Objects on page 13-2 for more on the load sequence.
MATLAB prevents a conflict by loading the saved dynamic property, and does not
execute addprop when calling the constructor.
If you use ConstructOnLoad, add dynamic properties from the class constructor,
and want the constructor to call addprop at load time, then set the dynamic property
Transient attribute to true. This setting prevents the property from being saved. For
example:
classdef (ConstructOnLoad) MyClass < dynamicprops
function obj = MyClass
P = addprop(obj,'DynProp');
P.Transient = true;
...
end
end

Related Examples

Dynamic Properties Adding Properties to an Instance on page 8-41

8-51

9
Methods Defining Class Operations
How to Use Methods on page 9-2
Method Attributes on page 9-5
Ordinary Methods on page 9-7
Methods In Separate Files on page 9-10
Method Invocation on page 9-14
Class Constructor Methods on page 9-20
Static Methods on page 9-28
Overload Functions in Class Definitions on page 9-30
Class Support for Array-Creation Functions on page 9-34
Object Precedence in Method Invocation on page 9-44
Dominant Argument in Overloaded Graphics Functions on page 9-46
Class Methods for Graphics Callbacks on page 9-49

Methods Defining Class Operations

How to Use Methods

In this section...
Class Methods on page 9-2
Method Naming on page 9-3

Class Methods
Methods are functions that implement the operations performed on objects of a class.
Methods, along with other class members support the concept of encapsulationclass
instances contain data in properties and class methods operate on that data. This allows
the internal workings of classes to be hidden from code outside of the class, and thereby
enabling the class implementation to change without affecting code that is external to
the class.
Methods have access to private members of their class including other methods and
properties. This enables you to hide data and create special interfaces that must be used
to access the data stored in objects.
See Methods That Modify Default Behavior on page 17-2 for a discussion of how to
create classes that modify standard MATLAB behavior.
See Class Files and Folders on page 5-2 for information on the use of @ and path
directors and packages to organize your class files.
See Methods In Separate Files on page 9-10 for the syntax to use when defining
classes in more than one file.
Kinds of Methods
There are specialized kinds of methods that perform certain functions or behave in
particular ways:
Ordinary methods are functions that act on one or more objects and return some new
object or some computed value. These methods are like ordinary MATLAB functions
that cannot modify input arguments. Ordinary methods enable classes to implement
arithmetic operators and computational functions. These methods require an object of
the class on which to operate. See Ordinary Methods on page 9-7.
Constructor methods are specialized methods that create objects of the class. A
constructor method must have the same name as the class and typically initializes
9-2

How to Use Methods

property values with data obtained from input arguments. The class constructor
method must return the object it creates. See Class Constructor Methods on page
9-20
Destructor methods are called automatically when the object is destroyed, for example
if you call delete(object) or there are no longer any references to the object. See
Handle Class Destructor on page 7-16
Property access methods enable a class to define code to execute whenever a property
value is queried or set. See Property Access Methods on page 8-23
Static methods are functions that are associated with a class, but do not necessarily
operate on class objects. These methods do not require an instance of the class to be
referenced during invocation of the method, but typically perform operations in a way
specific to the class. See Static Methods on page 9-28
Conversion methods are overloaded constructor methods from other classes that
enable your class to convert its own objects to the class of the overloaded constructor.
For example, if your class implements a double method, then this method is called
instead of the double class constructor to convert your class object to a MATLAB
double object. See Object Converters on page 17-11 for more information.
Abstract methods serve to define a class that cannot be instantiated itself, but serves
as a way to define a common interface used by a number of subclasses. Classes that
contain abstract methods are often referred to as interfaces. See Abstract Classes on
page 12-82 for more information and examples.

Method Naming
The name of a function that implements a method can contain dots (for example,
set.PropertyName) only if the method is one of the following:
Property set/get access method (see Property Access Methods on page 8-23)
Conversion method that converts to a package-qualified class, which requires the use
of the package name (see Packages Create Namespaces on page 6-24)
You cannot define property access or conversion methods as local functions, nested
functions, or separately in their own files. Class constructors and package-scoped
functions must use the unqualified name in the function definition; do not include the
package name in the function definition statement.

Related Examples

Method Attributes on page 9-5

9-3

Methods Defining Class Operations

9-4

Rules for Naming to Avoid Conflicts on page 9-32

Method Attributes

Method Attributes
In this section...
Purpose of Method Attributes on page 9-5
Specifying Method Attributes on page 9-5
Table of Method Attributes on page 9-5

Purpose of Method Attributes

Specifying attributes in the class definition enables you to customize the behavior
of methods for specific purposes. Control characteristics like access, visibility, and
implementation by setting method attributes. Subclasses do not inherit superclass
member attributes.

Specifying Method Attributes

Assign method attributes on the same line as the methods keyword:
methods (Attribute1 = value1, Attribute2 = value2,...)
...
end

For more information on attribute syntax, see Attribute Specification on page 5-22.

Table of Method Attributes

Attributes enable you to modify the behavior of methods. All methods support the
attributes listed in the following table.
Attribute values apply to all methods defined within the methods...end code block that
specifies the nondefault values.
Method Attributes
Attribute Name Class
Abstract

Description

logical Default = If true, the method has no implementation. The method has
false
a syntax line that can include arguments, which subclasses
use when implementing the method:
9-5

Methods Defining Class Operations

Attribute Name Class

Description
Subclasses are not required to define the same number
of input and output arguments. However, subclasses
generally use the same signature when implementing
their version of the method.
The method can have comments after the function line.
The method does not contain function or end keywords,
only the function syntax (e.g., [a,b] = myMethod(x,y))

Access

enumeration,
default =
public
meta.class
object
cell array of
meta.class
objects

Determines what code can call this method:

public Unrestricted access
protected Access from methods in class or subclasses
private Access by class methods only (not from
subclasses)
List classes that have access to this method. Specify
classes as meta.class objects in the form:
A single meta.class object
A cell array of meta.class objects. An empty cell
array, {}, is the same as private access.
See Control Access to Class Members on page 12-25

Hidden

logical Default = When false, the method name shows in the list of methods
false
displayed using the methods or methodsview commands. If
set to true, the method name is not included in these listings
and ismethod does not return true for this method name. .

Sealed

logical Default = If true, the method cannot be redefined in a subclass.

false
Attempting to define a method with the same name in a
subclass causes an error.

Static

logical Default = Specify as true to define a method that does not depend
false
on an object of the class and does not require an object
argument. Use the class name to call the method:
classname.methodname or an instance of the class:
obj.methodname
Static Methods on page 9-28 provides more information.

9-6

Ordinary Methods

Ordinary Methods
In this section...
Ordinary Methods Operate on Objects on page 9-7
Methods Inside classdef Block on page 9-7
Method Files on page 9-8

Ordinary Methods Operate on Objects

Ordinary methods define functions that operate on objects of the class. Therefore,
one of the input arguments must be an object or array of objects of the defining class.
These methods can compute values based on object data, can overload MATLAB builtin functions, and can call other methods and functions. Ordinary methods can return
modified objects.

Methods Inside classdef Block

This example shows the definition of a method (methodName) within the classdef and
methods blocks:
classdef ClassName
methods (AttributeName = value,...)
function methodName(obj,args)
% method code
...
end
...
end % end of method block
...
end

Method attributes apply only to that particular methods block, which is terminated by
the end statement.
Note: Nonstatic methods must include an explicit object variable as a function argument.
The MATLAB language does not support an implicit reference in the method function
definition.
9-7

Methods Defining Class Operations

Sample Method
The addData method adds a value to the Data property of MyData objects. The Data
property has a default value of 0.
classdef MyData
properties
Data = 0;
end
methods
function obj = addData(obj,val)
newData = obj.Data + val;
obj.Data = newData;
end
end
end
a = MyData;
a = addData(a,75)
a =
MyData with properties:
Data: 75

Calling Methods
Either of the following statements is correct syntax for calling a method, where obj is an
object of the class defining the methodName method:
obj.methodName(arg)
methodName(obj,arg)

Method Files
You can define methods:
Inside the class definition block
In a separate file in the class folder (that is, @ClassName folder)
For more information on class folders, see Folders Containing Class Definitions on page
6-16.
9-8

Ordinary Methods

More About

Methods In Separate Files on page 9-10

Determining Which Method Is Invoked on page 9-14

Operator Overloading on page 17-48

9-9

Methods Defining Class Operations

Methods In Separate Files

In this section...
Class Folders on page 9-10
Define Method in Function File on page 9-11
Specify Method Attributes in classdef File on page 9-11
Methods That You Must Define In the classdef File on page 9-12

Class Folders
You can define class methods in files that are separate from the class definition file, with
certain exceptions (see Methods That You Must Define In the classdef File on page
9-12).
To use multiple files for class definitions, put the class files in a folder having a name
beginning with the @ character followed by the name of the class (this is called a class
folder). Ensure that the parent folder of the class folder is on the MATLAB path.
If the class folder is contained in one or more package folders, then the top-level package
folder must be on the MATLAB path.
For example, the folder @MyClass must contain the file MyClass.m (which contains the
classdef block) and can contain other methods and function defined in files having a .m
extension. The folder @MyClass can contain a number of files:
@MyClass/MyClass.m
@MyClass/subsref.m
@MyClass/subsasgn.m
@MyClass/horzcat.m
@MyClass/vertcat.m
@MyClass/myFunc.m

Note: MATLAB treats any .m file in the class folder as a method of the class. The base
name of the file must be a valid MATLAB function name. Valid function names begin
with an alphabetic character, and can contain letters, numbers, or underscores.

9-10

Methods In Separate Files

Define Method in Function File

To define a method in a separate file in the class folder, create the function in a file with
the .m extension. Do not use the method-end keywords in that file. Name the file with
the function name, as with any function.
In the myFunc.m file, implement the method:
function output = myFunc(obj,arg1,arg2)
...% code here
end

It is a good practice to declare the function signature in the classdef file in a methods
block:
classdef MyClass
methods
output = myFunc(obj,arg1,arg2)
end
...
end

Specify Method Attributes in classdef File

If you specify method attributes for a method that you define in a separate function file,
include the method signature in a methods block in the classdef file. This methods
block specifies the attributes that apply to the method.
For example, the following code shows a method with Access set to private in the
methods block. The method implementation resides in a separate file. Do not include the
function or end keywords in the methods block. Include only the function signature
showing input and output arguments.
classdef MyClass
methods (Access = private)
output = myFunc(obj,arg1,arg2)
end
end

In a file named myFunc.m, in the @MyClass folder, define the function:

function output = myFunc(obj,arg1,arg2)
...

9-11

Methods Defining Class Operations

end

Static Methods in Separate Files

To create a static method, set the method Static attribute to true and list the function
signature in a static methods block in the classdef file. Include the input and output
arguments with the function name. For example:
classdef MyClass
...
methods (Static)
output = staticFunc1(arg1,arg2)
staticFunc2
end
...
end

Define the functions in separate files using the same function signature. For example, in
the file @MyClass/staticFunc1.m:
function output = staticFunc1(arg1,arg2)
...
end

and in @Myclass/staticFunc2.m:
function staticFunc2
...
end

Methods That You Must Define In the classdef File

You must define the following methods in the classdef file. You cannot defines these
methods in separate files:
Class constructor
Handle class delete methods
All functions that use dots in their names, including:
Converter methods that must use the package name as part of the class name
because the class is contained in packages
Property set and get access methods
9-12

Methods In Separate Files

Related Information
Converters for Package Classes on page 17-11
Property Access Methods on page 8-23

Related Examples

Folders Containing Class Definitions on page 6-16

9-13

Methods Defining Class Operations

Method Invocation
In this section...
Determining Which Method Is Invoked on page 9-14
Referencing Names with ExpressionsDynamic Reference on page 9-16
Controlling Access to Methods on page 9-17
Invoking Superclass Methods in Subclass Methods on page 9-18
Invoking Built-In Functions on page 9-19

Determining Which Method Is Invoked

When MATLAB invokes an ordinary method that has an argument list, it uses the
following criteria to determine which method to call
The class of the left-most argument whose class is not specified as inferior to any
other argument's class is chosen as the dominant class and its method is invoked.
If this class does not define the named method, then a function with that name on the
MATLAB path is invoked.
If no such function exists, MATLAB issues an error indicating that the dominant class
does not define the named method.
Dominant Argument
The dominant argument in a method's argument list determines which version of the
method or function that the MATLAB runtime calls. Dominance is determined by the
relative precedences of the classes of the arguments. In general, user-defined classes take
precedence over built-in MATLAB classes. Therefore, the left most argument determines
which method to call. However, user-defined classes can specify the relative dominance of
specific classes.
For example, suppose classA defines classB as inferior and suppose both classes define
a method called combine.
Calling the method with an object of classB and classA:
combine(B,A)

actually calls the combine method of classA because A is the dominant argument.
9-14

Method Invocation

Dot Notation vs. Function Notation

MATLAB classes support both function and dot notation syntax for calling methods. For
example, if setColor is a method of the class of object X, then calling setColor with
function notation would be:
X = setColor(X,'red');

The equivalent method call using dot notation is:

X = X.setColor('red')

However, in certain cases, the results for dot notation can differ with respect to how
MATLAB dispatching works:
If there is an overloaded subsref, it is invoked whenever using dot-notation. That is,
the statement is first tested to see if it is subscripted assignment.
If there is no overloaded subsref, then setColor must be a method of X. An
ordinary function or a class constructor is never called using this notation.
Only the argument X (to the left of the dot) is used for dispatching. No other
arguments, even if dominant, are considered. Therefore dot notation can call only
methods of X; methods of other argument are never called.
Case Where Result is Different

Here is an example of a case where dot and function notation can give different results.
Suppose you have the following classes:
classA defines a method called methodA that requires an object of classB as one of
its arguments
classB defines classA as inferior to classB
classdef classB (InferiorClasses = {?classA})
...
end

The methodA method is defined with two input arguments, one of which is an object of
classB:
classdef classA
methods
function methodA(obj,obj_classB)
...

9-15

Methods Defining Class Operations

end
end

classB does not define a method with the same name as methodA. Therefore, the
following syntax causes the MATLAB runtime to search the path for a function with
the same name as methodA because the second argument is an object of a dominant
class. If a function with that name exists on the path, then MATLAB attempts to call this
function instead of the method of classA and most likely returns a syntax error.
obj = classA(...);
methodA(obj,obj_classB)

Dot notation is stricter in its behavior. For example, this call to methodA:
obj = classA(...);
obj.methodA(obj_classB)

can call only methodA of the class of obj.

Referencing Names with ExpressionsDynamic Reference

You can reference an object's properties or methods using an expression in dotparentheses syntax:
obj.(expression)

The expression must evaluate to a char vector that is the name of a property or a
method. For example, the following statements are equivalent:
obj.Property1
obj.('Property1')

In this case, obj is an object of a class that defines a property called Property1.
Therefore, you can pass a char variable in the parentheses to reference to property:
propName = 'Property1';
obj.(propName)

You can call a method and pass input arguments to the method using another set of
parentheses:
obj.(expression)(arg1,arg2,...)

Using this notation, you can make dynamic references to properties and methods in the
same way you can create dynamic references to the fields of structs.
9-16

Method Invocation

As an example, suppose an object has methods corresponding to each day of the week.
These methods have the same names as the days of the week (Monday, Tuesday, and
so on). Also, the methods take as char vector input arguments, the current day of the
month (the date). Now suppose you write a function in which you want to call the correct
method for the current day.
Use an expression created with the date and datestr functions:
obj.(datestr(date,'dddd'))(datestr(date,'dd'))

The expression datestr(date,'dddd') returns the current day as a char vector. For
example:
datestr(date,'dddd')
ans =
Tuesday

The expression datestr(date,'dd') returns the current date as a char vector. For
example:
datestr(date,'dd')
ans =
11

Therefore, the expression using dot-parentheses (called on Tuesday the 11th) is the
equivalent of:
obj.Tuesday('11')

Controlling Access to Methods

There might be situations where you want to create methods for internal computation
within the class, but do not want to publish these methods as part of the public interface
to the class. In these cases, you can use the Access attribute to set the access to one of
the following options:
public Any code having access to an object of the class can access this method (the
default).
9-17

Methods Defining Class Operations

private Restricts method access to the defining class, excluding subclasses.

Subclasses do not inherit private methods.
protected Restricts method access to the defining class and subclasses derived
from the defining class. Subclasses inherit this method.
Access list Restricts method access to classes in access list. For more information,
see Control Access to Class Members on page 12-25
Local and nested functions inside the method files have the same access as the method.
Note that local functions inside a class-definition file have private access to the class
defined in the same file.

Invoking Superclass Methods in Subclass Methods

A subclass can override the implementation of a method defined in a superclass. In
some cases, the subclass method might need to execute some additional code instead
of completely replacing the superclass method. To do this, MATLAB classes can use a
special syntax for invocation of superclass methods from a subclass implementation for
the same-named method.
The syntax to call a superclass method in a subclass class uses the @ symbol:
MethodName@SuperclassName

For example, the following disp method is defined for a Stock class that is derived from
an Asset class. The method first calls the Asset class disp method, passing the Stock
object so that the Asset components of the Stock object can be displayed. After the
Asset disp method returns, the Stock disp method displays the two Stock properties:
classdef Stock < Asset
methods
function disp(s)
disp@Asset(s) % Call base class disp method first
fprintf(1,'Number of shares: %g\nShare price: %3.2f\n',...
s.NumShares,s.SharePrice);
end % disp
end
end

Limitations of Use
The following restrictions apply to calling superclass methods. You can use this notation
only within:
A method having the same name as the superclass method you are invoking
9-18

Method Invocation

A class that is a subclass of the superclass whose method you are invoking

Invoking Built-In Functions

The MATLAB builtin function enables you to call the built-in version of a function that
has been overloaded by a method.

More About

Object Precedence in Method Invocation on page 9-44

Class Precedence on page 6-22

9-19

Methods Defining Class Operations

Class Constructor Methods

In this section...
Purpose of Class Constructor Methods on page 9-20
Rules for Constructors on page 9-20
Related Information on page 9-21
Initializing Objects in Constructor on page 9-21
No Input Argument Constructor Requirement on page 9-22
Constructing Subclasses on page 9-23
Errors During Class Construction on page 9-25
Basic Structure of Constructor Methods on page 9-26
Output Object Not Assigned on page 9-27

Purpose of Class Constructor Methods

Class constructor methods create instances of the class. All MATLAB classes have
a default constructor method that returns an object of the class created with no
input arguments. A class can define a constructor method that overrides the default
constructor. An explicitly defined constructor can accept input arguments, initialize
property values, call other methods, and perform other operations necessary to create
objects of the class.
When defining a class constructor, implement support for nargin == 0 so MATLAB can
call the constructor for array initialization and loading objects.

Rules for Constructors

A constructor method is a special function that creates an instance of the class. Typically,
constructor methods accept input arguments to assign the data stored in properties and
return an initialized object.
The constructor has the same name as the class.
The only output argument from a constructor is the object constructed.
The constructor can return only a single argument.
Constructors must always define an output argument that is a valid instance of the
class. Never return an empty object from a class constructor. If you do not want to
9-20

Class Constructor Methods

assign the output argument, you can clear the object variable in the constructor (see
Output Object Not Assigned on page 9-27).
If you create a class constructor, provide a syntax to support no input arguments. See
No Input Argument Constructor Requirement on page 9-22.
If the class being created is a subclass, MATLAB calls the constructor of each
superclass class to initialize the object. Implicit calls to the superclass constructor
are made with no arguments. If superclass constructors require arguments, call them
from the subclass constructor explicitly. See Sequence of Constructor Calls in Class
Hierarchy on page 12-13
If your constructor makes an explicit call to a superclass constructor, this call must
occur before any other reference to the constructed object.
Calls to superclass constructors cannot be conditional. You cannot place superclass
construction calls in loops, conditions, switches, try/catch, or nested functions. See No
Conditional Calls to Superclass Constructors on page 9-24 for more information.
A class does not need to define a constructor method unless it is a subclass of a
superclass whose constructor requires arguments. In this case, you must explicitly
call the superclass constructor with the required arguments. See Constructing
Subclasses on page 9-23
If a class does not define a constructor, MATLAB supplies a constructor that takes no
arguments and returns a scalar object whose properties are initialized to empty or the
values specified as defaults in the property definitions. The constructor supplied by
MATLAB also calls all superclass constructors with no arguments.
Restrict access to constructors using method attributes, as with any method.

Related Information
For information specific to constructing enumerations, see Enumeration Class
Constructor Calling Sequence on page 14-8.

Initializing Objects in Constructor

Constructor methods must return an initialized object as the only output argument. The
output argument is created when the constructor executes, before executing the first line
of code.
For example, the following constructor function can assign the value of the object's
property A as the first statement because the object obj has already been assigned to an
instance of myClass.
9-21

Methods Defining Class Operations

function obj = myClass(a,b,c)

obj.A = a;
...
end

You can call other class methods from the constructor because the object is already
initialized.
The constructor also creates an object whose properties have their default valueseither
empty ([]) or the default value specified in the property definition block.
For example, the following code calls the class method CalculateValue to assign the
value of the property Value.
function obj = myClass(a,b,c)
obj.Value = obj.CalculateValue(a,b);
...
end

Referencing the Object in a Constructor

When initializing the object, for example, by assigning values to properties, use the name
of the output argument to refer to the object within the constructor. For example, in the
following code the output argument is obj and the object is reference as obj:
% obj is the object being constructed
function obj = myClass(arg)
obj.propert1 = arg*10;
obj.method1;
...
end

For more information on defining default property values, see Property Default Values
on page 8-14.

No Input Argument Constructor Requirement

There are cases where the constructor must be able to be called with no input argument:
When loading objects into the workspace. If the class ConstructOnLoad attribute is
set to true, the load function calls the class constructor with no arguments.
When creating or expanding an object array such that not all elements are given
specific values, the class constructor is called with no arguments to fill in unspecified
9-22

Class Constructor Methods

elements, (for example, x(10,1) = myclass(a,b,c);). In this case, the constructor

is called once with no arguments to populate the empty array elements with copies of
this one object.
If there are no input arguments, the constructor creates an object using only default
properties values. A good practice is to add a check for zero arguments to the class
constructor to prevent an error if either of the two cases above occur:
function obj = myClass(a,b,c)
if nargin > 0
obj.A = a;
obj.B = b;
obj.C = c;
...
end
end

For ways to handle superclass constructors, see Basic Structure of Constructor Methods
on page 9-26.

Constructing Subclasses
Subclass constructor functions must explicitly call superclass constructors if the
superclass constructors require input arguments. The subclass constructor must specify
these arguments in the call to the superclass constructor using the constructor output
argument. Here is the syntax:
classdef MyClass < SuperClass
function obj = MyClass(arg)
obj@SuperClass(ArgumentList);
...
end
end

The class constructor must make all calls to superclass constructors before any other
references to the object. These changes include assigning property values or calling
ordinary class methods. Also, a subclass constructor can call a superclass constructor
only once.
Reference Only Specified Superclasses
If the classdef does not specify the class as a superclass, the constructor cannot call a
superclass constructor with this syntax .
9-23

Methods Defining Class Operations

classdef MyClass < SuperClass

MATLAB calls any uncalled constructors in the left-to-right order in which they are
specified in the classdef line. MATLAB passes no arguments to these functions.
No Conditional Calls to Superclass Constructors
Calls to superclass constructors must be unconditional. There can be only one call for a
given superclass. Initialize the superclass portion of the object by calling the superclass
constructors before using the object (for example, to assign property values or call class
methods).
If you must call superclass constructors with different arguments that depend on some
condition, you can build a cell array of arguments and provide one call to the constructor.
For example, the Cube class constructor calls the superclass Shape constructor using
default values when the Cube constructor is called with no arguments. If the Cube
constructor is called with four input arguments, upvector and viewangle can be
passed to the superclass constructor:
classdef Cube < Shape
properties
SideLength = 0;
Color = [0 0 0];
end
methods
function cubeObj = Cube(length,color,upvector,viewangle)
if nargin == 0
super_args{1} = [0 0 1];
super_args{2} = 10;
elseif nargin == 4
super_args{1} = upvector;
super_args{2} = viewangle;
else
error('Wrong number of input arguments')
end
cubeObj@Shape(super_args{:});
if nargin > 0 % Use value if provided
cubeObj.SideLength = length;
cubeObj.Color = color;
end
...
end
...

9-24

Class Constructor Methods

end
end

Zero or More Superclass Arguments

If you must support the syntax that calls the superclass constructor with no arguments,
provide this syntax explicitly.
Suppose in the case of the Cube class example, all property values in the Shape
superclass and the Cube subclass have default values specified in the class definitions.
Then you can create an instance of Cube without specifying any arguments for the
superclass or subclass constructors.
Here is how you can implement this behavior in the Cube constructor:
methods
function cubeObj = Cube(length,color,upvector,viewangle)
if nargin == 0
super_args = {};
elseif nargin == 4
super_args{1} = upvector;
super_args{2} = viewangle;
else
error('Wrong number of input arguments')
end
cubeObj@Shape(super_args{:});
if nargin > 0
cubeObj.SideLength = length;
cubeObj.Color = color;
end
...
end
end

More on Subclasses
See Create Subclasses Syntax and Techniques on page 12-7 for information on
creating subclasses.

Errors During Class Construction

If an error occurs during the construction of a handle class, the MATLAB class system
calls the class destructor on the object along with the destructors for any objects
contained in properties and any initialized base classes.
9-25

Methods Defining Class Operations

For information on how objects are destroyed, see Handle Class Destructor on page
7-16.

Basic Structure of Constructor Methods

It is important to consider the state of the object under construction when writing your
constructor method. Constructor methods can be structured into three basic sections:
Pre-initialization Compute arguments for superclass constructors.
Object initialization Call superclass constructors.
Post initialization Perform any operations related to the subclass, including
referencing and assigning to the object, call class methods, passing the object to
functions, and so on.
This code illustrates the basic operations performed in each section:
classdef myClass < baseClass1
properties
ComputedValue
end
methods
function obj = myClass(a,b,c)
%%% Pre Initialization %%%
% Any code not using output argument (obj)
if nargin == 0
% Provide values for superclass constructor
% and initialize other inputs
a = someDefaultValue;
args{1} = someDefaultValue;
args{2} = someDefaultValue;
else
% When nargin ~= 0, assign to cell array,
% which is passed to supclass constructor
args{1} = b;
args{2} = c;
end
compvalue = myClass.staticMethod(a);
%%% Object Initialization %%%
% Call superclass constructor before accessing object
% You cannot conditionalize this statement
obj = obj@baseClass1(args{:});
%%% Post Initialization %%%
% Any code, including access to object
obj.classMethod(...);
obj.ComputedValue = compvalue;
...

9-26

Class Constructor Methods

end
...
end
...
end

See Construct Object Arrays on page 10-2 for information on creating object arrays
in the constructor.

Output Object Not Assigned

You can suppress the assignment of the class instance to the ans variable when no
output variable is assigned in a call to the constructor. This technique is useful if you are
implementing a class that defines a graphical interface.
Use nargout to determine if the constructor has been called with an output argument.
For example, the class constructor for the MyApp class clears the object variable, obj, if
called with no output assigned:
classdef MyApp
methods
function obj = MyApp
if nargout == 0
clear obj
end
end
...
end
end

Related Examples

Simplifying the Interface with a Constructor on page 3-27

Constructor Arguments and Object Initialization on page 12-9

9-27

Methods Defining Class Operations

Static Methods
In this section...
What Are Static Methods on page 9-28
Why Define Static Methods on page 9-28
Defining Static Methods on page 9-28
Calling Static Methods on page 9-29
Inheriting Static Methods on page 9-29

What Are Static Methods

Static methods are associated with a class, but not with specific instances of that class.
These methods do not require an object of the class as an input argument, unlike
ordinary methods which operate on specific objects of the class. You can call static
methods without creating an object of the class

Why Define Static Methods

Static methods are useful when you do not want to first create an instance of the class
before executing some code. For example, you might want to set up the MATLAB
environment or use the static method to calculate data needed to create class instances.
Suppose a class needs a value for pi calculated to particular tolerances. The class could
define its own version of the built-in pi function for use within the class. This approach
maintains the encapsulation of the class's internal workings, but does not require an
instance of the class to return a value.

Defining Static Methods

To define a method as static, set the methods block Static attribute to true. For
example:
classdef MyClass
...
methods(Static)
function p = pi(tol)
[n d] = rat(pi,tol);

9-28

Static Methods

p = n/d;
end
end
end

Calling Static Methods

Invoke static methods using the name of the class followed by dot (.), then the name of
the method:
classname.staticMethodName(args,...)

Calling the pi method of MyClass in the previous section would require this statement:
value = MyClass.pi(.001);

You can also invoke static methods using an instance of the class, like any method:
obj = MyClass;
value = obj.pi(.001);

Inheriting Static Methods

Subclasses can redefine static methods unless the method's Sealed attribute is also set
to true in the superclass.

Related Examples

Implementing the AccountManager Class on page 3-15

9-29

Methods Defining Class Operations

Overload Functions in Class Definitions

In this section...
Why Overload Functions on page 9-30
Implementing Overloaded MATLAB Functions on page 9-30
Rules for Naming to Avoid Conflicts on page 9-32

Why Overload Functions

Classes can redefine MATLAB functions by implementing methods having the same
name. Overloading is useful when defining specialized types that you want to behave like
existing MATLAB types. For example, you can implement relational operations, plotting
functions, and other commonly used MATLAB functions to work with objects of your
class.
You can also modify default behaviors by implementing specific functions that control
these behaviors. For more information on functions that modify default behaviors, see
Methods That Modify Default Behavior on page 17-2.

Implementing Overloaded MATLAB Functions

Class methods can provide implementations of MATLAB functions that operate only on
instances of the class. This is possible because MATLAB can always identify to which
class an object belongs.
MATLAB uses the dominant argument to determine which version of a function to call.
If the dominant argument is an object, then MATLAB calls the method defined by the
object's class, if one exists.
In cases where a class defines a method with the same name as a global function,
the class's implementation of the function is said to overload the original global
implementation.
To overload a MATLAB function:
Define a method with the same name as the function you want to overload.
Ensure the method argument list accepts an object of the class, which MATLAB uses
to determine which version to call.
9-30

Overload Functions in Class Definitions

Perform the necessary steps in the method to implement the function. For example,
access the object properties to manipulate data, and so on.
Generally, the method that overloads a function produces results similar to the MATLAB
function. However, there are no requirements with regard to how you implement the
overloading method. The overloading method does not need to match the signature of the
overloaded function.
Note: MATLAB does not support overloading functions using different signatures for the
same function name.
Overload the bar Function
It is convenient to overload commonly used functions to work with objects of your class.
For example, suppose a class defines a property that stores data that you often graph.
The MyData class overrides the bar function and adds a title to the graph:
classdef MyData
properties
Data
end
methods
function obj = MyData(d)
if nargin > 0
obj.Data = d;
end
end
function bar(obj)
y = obj.Data;
bar(y,'EdgeColor','r');
title('My Data Graph')
end
end
end

The MyData bar method has the same name as the MATLAB bar function. However,
the MyData bar method requires a MyData object as input. Because the method is
specialized for MyData objects, it can extract the data from the Data property and create
a specialized graph.
To use the bar method, create an object:
9-31

Methods Defining Class Operations

y = rand(1,10);
md = MyData(y);

Call the method using the object:

bar(md)

You can also use dot notation:

md.bar

Implementing MATLAB Operators

Classes designed to implement new MATLAB data types typically define certain
operators, such as addition, subtraction, equality, and so on.
For example, standard MATLAB addition (+) cannot add two polynomials because this
operation is not defined by simple addition. However, a polynomial class can define its
own plus method that the MATLAB language calls to perform addition of polynomial
objects when you use the + symbol:
p1 + p2

For information on overloading operators, see Operator Overloading on page 17-48.

Rules for Naming to Avoid Conflicts

The names of methods, properties, and events are scoped to the class. Therefore, you
should adhere to the following rules to avoid naming conflicts:
You can reuse names that you have used in unrelated classes.
You can reuse names in subclasses if the member does not have public or protected
access. These names then refer to entirely different methods, properties, and events
without affecting the superclass definitions
Within a class, all names exist in the same name space and must be unique. A class
cannot define two methods with the same name and a class cannot define a local
function with the same name as a method.
The name of a static method is considered without its class prefix. Thus, a static
method name without its class prefix cannot match the name of any other method.

Related Examples

9-32

Dominant Argument in Overloaded Graphics Functions on page 9-46

Overload Functions in Class Definitions

Class Support for Array-Creation Functions on page 9-34

9-33

Methods Defining Class Operations

Class Support for Array-Creation Functions

In this section...
Extend Array-Creation Functions for Your Class on page 9-34
Which Syntax to Use on page 9-35
Implement Support for Array-Creation Functions on page 9-36

Extend Array-Creation Functions for Your Class

There are a number of MATLAB functions that create arrays of a specific size and
type, such as ones and zeros. User-defined classes can add support for array-creation
functions without requiring the use of overloaded method syntax.
Class support for any of the array-creation functions enables you to develop code that
you can share with built-in and user-defined data types. For example, the class of the
variable x in the following code can be a built-in type during initial development, and
then be replaced by a user-defined class that transparently overloads zeros:
cls = class(x);
zArray = zeros(m,n,cls);

Array-creation functions create arrays of a specific type in two ways:

Class name syntax Specify class name that determines the type of array elements.
Prototype object syntax Provide a prototype object that the function uses to
determine the type and other characteristics of the array elements.
For example:
zArray = zeros(2,3,'uint8');
p = uint8([1 3 5 ; 2 4 6]);
zArray = zeros(2,3,'like',p);

After adding support for these functions to a class named MyClass, you can use similar
syntax with that class:
zArray = zeros(2,3,'MyClass');

9-34

Class Support for Array-Creation Functions

Or pass an object of your class:

p = MyClass(...);
zArray = zeros(size(p),'like',p);

MATLAB uses these arguments to dispatch to the appropriate method in your class.
Array-Creation Functions That Support Overloading
The following functions support this kind of overloading.
Array-Creation Functions
ones
zeros
eye
nan (lower case)
inf
true
false
cast
rand
randn
randi

Which Syntax to Use

If you want to create an array of default objects, which require no input arguments for
the constructor, then use the class name syntax.
If you need to create an array of objects with specific property values or if the constructor
needs other inputs, use the prototype object to provide this information.
Classes can support both the class name and the prototype object syntax.
You can implement a class name syntax with the true and false functions even though
these functions do not support that syntax by default.
9-35

Methods Defining Class Operations

Class Name Method Called If Prototype Method Does Not Exist

If your class implements a class name syntax, but does not implement a prototype object
syntax for a particular function, you can still call both syntaxes. For example, if you
implement a static zeros method only, you can call:
zeros(...,'like',MyClass(...))

In the case in which you call the prototype object syntax, MATLAB first searches for a
method named zerosLike. If MATLAB cannot find this method, it calls for the zeros
static method.
This feature is useful if you only need the class name to create the array. You do not
need to implement both methods to support the complete array-creation function syntax.
When you implement only the class name syntax, a call to a prototype object syntax is
the same as the call to the class name syntax.

Implement Support for Array-Creation Functions

Use two separate methods to fully support an array-creation function. One method
implements the class name syntax and the other implements the prototype object syntax.
For example, to support the zeros function:
Implement the class name syntax:
zeros(...,'ClassName')

As a Static method:
methods (Static)
function z = zeros(varargin)
...
end
end

Implement the prototype object syntax:

zeros(...,'like',obj)

As a Hidden method with the char vector 'Like' appended to the name.
methods (Hidden)
function z = zerosLike(obj,varargin)
...

9-36

Class Support for Array-Creation Functions

end
end

How MATLAB Interprets the Function Call

The special support for array-creation functions results from the interpretation of the
syntax.
A call to the zeros function of this form:
zeros(...,'ClassName')

Calls the class static method like this:

ClassName.zeros(varargin{1:end-1})

A call to the zeros function of this form:

zeros(...,'like',obj)

Calls the class method like this:

zerosLike(obj,varargin{1:end-2})

Support All Function Inputs

The input arguments to an array-creation function can include the dimensions of the
array the function returns and possibly other arguments. In general, there are three
cases that your methods need to support:
No dimension input arguments resulting in the return of a scalar. For example:
z = zeros('MyClass');

One or more dimension equal to or less than zero, resulting in an empty array. For
example:
z = zeros(2,0,'MyClass');

Any number of valid array dimensions specifying the size of the array. For example:
z = zeros(2,3,5,'MyClass');

When the array-creation function calls your class method, it passes the input arguments,
excluding the class name or the literal 'like' and the object variable to your method.
This enables you to implement your methods with signatures like these:
zeros(varargin) for class name methods

9-37

Methods Defining Class Operations

zeros(obj,varargin) for like prototype object methods

Sample Class
The Color class represents a color in a specific color space, such as RGB, HSV, and so
on. The discussions in Class Name Method Implementations on page 9-38 and
Prototype Object Method Implementation on page 9-40 use this class as a basis for
the overloaded method implementations.
classdef Color
properties
ColorValues = [0,0,0];
ColorSpace = 'RGB';
end
methods
function obj = Color(cSpace,values)
if nargin > 0
obj.ColorSpace = cSpace;
obj.ColorValues = values;
end
end
end
end

Class Name Method Implementations

The zeros function strips the final ClassName char vector and uses it to form the call
to the static method in the Color class. The arguments passed to the static method are
the array dimension arguments.
Here is an implementation of a zeros method for the Color class. This implementation:
Defines the zeros method as Static (required)
Returns a scalar Color object if the call to zeros has no dimension arguments
Returns an empty array if the call to zeros has any dimensions arguments equal to
0.
Returns an array of default Color objects. Use repmat to create an array of the
dimensions specified by the call to zeros.
classdef Color
...
methods (Static)
function z = zeros(varargin)

9-38

Class Support for Array-Creation Functions

if (nargin == 0)
% For zeros('Color')
z = Color;
elseif any([varargin{:}] <= 0)
% For zeros with any dimension <= 0
z = Color.empty(varargin{:});
else
% For zeros(m,n,...,'Color')
% Use property default values
z = repmat(Color,varargin{:});
end
end
end
end

The zeros method uses default values for the ColorValues property because these
values are appropriate for this application. An implementation of a ones method can set
the ColorValues property to [1,1,1], for example.
Suppose you want to overload the randi function to achieve the following objectives:
Define each ColorValue property as a 1-by-3 array in the range of 1 to a specified
maximum value (for example, 1 to 255).
Accommodate scalar, empty, and multidimensional array sizes.

Return an array of Color objects of the specified dimensions, each with random
ColorValues.
classdef Color
...
methods (Static)
function r = randi(varargin)
if (nargin == 0)
% For randi('ClassName')
r = Color('RGB',randi(255,[1,3]));
elseif any([varargin{2:end}] <= 0)
% For randi with any dimension <= 0
r = Color.empty(varargin{2:end});
else
% For randi(max,m,n,...,'ClassName')
if numel([varargin{:}]) < 2
error('Not enough input arguments')
end
dims = [varargin{2:end}];
r = zeros(dims,'Color');

9-39

Methods Defining Class Operations

for k = 1:prod(dims)
r(k) = Color('RGB',randi(varargin{1},[1,3]));
end
end
end
end
end

Prototype Object Method Implementation

The objective of a method that returns an array of objects that are like a prototype
object depends on the requirements of the class. For the Color class, the zeroLike
method creates objects that have the ColorSpace property value of the prototype object,
but the ColorValues are all zero.
Here is an implementation of a zerosLike method for the Color class. This
implementation:
Defines the zerosLike method as Hidden
Returns a scalar Color object if the call to the zeros function has no dimension
arguments
Returns an empty array if the call to the zeros function has any dimension
arguments that are negative or equal to 0.
Returns an array of Color objects of the dimensions specified by the call to the zeros
function.
classdef Color
...
methods (Hidden)
function z = zerosLike(obj,varargin)
if nargin == 1
% For zeros('like',obj)
cSpace = obj.ColorSpace;
z = Color;
z.ColorSpace = cSpace;
elseif any([varargin{:}] <= 0)
% For zeros with any dimension <= 0
z = Color.empty(varargin{:});
else
% For zeros(m,n,...,'like',obj)
if ~isscalar(obj)
error('Prototype object must be scalar')
end

9-40

Class Support for Array-Creation Functions

obj = Color(obj.ColorSpace,zeros(1,3,'like',obj.ColorValues));
z = repmat(obj,varargin{:});
end
end
end
end

Full Class Listing

Here is the Color class definition with the overloaded methods.
Note: In actual practice, the Color class requires error checking, color space conversions,
and so on. This overly simplified version illustrates the implementation of the overloaded
methods.
classdef Color
properties
ColorValues = [0,0,0];
ColorSpace = 'RGB';
end
methods
function obj = Color(cSpace,values)
if nargin > 0
obj.ColorSpace = cSpace;
obj.ColorValues = values;
end
end
end
methods (Static)
function z = zeros(varargin)
if (nargin == 0)
% For zeros('ClassName')
z = Color;
elseif any([varargin{:}] <= 0)
% For zeros with any dimension <= 0
z = Color.empty(varargin{:});
else
% For zeros(m,n,...,'ClassName')
% Use property default values
z = repmat(Color,varargin{:});
end
end

9-41

Methods Defining Class Operations

function r = randi(varargin)
if (nargin == 0)
% For randi('ClassName')
r = Color('RGB',randi(255,[1,3]));
elseif any([varargin{2:end}] <= 0)
% For randi with any dimension <= 0
r = Color.empty(varargin{2:end});
else
% For randi(max,m,n,...,'ClassName')
if numel([varargin{:}]) < 2
error('Not enough input arguments')
end
dims = [varargin{2:end}];
r = zeros(dims,'Color');
for k = 1:prod(dims)
r(k) = Color('RGB',randi(varargin{1},[1,3]));
end
end
end
end
methods (Hidden)
function z = zerosLike(obj,varargin)
if nargin == 1
% For zeros('like',obj)
cSpace = obj.ColorSpace;
z = Color;
z.ColorSpace = cSpace;
elseif any([varargin{:}] <= 0)
% For zeros with any dimension <= 0
z = Color.empty(varargin{:});
else
% For zeros(m,n,...,'like',obj)
if ~isscalar(obj)
error('Prototype object must be scalar')
end
obj = Color(obj.ColorSpace,zeros(1,3,'like',obj.ColorValues));
z = repmat(obj,varargin{:});
end
end
end
end

9-42

Class Support for Array-Creation Functions

Related Examples

Construct Object Arrays on page 10-2

9-43

Methods Defining Class Operations

Object Precedence in Method Invocation

In this section...
Default Object Precedence on page 9-44
Specifying Precedence of User-Defined Classes on page 9-45

Default Object Precedence

Establishing an object precedence enables MATLAB to determine which of possibly many
versions of an operator or function to call in a given situation.
For example, consider the expression
objectA + objectB

Ordinarily, objects have equal precedence and the method associated with the left-most
object is called. However, there are two exceptions:
User-defined classes have precedence over MATLAB fundamental classes (see
Fundamental MATLAB Classes) and certain built-in classes.
User-defined classes can specify their relative precedence with respect to other userdefined classes using the InferiorClasses attribute.
In Class Design for Polynomials on page 19-2, the polynom class defines a plus
method that enables the addition of DocPolynom objects. Given the object p:
p = DocPolynom([1 0 -2 -5])
p =
x^3-2*x-5

the expression:
1 + p
ans =
x^3-2*x-4

calls the DocPolynom plus method (which converts the double, 1, to a DocPolynom
object and then implements the addition of two polynomials). The user-defined
DocPolynom class has precedence over the built-in double class.
9-44

Object Precedence in Method Invocation

Specifying Precedence of User-Defined Classes

You can specify the relative precedence of user-defined classes by listing inferior classes
using a class attribute. The InferiorClasses property places a class below other
classes in the precedence hierarchy. Define the InferiorClasses property in the
classdef statement:
classdef (InferiorClasses = {?class1,?class2}) myClass

This attribute establishes a relative priority of the class being defined with the order of
the classes listed.
Location in the Hierarchy
If objectA is above objectB in the precedence hierarchy, then the expression
objectA + objectB

calls @classA/plus.m. Conversely, if objectB is above objectA in the precedence

hierarchy, then the MATLAB runtime calls @classB/plus.m.

More About

Dominant Argument in Overloaded Graphics Functions on page 9-46

Class Precedence on page 6-22

9-45

Methods Defining Class Operations

Dominant Argument in Overloaded Graphics Functions

In this section...
Graphics Object Precedence on page 9-46
Dominant Argument on page 9-46
Defining Class Precedence on page 9-46
Calls to Inferior-Class Methods on page 9-48

Graphics Object Precedence

MATLAB graphics objects have the same precedence as user-defined objects. If you want
to implement a method that accepts a graphics object as its first argument (for example,
an axes handle), define the MATLAB graphics class as inferior to your class.

Dominant Argument
When evaluating expression involving objects of more than one class, MATLAB uses the
dominant argument to determine which method or function to call.
Here is how MATLAB dispatches in response to a function call:
Determine the dominant argument based on the class of arguments.
If there is a dominant argument, call the method of the dominant class.
If arguments are of equal precedence, use the left-most argument as the dominant
argument.
If the class of the dominant argument does not define a method with the name of the
called function, call the first function on the path with that name.

Defining Class Precedence

Specify the relative precedence of MATLAB classes using the InferiorClasses class
attribute. Here is the basic syntax:
classdef (InferiorClasses = {?class1,?class2}) ClassName

The following definition of the TemperatureData class implements a specialized version

of plot to graph temperature data. The class plot method supports a variable number
of input arguments to allow an axes handle as the first argument:
9-46

Dominant Argument in Overloaded Graphics Functions

plot(obj)
plot(ax,obj)

obj is an instance of the TemperatureData class and ax is an axes handle.

MATLAB calls the plot method in both cases because the TemperatureData class
specifies the matlab.graphics.axis.Axes as inferior.
classdef (InferiorClasses = {?matlab.graphics.axis.Axes}) TemperatureData
properties
Time
Temperature
end
methods
function obj = TemperatureData(x,y)
obj.Time = x;
obj.Temperature = y;
end
function plot(varargin)
if nargin == 1
obj = varargin{1};
plot(obj.Time,obj.Temperature)
elseif nargin == 2
ax = varargin{1};
obj = varargin{2};
plot(ax,obj.Time,obj.Temperature)
elseif nargin > 2
ax = varargin{1};
obj = varargin{2};
plot(ax,obj.Time,obj.Temperature,varargin{3:end})
end
datetick('x')
xlabel('Time')
ylabel('Temperature')
end
end
end

The following call to plot dispatches to the TemperatureData plot method, not the
built-in plot function, because the TemperatureData object is dominant over the axes
object.
x = 1:10;
y = rand(1,10)*100;

9-47

Methods Defining Class Operations

ax = axes;
td = TemperatureData(x,y);
plot(ax,td)

Calls to Inferior-Class Methods

When you declare a class as inferior to your class, and both classes define a method with
the same name, MATLAB dispatches to your class method regardless of argument order.
Suppose the TemperatureData class that is described in the previous section defines
a set method. If you attempt to assign an object of the TemperatureData class to the
UserData property of an axes object:
td = TemperatureData(x,y);
set(gca,'UserData',td)

The results is a call to the TemperatureData set method. MATLAB does not call the
built-in set function.
To support the use of a set function with inferior classes, implement a set method in
your class that calls the built-in set function when the first argument is an object of the
inferior class.
function set(varargin)
if isa(varargin{1},'matlab.graphics.axis.Axes')
builtin('set',varargin{:})
else
...
end

More About

9-48

Object Precedence in Method Invocation on page 9-44

Class Methods for Graphics Callbacks

Class Methods for Graphics Callbacks

In this section...
Referencing the Method on page 9-49
Syntax for Method Callbacks on page 9-49
How to Use a Class Method for a Slider Callback on page 9-50

Referencing the Method

To use an ordinary class method as callback for a graphics object, specify the callback
property as a function handle referencing the method. For example,
uicontrol('Style','slider','Callback',@obj.sliderCallback)

Where your class defines a method called sliderCallback and obj is an instance of
your class.
To use a static methods as a callback, specify the callback property as a function handle
that includes the class name that is required to refer to a static method:
uicontrol('Style','slider','Callback',@MyClass.sliderCallback)

Syntax for Method Callbacks

For ordinary methods, use dot notation to pass an instance of the class defining the
callback as the first argument:
@obj.methodName

Define the callback method with the following input arguments:

An instance of the defining class as the first argument
The event source handle
The event data
The function signature would be of this form:
function methodName(obj,src,eventData)
...
end

9-49

Methods Defining Class Operations

For static methods, the required class name ensures MATLAB dispatches to the method
of the specified class:
@MyClass.methodName

Define the static callback method with two input arguments the event source handle
and the event data
The function signature would be of this form:
function methodName(src,eventData)

Passing Additional Arguments

If you want to pass arguments to your callback in addition to the source and event data
arguments passed by MATLAB, you can use an anonymous function. The basic syntax
for an anonymous function that you assign to the graphic object's Callback property
includes the object as the first argument:
@(src,event)callbackMethod(object,src,eventData,arg1,...argn)

The function signature would be of this form:

function methodName(obj,src,eventData,varargin)
...
end

How to Use a Class Method for a Slider Callback

This example shows how to use a method of your class as a callback for a uicontrol slider.
The SeaLevelSlider class creates a slider that varies the color limits of an indexed
image to give the illusion of varying the sea level.
Class Definition
Define SeaLevelSlider as a handle class with the following members:
The class properties store figure and axes handles and the calculated color limits.
The class constructor creates the graphics objects and assigns the slider callback.
The callback function for the slider accepts the three required arguments a class
instance, the handle of the event source, and the event data. The event data argument
is empty and not used.
9-50

Class Methods for Graphics Callbacks

The uicontrol callback uses dot notation to reference the callback method:
...'Callback',@obj.sliderCallback.
classdef SeaLevelSlider < handle
properties
Figure
Axes
CLimit
end
methods
function obj = SeaLevelSlider(x,map)
obj.Figure = figure('Colormap',map,...
'Position',[100,100,560,580],...
'Resize','off');
obj.Axes = axes('DataAspectRatio',[1,1,1],...
'XLimMode','manual','YLimMode','manual',...
'Parent',obj.Figure);
image(x,'CDataMapping','scaled',...
'Parent',obj.Axes);
obj.CLimit = get(obj.Axes,'CLim');
uicontrol('Style','slider',...
'Parent',obj.Figure,...
'Max',obj.CLimit(2)-10,...
'Min',obj.CLimit(1)-1,...
'Value',obj.CLimit(1),...
'Units','normalized',...
'Position',[0.9286,0.1724,0.0357,0.6897],...
'SliderStep',[0.003,0.005],...
'Callback',@obj.sliderCallback);
end
function sliderCallback(obj,src,~)
minVal = get(src,'Value');
maxVal = obj.CLimit(2);
obj.Axes.CLim = [minVal maxVal];
end
end
end

Using the SeaLevelAdjuster Class

The class is designed to be used with the cape image that is included with the MATLAB
product. To obtain the image data, use the load command:
9-51

Methods Defining Class Operations

load cape X map

After loading the data, create a SeaLevelSlider object for the image:
slaObj = SeaLevelSlider(X,map);

Move the slider to change the color mapping and visualize a rise in sea level.

50

100

150

200

250

300

350
50

100

150

200

More About

9-52

Listener Callback Syntax on page 11-29

250

300

350

10
Object Arrays
Construct Object Arrays on page 10-2
Initialize Object Arrays on page 10-5
Empty Arrays on page 10-8
Initialize Arrays of Handle Objects on page 10-10
Object Arrays with Dynamic Properties on page 10-13
Concatenating Objects of Different Classes on page 10-15
Heterogeneous Arrays on page 10-21
Heterogeneous Array Constructors on page 10-31

10

Object Arrays

Construct Object Arrays

In this section...
Build Arrays in the Constructor on page 10-2
Referencing Property Values in Object Arrays on page 10-3

Build Arrays in the Constructor

A class constructor can create an array by building the array and returning it as the
output argument.
For example, the ObjectArray class creates an object array that is the same size as the
input array. Then it initializes the Value property of each object to the corresponding
input array value.
classdef ObjectArray
properties
Value
end
methods
function obj = ObjectArray(F)
if nargin ~= 0
m = size(F,1);
n = size(F,2);
obj(m,n) = ObjectArray;
for i = 1:m
for j = 1:n
obj(i,j).Value = F(i,j);
end
end
end
end
end
end

To preallocate the object array, assign the last element of the array first. MATLAB fills
the first to penultimate array elements with default ObjectArray objects.
After preallocating the array, assign each object Value property to the corresponding
value in the input array F. To use the class:
10-2

Construct Object Arrays

Create 5-by-5 array of magic square numbers

Create a 5-by-5 object array
F = magic(5);
A = ObjectArray(F);
whos
Name

Size

A
F

5x5
5x5

Bytes
304
200

Class

Attributes

ObjectArray
double

Referencing Property Values in Object Arrays

Reference all values of the same property in an object array using the syntax:
objarray.PropName

For example, given the ObjProp class:

classdef ObjProp
properties
RegProp
end
methods
function obj = ObjProp
obj.RegProp = randi(100);
end
end
end

Create an array of ObjProp objects and access the RegProp property of each object:
for k = 1:5
a(k) = ObjProp;
end

Assign the property values to a numeric array:

PropArray = [a.RegProp]
PropArray =
82

91

13

92

64

10-3

10

Object Arrays

size(PropArray)
ans =
1

Index the array to access specific values. For example, to access the second array
element, use,
PropArray(2)
ans =
91

Related Examples

10-4

Initialize Object Arrays on page 10-5

Initialize Arrays of Handle Objects on page 10-10

Class Constructor Methods on page 9-20

Initialize Object Arrays

Initialize Object Arrays

In this section...
Calls to Constructor on page 10-5
Initial Value of Object Properties on page 10-6

Calls to Constructor
During the creation of object arrays, MATLAB can call the class constructor with no
arguments, even if the constructor does not build an object array. For example, suppose
that you define the following class:
classdef SimpleValue
properties
Value
end
methods
function obj = SimpleValue(v)
obj.Value = v;
end
end
end

Execute the following statement to create an array:

a(1,7) = SimpleValue(7)
Error using SimpleValue (line 7)
Not enough input arguments.

This error occurs because MATLAB calls the constructor with no arguments to initialize
elements 1 through 6 in the array.
Your class must support the no input argument constructor syntax. A simple solution is
to test nargin and let the case when nargin == 0 execute no code, but not error:
classdef SimpleValue
properties
Value
end
methods
function obj = SimpleValue(v)

10-5

10

Object Arrays

if nargin > 0
obj.Value = v;
end
end
end
end

Using the revised class definition, the previous array assignment statement executes
without error:
a(1,7) = SimpleValue(7)
a =
1x7 SimpleValue array with properties:
Value

The object assigned to array element a(1,7) uses the input argument passed to the
constructor as the value assigned to the property:
a(1,7)
ans =
SimpleValue with properties:
Value: 7

MATLAB created the objects contained in elements a(1,1:6) with no input argument.
The default value for properties empty []. For example:
a(1,1)
ans =
SimpleValue with properties:
Value: []

MATLAB calls the SimpleValue constructor once and copies the returned object to each
element of the array.

Initial Value of Object Properties

When MATLAB calls a constructor with no arguments to initialize an object array, one of
the following assignments occurs:
10-6

Initialize Object Arrays

If property definitions specify default values, MATLAB assigns these values.

If the constructor assigns values in the absence of input arguments, MATLAB assigns
these values.
If neither of the preceding situations apply, MATLAB assigns the value of empty
double (that is, []) to the property.

Related Examples

Initialize Arrays of Handle Objects on page 10-10

10-7

10

Object Arrays

Empty Arrays
In this section...
Creating Empty Arrays on page 10-8
Assigning Values to an Empty Array on page 10-8

Creating Empty Arrays

Empty arrays have no elements, but are of a certain class. All nonabstract classes have
a static method named empty that creates an empty array of the same class. The empty
method enables you to specify the dimensions of the output array. However, at least one
of the dimensions must be 0. For example, define the SimpleValue class:
classdef SimpleValue
properties
Value
end
methods
function obj = SimpleValue(v)
if nargin > 0
obj.Value = v;
end
end
end
end

Create a 5by0 empty array of class SimpleValue.

ary = SimpleValue.empty(5,0)
ary =
5x0 SimpleValue array with properties:
Value

Calling empty with no arguments returns a 0by0 empty array.

Assigning Values to an Empty Array

An empty object defines the class of an array. To assign nonempty objects to an empty
array, MATLAB calls the class constructor to create default instances of the class for
10-8

Empty Arrays

every other array element. Once you assign a nonempty object to an array, all array
elements must be nonempty objects.
Note: A class constructor must avoid returning empty objects by default.
For example, using the SimpleValue defined in the Initialize Object Arrays on page
10-5 section, create an empty array:
ary = SimpleValue.empty(5,0);
class(ary)
ans =
SimpleValue

ary is an array of class SimpleValue. However, it is an empty array:

ary(1)
Index exceeds matrix dimensions.

If you make an assignment to a property value, MATLAB calls the SimpleClass

constructor to grow the array to the require size:
ary(5).Value = 7;
ary(5).Value
ans =
7
ary(1).Value
ans =
[]

MATLAB populates array elements one through five with SimpleValue objects created
by calling the class constructor with no arguments. Then MATLAB assigns the property
value 7 to the object at ary(5).

Related Examples

Initialize Arrays of Handle Objects on page 10-10

10-9

10

Object Arrays

Initialize Arrays of Handle Objects

When initializing an array of handle objects, MATLAB:
Calls the class constructor once to obtain an object
Creates unique handles for each element in the array
Copies the property values from the constructed object without calling the constructor
again.
The InitHandleArray class illustrates this behavior.
classdef InitHandleArray < handle
properties
RandNumb
end
methods
function obj = InitHandleArray
obj.RandNumb = randi(100);
end
end
end

The property RandNumb contains a random number that the InitHandleArray

constructor assigns.
Consider what happens when MATLAB initialize an array by first assigning to the last
element in the array. (The last element is the one with the highest index values). For
example, suppose the value of the RandNumb property of the InitHandleArray object
assigned to the element A(4,5) is 59:
A(4,5) = InitHandleArray;
A(4,5).RandNumb
ans =
59

The element in the index location A(4,5) is an instance of the InitHandleArray class.
Element A(1,1) is also an instance of the InitHandleArray class, but its RandNumb
property is set to a different random number. MATLAB called the class constructor to
create a single object, which MATLAB then copied to all the remaining array elements.
Calling the constructor resulted in another call to the randi function, which returns a
new random number:
10-10

Initialize Arrays of Handle Objects

A(1,1).RandNumb
ans =
10

MATLAB copies this second instance to all remaining array elements:

A(2,2).RandNumb
ans =
10
A(2,3).RandNumb
ans =
10

When initializing an object array, MATLAB assigns a copy of a single object to the empty
elements in the array. MATLAB gives each object a unique handle so that later you can
assign different property values to each object. The objects are not equivalent:
A(1,1) == A(2,2)
ans =
0

That is, the handle A(1,1) does not refer to the same object as A(2,2). The creation of
an array with a statement such as:
A(4,5) = InitHandleArray;

results in two calls to the class constructor. The first creates the object for array element
A(4,5). The second creates a default object that MATLAB copies to all remaining empty
array elements.

Related Information
See Indexing Multidimensional Arrays and Reshaping Multidimensional Arrays for
information on array manipulation.
10-11

10

Object Arrays

See Initialize Properties to Unique Values on page 8-15 for information on assigning
values to properties.
See Object Array Indexing on page 17-14 for information on implementing
subsasgn methods for your class.

10-12

Object Arrays with Dynamic Properties

Object Arrays with Dynamic Properties

You cannot reference all the dynamic properties in an object array using a
single statement, as you can with ordinary properties. For example, suppose the
ObjectArrayDynamic class subclasses the dynamicprops class, which enables you to
add properties to objects of the ObjectArrayDynamic class:
classdef ObjectArrayDynamic < dynamicprops
properties
RegProp
end
methods
function obj = ObjectArrayDynamic
obj.RegProp = randi(100);
end
end
end

Create an object array and add dynamic properties to each member of the array.
Define elements 1 and 2 as ObjectArrayDynamic objects:
a(1) = ObjectArrayDynamic;
a(2) = ObjectArrayDynamic;

Add dynamic properties to each object and assign a value

a(1).addprop('DynoProp');
a(1).DynoProp = 1;
a(2).addprop('DynoProp');
a(2).DynoProp = 2;

Get the values of the ordinary properties, as with any array:

a.RegProp
ans =
4
ans =
85

10-13

10

Object Arrays

MATLAB returns an error if you try to access the dynamic properties of all array
elements using this syntax.
a.DynoProp
No appropriate method, property, or field 'DynoProp' for class
'ObjectArrayDynamic'.

Refer to each object individually to access dynamic property values:

a(1).DynoProp
ans =
1
a(2).DynoProp
ans =
2

For information about classes that can define dynamic properties, see Dynamic
Properties Adding Properties to an Instance on page 8-41 .

10-14

Concatenating Objects of Different Classes

Concatenating Objects of Different Classes

In this section...
Basic Knowledge on page 10-15
MATLAB Concatenation Rules on page 10-15
Concatenating Objects on page 10-16
Calling the Dominant-Class Constructor on page 10-16
Converter Methods on page 10-18

Basic Knowledge
The material presented in this section builds on an understanding of the information
presented in the following sections.
Construct Object Arrays on page 10-2
Valid Combinations of Unlike Classes

MATLAB Concatenation Rules

MATLAB follows these rules for concatenating objects:
MATLAB always attempts to convert all objects to the dominant class.
User-defined classes take precedence over built-in classes like double.
If there is no defined dominance relationship between any two objects, then the
leftmost object dominates (see Class Precedence on page 6-22).
When converting to a dominant class during concatenation or subscripted assignment,
MATLAB searches the non-dominant class for a conversion method that is the same
name as the dominant class. If such a conversion method exists, MATLAB calls it. If a
conversion method does not exist, MATLAB calls the dominant class constructor on the
non-dominant object.
It is possible for the dominant class to define horzcat, vertcat, or cat methods that
modify the default concatenation process.
10-15

10

Object Arrays

Note: MATLAB does not convert objects to a common superclass unless those objects are
part of a heterogeneous hierarchy. For more information, see Heterogeneous Arrays on
page 10-21.

Concatenating Objects
Concatenation combines objects into arrays:
ary = [obj1,obj2,obj3,...,objn];

The size of ary is 1-by-n.

ary = [obj1;obj2;obj3;...;objn];

The size of ary is n-by-1.

The class of the arrays is the same as the class of the objects being concatenated.
Concatenating objects of different classes is possible if MATLAB can convert objects to
the dominant class. MATLAB attempts to convert unlike objects by:
Calling the inferior object converter method, if one exists.
Passing an inferior object to the dominant class constructor to create an object of the
dominant class.
If conversion of the inferior object is successful, MATLAB returns an array that is of the
dominant class. If conversion is not possible, MATLAB returns an error.

Calling the Dominant-Class Constructor

MATLAB calls the dominant class constructor to convert an object of an inferior class
to the dominant class. MATLAB passes the inferior object to the constructor as an
argument. If the class design enables the dominant class constructor to accept objects of
inferior classes as input arguments, then concatenation is possible without implementing
a separate converter method.
If the constructor simply assigns this argument to a property, the result is an object
of the dominant class with an object of an inferior class stored in a property. If this
assignment is not a desired result, then ensure that class constructors include adequate
error checking.
10-16

Concatenating Objects of Different Classes

For example, consider the class ColorClass and two subclasses, RGBColor and
HSVColor:
classdef ColorClass
properties
Color
end
end

The class RGBColor inherits the Color property from ColorClass. RGBColor stores
a color value defined as a three-element vector of red, green, and blue (RGB) values.
The constructor does not restrict the value of the input argument. It assigns this value
directly to the Color property.
classdef RGBColor < ColorClass
methods
function obj = RGBColor(rgb)
if nargin > 0
obj.Color = rgb;
end
end
end
end

The class HSVColor also inherits the Color property from ColorClass. HSVColor
stores a color value defined as a three-element vector of hue, saturation, brightness value
(HSV) values.
classdef HSVColor < ColorClass
methods
function obj = HSVColor(hsv)
if nargin > 0
obj.Color = hsv;
end
end
end
end

Create an instance of each class and concatenate them into an array. The RGBColor
object is dominant because it is the leftmost object and neither class defines a dominance
relationship:
crgb = RGBColor([1 0 0]);
chsv = HSVColor([0 1 1]);

10-17

10

Object Arrays

ary = [crgb,chsv];
class(ary)
ans =
RGBColor

You can combine these objects into an array because MATLAB can pass the inferior
object of class HSVColor to the constructor of the dominant class. However, notice that
the Color property of the second RGBColor object in the array actually contains an
HSVColor object, not an RGB color specification:
ary(2).Color
ans =
HSVColor with properties:
Color: [0 1 1]

Avoid this undesirable behavior by:

Implementing converter methods
Performing argument checking in class constructors before assigning values to
properties

Converter Methods
If your class design requires object conversion, implement converter methods for this
purpose.
The ColorClass class defines converter methods for RGBColor and HSVColor objects:
classdef ColorClass
properties
Color
end
methods
function rgbObj = RGBColor(obj)
if isa(obj,'HSVColor')
rgbObj = RGBColor(hsv2rgb(obj.Color));
end
end

10-18

Concatenating Objects of Different Classes

function hsvObj = HSVColor(obj)

if isa(obj,'RGBColor')
hsvObj = HSVColor(rgb2hsv(obj.Color));
end
end
end
end

Create an array of RGBColor and HSVColor objects with the revised superclass:
crgb = RGBColor([1 0 0]);
chsv = HSVColor([0 1 1]);
ary = [crgb,chsv];
class(ary)
ans =
RGBColor

MATLAB calls the converter method for the HSVColor object, which it inherits from
the superclass. The second array element is now an RGBColor object with an RGB color
specification assigned to the Color property:
ary(2)
ans =
RGBColor with properties:
Color: [1 0 0]
ary(2).Color
ans =
1

If the leftmost object is of class HSVColor, the array ary is also of class HSVColor, and
MATLAB converts the Color property data to HSV color specification.
ary = [chsv crgb]
ary =
1x2 HSVColor

10-19

10

Object Arrays

Properties:
Color
ary(2).Color
ans =
0

Defining a converter method in the superclass and adding better argument checking in
the subclass constructors produces more predicable results. Here is the RGBColor class
constructor with argument checking:
classdef RGBColor < ColorClass
methods
function obj = RGBColor(rgb)
if nargin == 0
rgb = [0 0 0];
else
if ~(isa(rgb,'double')...
&& size(rgb,2) == 3 ...
&& max(rgb) <= 1 && min(rgb) >= 0)
error('Specify color as RGB values')
end
end
obj.Color = rgb;
end
end
end

Your applications can require additional error checking and other coding techniques. The
classes in these examples are designed only to demonstrate concepts.

More About

10-20

Object Converters on page 17-11

Hierarchies of Classes Concepts on page 12-2

Heterogeneous Arrays

Heterogeneous Arrays
In this section...
MATLAB Arrays on page 10-21
Heterogeneous Hierarchies on page 10-21
Heterogeneous Arrays on page 10-22
Heterogeneous Array Concepts on page 10-22
Nature of Heterogeneous Arrays on page 10-23
Unsupported Hierarchies on page 10-26
Default Object on page 10-28
Conversion During Assignment and Concatenation on page 10-29
Empty Arrays of Heterogeneous Abstract Classes on page 10-29

MATLAB Arrays
MATLAB determines the class of an array by the class of the objects contained in the
array. MATLAB is unlike some languages in which you define an array of object pointers
or references. In these other languages, the type of the array is different from the type of
an object in the array. You can access the elements of the array and dispatch to methods
on those elements, but you cannot call an object method on the whole array, like you can
in MATLAB.
Object arrays in MATLAB are typically homogeneous in class. Because of this
homogeneity, you can perform operations on whole arrays, such as multiplying numeric
matrices. Cell arrays provide an array type that can hold different kinds of unrelated
objects.

Heterogeneous Hierarchies
You can combine objects that are subclasses of a common superclass when these classes
are part of a heterogeneous hierarchy. A MATLAB heterogeneous class hierarchy:
Derives from matlab.mixin.Heterogeneous
Defines a single root superclass that derives directly from
matlab.mixin.Heterogeneous
10-21

10

Object Arrays

Seals methods that are inherited by subclasses.

For example, in the following diagram, Shape is the root of the heterogeneous hierarchy.

Heterogeneous Arrays
A heterogeneous array is an array of objects that differ in their specific class, but all
objects derive from or are instances of a common superclass. The common superclass
forms the root of the hierarchy of classes that you can combine into heterogeneous
arrays.
The common superclass class must derive from matlab.mixin.Heterogeneous. Methods
that you can call on the array as a whole must have the same definitions for all
subclasses.
Heterogeneous hierarchies are useful to:
Create arrays of objects that are of different classes, but part of a related hierarchy.
Call methods of the most specific common superclass on the array as a whole
Access properties of the most specific common superclass using dot notation with the
array
Use common operators that are supported for object arrays
Support array indexing (scalar or nonscalar) that returns arrays of the most specific
class

Heterogeneous Array Concepts

10-22

Heterogeneous Arrays

Heterogeneous array An array in which two or more elements belong to different

specific classes. All elements derive from the same root superclass.
Root superclass Class derived directly from matlab.mixin.Heterogeneous.
The root superclass can be abstract or concrete. Only concrete subclasses of the root
superclass can form heterogeneous arrays.
Most specific common superclass The most specific class in the inheritance
hierarchy from which all the objects in a heterogeneous array derive. The most
specific common superclass can be the root superclass or a more specific superclass
shared by the objects currently in the array.
Class of a heterogeneous array The most specific common superclass from which
all objects in the heterogeneous array derive. Adding and removing objects from a
heterogeneous array can change the most specific superclass shared by the instances.
This change results in a change in the class of a heterogeneous array. The most
specific common superclass can be abstract.

Nature of Heterogeneous Arrays

The heterogeneous hierarchy in this diagram illustrates the characteristics of
heterogeneous arrays concerning:
Array class
Property access
Method invocation

10-23

10

Object Arrays

Class of Heterogeneous Arrays

The class of a heterogeneous array is that of the most specific superclass shared by the
objects of the array.
If the following conditions are true, the concatenation and subscripted assignment
operations return a heterogeneous array:
The objects on the right side of the assignment statement are of different classes
All objects on the right side of the assignment statement derive from a common
subclass of matlab.mixin.Heterogeneous
For example, form an array by concatenating objects of these classes. The class of a1 is
ClassA:
a1 = [SpecificA,SpecificB];

10-24

Heterogeneous Arrays

class(a1)
ans =
ClassA

If the array includes an object of the class SpecificC, the class of a2 is

RootSuperclass:
a2 = [SpecificA,SpecificB,SpecificC];
class(a2)
ans =
RootSuperclass

If you assigned an object of the class SpecificC to array a1 using indexing, the class of
a1 becomes RootSuperclass:
a1(3) = SpecificC;
class(a1)
ans =
RootSuperclass

If the array contains objects of only one class, then the array is not heterogeneous. For
example, the class of a is SpecificA.
a = [SpecificA,SpecificA];
class(a)
ans =
SpecificA

Property Access
Access array properties with dot notation when the class of the array defines the
properties. The class of the array is the most specific common superclass, which ensures
all objects inherit the same properties.
For example, suppose ClassA defines a property called Prop1.
10-25

10

Object Arrays

a1 = [SpecificA,SpecificB];
a1.Prop1

Referring to Prop1 using dot notation returns the value of Prop1 for each object in the
array.
Method Invocation
To invoke a method on a heterogeneous array, the class of the array must define or
inherit the method as Sealed. For example, suppose RootSuperclass defines a
Sealed method called superMethod.
Call the method on all objects in the array a2:
a2 = [SpecificA,SpecificB,SpecificC];
a2.superMethod

Sealing the method (so that it cannot be overridden in a subclass) ensures that the same
method definition exists for all elements of the array. Calling that method on a single
element of the array invokes the same method implementation as calling the method on
the whole array.

Unsupported Hierarchies
Heterogeneous hierarchies cannot have ambiguities when obtaining default objects,
determining the class of the array, and converting class objects to other types. Members
of the hierarchy can derive from only one root superclass (that is, from only one direct
subclass of matlab.mixin.Heterogeneous).
This diagram shows a hierarchy that is not allowed:

10-26

Heterogeneous Arrays

ClassA derives from two classes that are subclasses of

matlab.mixin.Heterogeneous.
The next diagram shows two separate heterogeneous hierarchies. ClassA has only one
root superclass (called OtherBaseClass). The heterogeneous hierarchy is no longer
ambiguous:

10-27

10

Object Arrays

Default Object
A default object is the object returned by calling the class constructor with no arguments.
MATLAB uses default objects in these situations:
Indexed assignment creates an array with gaps in array elements. For example,
assign the first element of array h to index 5:
h(5) = ClassA(arg1,arg2);

MATLAB fills the unassigned positions with default objects.

Loading a heterogeneous array from a MAT-file when the class definition of a specific
object in the array is not available. MATLAB replaces the object with the default
object.

10-28

Heterogeneous Arrays

Heterogeneous hierarchies enable you to define the default object for that hierarchy. The
matlab.mixin.Heterogeneous class provides a default implementation of a method
called getDefaultScalarElement. This method returns an instance of the root class of
the heterogeneous hierarchy, unless the root superclass is abstract.
If the root superclass is abstract or is not appropriate for a default object,
override the getDefaultScalarElement method. Implement the
getDefaultScalarElement override in the root superclass, which derives directly from
matlab.mixin.Heterogeneous.
getDefaultScalarElement must return a scalar object that is derived from the
root superclass. For specific information on how to implement this method, see
getDefaultScalarElement.

Conversion During Assignment and Concatenation

If you create a heterogeneous array that contains objects that are not derived from
the same root superclass, MATLAB attempts to call a method called convertObject.
Implement convertObject to convert objects to the appropriate class. There is no
default implementation of this method.
To support the formation of heterogeneous arrays using objects that are not part of the
heterogeneous hierarchy, implement a convertObject method in the root superclass.
The convertObject method must convert the nonmember object to a valid member of
the heterogeneous hierarchy.
For details on implementing the convertObject method, see
matlab.mixin.Heterogeneous.

Empty Arrays of Heterogeneous Abstract Classes

For homogeneous arrays, MATLAB does not allow you to initialize an empty array of
an abstract class. However, if the class is part of a heterogeneous hierarchy, you can
initialize empty arrays of an abstract class. Initializing an empty heterogeneous array is
useful in cases in which you do not know the class of the concrete elements in advance.
For example, suppose RootSuperclass is an abstract class that is the root of a
heterogeneous hierarchy. Initialize an array using the empty static method:
ary = RootSuperclass.empty;

10-29

10

Object Arrays

Related Examples

10-30

Handle-Compatible Classes and Heterogeneous Arrays on page 12-42

Heterogeneous Array Constructors

Heterogeneous Array Constructors

In this section...
Building Arrays in Superclass Constructors on page 10-31
When Errors Can Occur on page 10-31
Initialize Array in Superclass Constructor on page 10-32
Sample Implementation on page 10-33
Potential Error on page 10-35

Building Arrays in Superclass Constructors

When a subclass in a heterogeneous class hierarchy calls its superclass to construct
an array of objects, you must ensure that the superclass constructor does not return a
heterogeneous array to the subclass. The following programming patterns show how to
avoid the errors caused by returning the wrong class to the subclass constructor.

When Errors Can Occur

Constructors must return objects that are the same class as the defining class. When
working with objects from a heterogeneous class hierarchy, the class of an object array
can change as you add array elements of different classes. As a result, heterogeneous
superclass constructors can change the class of object arrays when the class design
requires all of the following techniques:
Building object arrays in subclass constructors
Calling superclass constructors from subclass constructors to pass arguments
Creating object arrays in the superclass constructor
In addition, either of the following is true:
The root superclass is not abstract and does not implement a
getDefaultScalarElement method.
The root superclass implements a getDefaultScalarElement method that returns
an object that is not the same class as the subclass.
When assigning to object arrays, MATLAB uses the default object to fill in unassigned
array elements. In a heterogeneous hierarchy, the default object can be the superclass
10-31

10

Object Arrays

that is called by the subclass constructor. Therefore, building an array in the superclass
constructor can create a heterogeneous array.
If a superclass constructor returns a heterogeneous array to the subclass constructor,
MATLAB generates an error (see Potential Error on page 10-35).

Initialize Array in Superclass Constructor

To avoid errors, initialize the object array explicitly in the superclass constructor.
For example, use repelem in the superclass constructor to initialize the array before
initializing the superclass part of the objects. Initializing the array ensures that all
elements assigned into the array are of the same class as the obj argument.
In this code, the superclass constructor creates one object for each element in the input
argument, arg:
method
function obj = SuperClass(arg)
...
n = numel(arg);
obj = repelem(obj,1,n);
for k = 1:n
obj(k).SuperProp = arg(k);
end
...
end
end

The subclass constructor calls the superclass constructor to pass the required argument
array, a:
method
function obj = SubClass(a)
obj = obj@SuperClass(a);
for k = 1:numel(a)
obj(k).SubProp = a(k);
end
end
end

10-32

Heterogeneous Array Constructors

Sample Implementation
The following class hierarchy defines a subclass that builds object arrays in its
constructor. The root superclass of the hierarchy initializes the superclass part of the
objects in the array.
This class hierarchy represents members of an engineering team. The classes in the
hierarchy include:
TeamMembers Superclass for specific team member classes, like
ProjectEngineer. TeamMembers defines the Name and PhoneX properties and
derives from matlab.mixin.Heterogeneous.
ProjectEngineer Team members that are engineers. Each instance inherits a
Name and PhoneX property and defines a billing Rate property.
Other members Other types of team members not implemented for this example for
simplicity.

10-33

10

Object Arrays

The TeamMembers class is the root of the heterogeneous hierarchy and is a concrete
class. Before assigning values to the Name and PhoneX properties, the constructor
initializes an array of subclass (ProjectEngineer) objects.
The ProjectEngineer constructor provides the obj argument for the call to repelem
with this statement:
obj = obj@TeamMembers(varargin{1:2});

Here is the TeamMembers class:

classdef TeamMembers < matlab.mixin.Heterogeneous
properties
Name
PhoneX
end
methods
function obj = TeamMembers(nme,ext)
if nargin > 0
n = numel(nme);
obj = repelem(obj,1,n);
for k = 1:n
obj(k).Name = nme{k};
obj(k).PhoneX = ext(k);
end
else
obj.Name = '';
end
end
end
end

The ProjectEngineer class represents one type of team member. This class supports
array inputs and returns an array of objects.
classdef ProjectEngineer < TeamMembers
% Inputs: {Name}, [PhoneX], {Rate}
properties
Rate
end
methods
function obj = ProjectEngineer(varargin)
obj = obj@TeamMembers(varargin{1:2});
for k = 1:numel(varargin{1})

10-34

Heterogeneous Array Constructors

obj(k).Rate = varargin{3}{k};
end
end
end
end

The ProjectEngineer class requires a cell array of names, a numeric array of phone
extensions, and a cell array of billing rates for each engineer in the team.
nm
px
rt
tm

=
=
=
=

{'Fred','Nancy','Claudette'};
[8112,8113,8114];
{'C2','B1','A2'};
ProjectEngineer(nm,px,rt)

tm =
1x3 ProjectEngineer array with properties:
Rate
Name
PhoneX

Potential Error
The TeamMembers constructor initializes the object array with this statement:
obj = repelem(obj,1,n);

Because the obj argument to repelem is a ProjectEngineer object, the array

returned is of the same class.
Without this statement, the TeamMembers constructor would create default objects to
fill in array elements in the for loop. The resulting heterogeneous array would be of the
class of the common superclass (TeamMembers in this case). If the superclass returns
this heterogeneous array to the subclass constructor, it is a violation of the rule that class
constructors must preserve the class of the returned object.
MATLAB issues this error:
When constructing an instance of class 'ProjectEngineer', the constructor must
preserve the class of the returned object.
Error in ProjectEngineer (line 8)

10-35

10

Object Arrays

obj = obj@TeamMembers(varargin{1:2});

More About

10-36

Heterogeneous Arrays on page 10-21

11
Events Sending and Responding to
Messages
Overview Events and Listeners on page 11-2
Class with Custom Event Data on page 11-6
Class to Observe Property Changes on page 11-9
Implement Property Set Listener on page 11-11
Event and Listener Concepts on page 11-14
Event Attributes on page 11-19
Events and Listeners Syntax on page 11-21
Listener Lifecycle on page 11-27
Listener Callback Syntax on page 11-29
Callback Execution on page 11-32
Determine If Event Has Listeners on page 11-34
Listen for Changes to Property Values on page 11-37
Abort Property Set Events on page 11-41
Update Graphs Using Events and Listeners on page 11-45

11

Events Sending and Responding to Messages

Overview Events and Listeners

In this section...
Why Use Events and Listeners on page 11-2
Events and Listeners Basics on page 11-2
Events and Listeners Syntax on page 11-3
Create Listener on page 11-4

Why Use Events and Listeners

Events are notices that objects broadcast in response to something that happens,
such as a property value changing or a user interaction with an application program.
Listeners execute functions when notified that the event of interest occurs. Use events to
communicate changes to objects. Listeners respond by executing the callback function.
For more information, see Event and Listener Concepts on page 11-14.

Events and Listeners Basics

When using events and listeners:
Only handle classes can define events and listeners.
Define event names in the events block of a class definition (Events and Listeners
Syntax on page 11-21).
Use event attributes to specify access to the event (Event Attributes on page
11-19).
Call the handle notify method to trigger the event. The event notification broadcasts
the named event to all listeners registered for this event.
Use the handle addlistener method to couple a listener to the event source object.
MATLAB destroys the listener when the source of the event is destroyed.
Use the event.listener class constructor to create listeners that are not coupled to
the lifecycle of the event source object. This approach is useful when the event source
and the listeners are defined in different components that you want to be able to add,
remove, or modify independently of each other. Your application code controls the
listener object lifecycle.
11-2

Overview Events and Listeners

Listener callback functions must define at least two input arguments the event
source object handle and the event data (See Listener Callback Syntax on page
11-29 for more information).
Modify the data passed to each listener callback by subclassing the event.EventData
class.
Predefined Events
MATLAB Defines events for listening to property sets and queries. For more information,
see Listen for Changes to Property Values on page 11-37.
All handle objects define an event named ObjectBeingDestroyed. MATLAB triggers
this event before calling the class destructor.

Events and Listeners Syntax

Define an event name in the events code block:
classdef ClassName < handle
...
events
EventName
end
...
end

For example, MyClass defines an event named StateChange:

classdef MyClass < handle
events
StateChange
end
end

Trigger an event using the handle class notify method:

classdef ClassName < handle
...
events
EventName
end
...

11-3

11

Events Sending and Responding to Messages

methods
function anyMethod(obj)
...
notify(obj,'EventName');
end
end

Any function or method can trigger the event for a specific instance of the class defining
the event. For example, the triggerEvent method calls notify to trigger the
StateChange event:
classdef MyClass < handle
events
StateChange
end
methods
function triggerEvent(obj)
notify(obj,'StateChange')
end
end
end

Trigger the StateChange event with the triggerEvent method:

obj = MyClass;
obj.triggerEvent

Create Listener
Define a listener using the handle class addlistener method. Pass a function handle for
the listener callback function using a syntax like these:
addlistener(eventObject,'EventName',@functionName) for an ordinary
function.
addlistener(eventObject,'EventName',@Obj.methodName) for a method of
Obj.
addlistener(eventObject,'EventName',@ClassName.methodName) for a
static method of the class ClassName.
ListenerObject = addlistener(SourceOfEvent,'EventName',@listenerCallback);

addlistener returns the listener object. The input arguments are:

11-4

Overview Events and Listeners

SourceOfEvent An object of the class defining the event on which the event
occurred.
EventName The name of the event defined in the class events code block.
@listenerCallback a function handle referencing the function that executes in
response to the event.
For example, create a listener object for the StateChange event:
function lh = createListener(src)
lh = addlistener(src,'StateChange',@handleStateChange)
end

Define the callback function for the listener. The callback function must accept as the
first two arguments the event source object and an event data object:
function handleStateChange(src,eventData)
...
end

Related Examples

Listener Lifecycle on page 11-27

Implement Property Set Listener on page 11-11

11-5

11

Events Sending and Responding to Messages

Class with Custom Event Data

In this section...
Class Event Data Requirements on page 11-6
Define and Trigger Event on page 11-6
Define Event Data on page 11-7
Create Listener for Overflow Event on page 11-8

Class Event Data Requirements

Suppose you want to create a listener callback function that has access to specific
information when the event occurs. This example shows how to do this by creating
custom event data.
Events provide information to listener callback functions by passing an event data
argument to the specified function. By default, MATLAB passes an event.EventData
object to the listener callback. This object has two properties:
EventName Name of the event triggered by this object.
Source Handle of the object triggering the event.
Provide additional information to the listener callback by subclassing the
event.EventData class.
Define properties in the subclass to contain the additional data.
Define a constructor that accepts the additional data as arguments.
Set the ConstructOnLoad class attribute.
Use the subclass constructor as an argument to the notify method to trigger the
event.

Define and Trigger Event

The SimpleEventClass defines a property set method (see Property Set Methods on
page 8-29) from which it triggers an event if the property is set to a value exceeding a
certain limit. The property set method performs these operations:
11-6

Class with Custom Event Data

Saves the original property value

Sets the property to the specified value
If the specified value is greater than 10, the set method triggers an Overflow event
Passes the original property value, as well as other event data, in a
SpecialEventDataClass object to the notify method.
classdef SimpleEventClass < handle
properties
Prop1 = 0;
end
events
Overflow
end
methods
function set.Prop1(obj,value)
orgvalue = obj.Prop1;
obj.Prop1 = value;
if (obj.Prop1 > 10)
% Trigger the event using custom event data
notify(obj,'Overflow',SpecialEventDataClass(orgvalue));
end
end
end
end

Define Event Data

Event data is always contained in an event.EventData object. The
SpecialEventDataClass adds the original property value to the event data by
subclassing event.EventData:
classdef (ConstructOnLoad) SpecialEventDataClass < event.EventData
properties
OrgValue = 0;
end
methods
function eventData = SpecialEventDataClass(value)
eventData.OrgValue = value;
end
end
end

11-7

11

Events Sending and Responding to Messages

Create Listener for Overflow Event

To listen for the Overflow event, attach a listener to an instance of the
SimpleEventClass class. Use the addlistener method to create the listener. You also
need to define a callback function for the listener to execute when the event is triggered.
The function setupSEC instantiates the SimpleEventClass class and adds a listener
to the object. In this example, the listener callback function displays information that is
contained in the eventData argument (which is a SpecialEventDataClass object).
function sec = setupSEC
sec = SimpleEventClass;
addlistener(sec,'Overflow',@overflowHandler)
function overflowHandler(eventSrc,eventData)
disp('The value of Prop1 is overflowing!')
disp(['Its value was: ' num2str(eventData.OrgValue)])
disp(['Its current value is: ' num2str(eventSrc.Prop1)])
end
end

Create the SimpleEventClass object and add the listener:

sec = setupSEC;
sec.Prop1 = 5;
sec.Prop1 = 15; % listener triggers callback
The value of Prop1 is overflowing!
Its value was: 5
Its current value is: 15

Related Examples

11-8

Class to Observe Property Changes on page 11-9

Class to Observe Property Changes

Class to Observe Property Changes

This example shows how to listen for changes to a property value. This example uses:
PostSet event predefined by MATLAB
SetObservable property attribute to enable triggering the property PostSet event.
addlistener handle class method to create the listener
classdef PropLis < handle
% Define a property that is SetObservable
properties (SetObservable)
ObservedProp = 1;
end
methods
function attachListener(obj)
%Attach a listener to a PropListener object
addlistener(obj,'ObservedProp','PostSet',@PropLis.propChange);
end
end
methods (Static)
function propChange(metaProp,eventData)
% Callback for PostSet event
% Inputs: meta.property object, event.PropertyEvent
h = eventData.AffectedObject;
propName = metaProp.Name;
disp(['The ',propName,' property has changed.'])
disp(['The new value is: ',num2str(h.ObservedProp)])
disp(['Its default value is: ',num2str(metaProp.DefaultValue)])
end
end
end

The PropLis class uses an ordinary method (attachListener) to add the listener for
the ObservedProp property. If the PropLis class defines a constructor, the constructor
can contain the call to addlistener.
The listener callback is a static method (propChange). MATLAB passes two arguments
when calling this function:
metaProp a meta.property object for ObservedProp
eventData an event.PropertyEvent object contain event specific data.
These arguments provide information about the property and the event.
11-9

11

Events Sending and Responding to Messages

Use the PropLis class by creating an instance and calling its attachListener method:
plObj = PropLis;
plObj.ObservedProp
ans =
1
plObj.attachListener
plObj.ObservedProp = 2;
The ObservedProp property has changed.
The new value is: 2
Its default value is: 1

Related Examples

11-10

Implement Property Set Listener on page 11-11

Implement Property Set Listener

Implement Property Set Listener

This example shows how to define a listener for a property set event. This means the
listener callback triggers when the value of a specific property changes. The class defined
for this example uses a method for a push button callback and a static method for the
listener callback. When the push button callback changes the value of a property, the
listener executes its callback on the PreSet event.
This example defines a class (PushButton) with these design elements:
ResultNumber Observable property
uicontrol pushbutton Push button object used to generate a new graph when its
callback executes
A listener that responds to a change in the observable property

PushButton Class Design

The PushButton class creates figure, uicontrol, axes graphics objects and a listener
object in the class constructor.
The push button's callback is a class method (named pressed). When the push button is
activated, the following sequence occurs:
1

MATLAB executes the pressed method, which graphs a new set of data and
increments the ResultNumber property.

Attempting to set the value of the ResultNumber property triggers the PreSet
event, which executes the listener callback before setting the property value.

The listener callback uses the event data to obtain the handle of the callback object
(an instance of the PushButton class), which then provides the handle of the axes
object that is stored in its AxHandle property.

The listener callback updates the axes Title property, after the callback completes
execution, MATLAB sets the ResultsNumber property to its new value.

classdef PushButton < handle

properties (SetObservable)
ResultNumber = 1;
end
properties

11-11

11

Events Sending and Responding to Messages

AxHandle
end
methods
function buttonObj = PushButton
myFig = figure;
buttonObj.AxHandle = axes('Parent',myFig);
uicontrol('Parent',myFig,...
'Style','pushbutton',...
'String','Plot Data',...
'Callback',@(src,evnt)pressed(buttonObj));
addlistener(buttonObj,'ResultNumber','PreSet',...
@PushButton.updateTitle);
end
end
methods
function pressed(obj)
scatter(obj.AxHandle,randn(1,20),randn(1,20),'p')
obj.ResultNumber = obj.ResultNumber + 1;
end
end
methods (Static)
function updateTitle(~,eventData)
h = eventData.AffectedObject;
set(get(h.AxHandle,'Title'),'String',['Result Number: ',...
num2str(h.ResultNumber)])
end
end
end

The scatter graph looks similar to this after three push-button clicks.
buttonObj = PushButton;

11-12

Implement Property Set Listener

Related Examples

Listen for Changes to Property Values on page 11-37

11-13

11

Events Sending and Responding to Messages

Event and Listener Concepts

In this section...
The Event Model on page 11-14
Limitations on page 11-15
Default Event Data on page 11-16
Events Only in Handle Classes on page 11-16
Property-Set and Query Events on page 11-17
Listeners on page 11-17

The Event Model

Events represent changes or actions that occur within objects. For example,
Modification of class data
Execution of a method
Querying or setting a property value
Destruction of an object
Basically, any activity that you can detect programmatically can generate an event and
communicate information to other objects.
MATLAB classes define a process that communicates the occurrence of events to other
objects that need to respond to the events. The event model works this way:
A handle class declares a name used to represent an event. Name Events on page
11-21
After creating an object of the event-declaring class, attach listener to that object.
Control Listener Lifecycle on page 11-27
A call to the handle class notify method broadcasts a notice of the event to listeners.
The class user determines when to trigger the event. Trigger Events on page
11-22
Listeners execute a callback function when notified that the event has occurred.
Specifying Listener Callbacks on page 11-29
You can bind listeners to the lifecycle of the object that defines the event, or limit
listeners to the existence and scope of the listener object. Control Listener Lifecycle
on page 11-27
11-14

Event and Listener Concepts

The following diagram illustrates the event model.

BankAccount

1. The withdraw method is called.

if AccountBalance <= 0
notify(obj,InsufficientFunds);
end

Properties
AccountNumber
AccountBalance
Methods
deposit
withdraw
Events
InsufficientFunds

2. The notify method

triggers an event, and a
message is broadcast.

InsufficientFunds
3. Listeners awaiting message
execute their callbacks.
(The broadcasting object
does not necessarily know
who is listening.)

Listener1
Properties
EventName = InsufficientFunds
FunctionHandle = @Callback1

InsufficientFunds

Listener2
Properties
EventName = InsufficientFunds
FunctionHandle = @Callback2

Limitations
There are certain limitations to the use of events:
The event source cannot guarantee that listeners exist when the triggering the event.
A listener cannot prevent other listeners from being notified that the event occurred.
The order in which listeners execute is not defined.
11-15

11

Events Sending and Responding to Messages

Listeners should not modify the event data object passed to the listener callback,
because other listeners are passed this same handle object.

Default Event Data

Events provide information to listener callbacks by passing an event data argument to
the callback function. By default, MATLAB passes an event.EventData object to the
listener callback. This object has two properties:
EventName The event name as defined in the class event block
Source The object that is the source of the event
MATLAB passes the source object to the listener callback in the required event data
argument. This enables you to access any of the object's public properties from within
your listener callback function.
Customize Event Data
You can create a subclass of the event.EventData class to provide additional
information to listener callback functions. The subclass would define properties to
contain the additional data and provide a method to construct the derived event data
object so it can be passed to the notify method.
Define Event-Specific Data on page 11-25 provides an example showing how to
customize this data.

Events Only in Handle Classes

You can define events only in handle classes. This restriction exists because a value class
is visible only in a single MATLAB workspace so no callback or listener can have access
to the object that triggered the event. The callback could have access to a copy of the
object. However, accessing a copy is not generally useful because the callback cannot
access the current state of the object that triggered the event or effect any changes in
that object.
Comparison of Handle and Value Classes on page 7-2 provides general information on
handle classes.
Events and Listeners Syntax on page 11-21 shows the syntax for defining a handle
class and events.
11-16

Event and Listener Concepts

Property-Set and Query Events

There are four predefined events related to properties:
PreSet Triggered just before the property value is set, before calling its set access
method
PostSet Triggered just after the property value is set
PreGet Triggered just before a property value query is serviced, before calling its
get access method
PostGet Triggered just after returning the property value to the query
These events are predefined and do not need to be listed in the class events block.
When a property event occurs, the callback is passed an event.PropertyEvent object.
This object has three properties:
EventName The name of the event described by this data object
Source The source object whose class defines the event described by the data
object
AffectedObject The object whose property is the source for this event (that
is, AffectedObject contains the object whose property was either accessed or
modified).
You can define your own property-change event data by subclassing the
event.EventData class. Note that the event.PropertyEvent class is a sealed
subclass of event.EventData.
See Listen for Changes to Property Values on page 11-37 for a description of the
process for creating property listeners.
See The PostSet Event Listener on page 11-55 for an example.
See Property Access Methods on page 8-23 for information on methods that control
access to property values.

Listeners
Listeners encapsulate the response to an event. Listener objects belong to the
event.listener class, which is a handle class that defines the following properties:
11-17

11

Events Sending and Responding to Messages

Source Handle or array of handles of the object that generated the event
EventName Name of the event
Callback Function to execute when an enabled listener receives event notification
Enabled Callback function executes only when Enabled is true. See Enable and
Disable Listeners on page 11-58 for an example.
Recursive Allow listener to cause the same event that triggered the execution of
the callback
Recursive is false by default. If the callback triggers its own event, the listener
cannot execute recursively. Setting the Recursive to true can create a situation
where infinite recursion reaches the recursion limit and triggers an error.
Control Listener Lifecycle on page 11-27 provides more specific information.

11-18

Event Attributes

Event Attributes
Specify Event Attributes
The following table lists the attributes you can set for events. To specify a value
for an attribute, assign the attribute value on the same line as the event key word.
For example, all the events defined in the following events block have protected
ListenAccess and private NotifyAccess.
events (ListenAccess = 'protected', NotifyAccess = 'private')
EventName1
EventName2
end

To define other events in the same class definition that have different attribute settings,
create another events block.
Event Attributes
Attribute Name Class
Hidden

logical Default =
false

ListenAccess enumeration,
default = public
meta.class
object
cell array of
meta.class
objects

Description
If true, event does not appear in list of events returned
by events function (or other event listing functions or
viewers).
Determines where you can create listeners for the event.
public Unrestricted access
protected Access from methods in class or
subclasses
private Access by class methods only (not from
subclasses)
List classes that have listen access to this event. Specify
classes as meta.class objects in the form:
A single meta.class object
A cell array of meta.class objects. An empty cell
array, {}, is the same as private access.
See Control Access to Class Members on page
12-25
11-19

11

Events Sending and Responding to Messages

Attribute Name Class

Description

NotifyAccess enumeration,
default = public

Determines where code can trigger the event

meta.class
object
cell array of
meta.class
objects

public Any code can trigger event

protected Can trigger event from methods in class
or derived classes
private Can trigger event by class methods only
(not from derived classes)
List classes that have notify access to this event. Specify
classes as meta.class objects in the form:
A single meta.class object
A cell array of meta.class objects. An empty cell
array, {}, is the same as private access.
See Control Access to Class Members on page
12-25

Related Examples

11-20

Events and Listeners Syntax on page 11-21

Events and Listeners Syntax

Events and Listeners Syntax

In this section...
Components to Implement on page 11-21
Name Events on page 11-21
Trigger Events on page 11-22
Listen to Events on page 11-22
Define Event-Specific Data on page 11-25

Components to Implement
Implementation of events and listeners involves these components:
Specification of the name of an event in a handle class Name Events on page
11-21.
A function or method to trigger the event when the action occurs Trigger Events
on page 11-22.
Listener objects to execute callback functions in response to the triggered event
Listen to Events on page 11-22.
Default or custom event data that the event passes to the callback functions
Define Event-Specific Data on page 11-25.

Name Events
Define an event by declaring an event name inside an events block. For example, this
class creates an event called ToggledState:
classdef ToggleButton < handle
properties
State = false
end
events
ToggledState
end
end

11-21

11

Events Sending and Responding to Messages

Trigger Events
The OnStateChange method calls notify to trigger the ToggledState event. Pass the
handle of the object that is the source of the event and the name of the event to notify.
classdef ToggleButton < handle
properties
State = false
end
events
ToggledState
end
methods
function OnStateChange(obj,newState)
if newState ~= obj.State
obj.State = newState;
notify(obj,'ToggledState');
end
end
end
end

Listen to Events
After the call to notify triggers an event, MATLAB broadcasts a message to all
listeners that are defined for that event and source object. There are two ways to create
listeners: using the handle class addlistener method or the event.listener class
constructor.
Use addlistener for Persistent Listeners
If you want the listener to persist beyond the normal variable scope, use addlistener to
create it. The event source object holds a reference to the listener object. When the event
source object is destroyed, MATLAB destroys the listener.
This code defines a listener for the ToggleState event:
lh = addlistener(obj,'ToggleState',@RespondToToggle.handleEvnt);

addlistener has these arguments:

obj The object that is the source of the event
11-22

Events and Listeners Syntax

ToggleState The event name passed as a char vector

@RespondToToggle.handleEvnt A function handle to the callback function (see
the following definition Define Listener on page 11-24).
Use event.listener to Decouple Listener and Source
Use the event.listener class constructor to create listeners when you want to manage
the lifecycle of the listener and do not want a coupling between the event source and
listener object. MATLAB does not destroy listeners created with event.listener when
the event source is destroyed. However, your code must keep the listener object handle in
scope when creating listeners using event.listener.
The event.listener constructor requires the same arguments as addlistener:
the event-naming object, the event name, and a function handle to the callback.
event.listener returns the handle to the listener object.
lh = event.listener(obj,'EventName',@callbackFunction)

For example, this code uses the ToggleState event discussed previously:
lh = event.listener(obj,'ToggleState',@RespondToToggle.handleEvnt)

Callback Function
The listener callback function must accept a minimum of two arguments, which
MATLAB automatically passes to the callback. These are the required arguments:
The source of the event that is, obj in the call to addlistener or
event.listener.
An event.EventData object or a subclass of event.EventData, such as the
ToggleEventData object described in, Define Event-Specific Data on page
11-25.
You must define the callback function to accept the source object and event data
arguments.
function callbackFunction(src,evtdata)
...
end

For more information on callback syntax, see Listener Callback Syntax on page
11-29.
11-23

11

Events Sending and Responding to Messages

Define Listener
The RespondToToggle class defines objects that listen for the ToggleState event
defined in the ToggleButton class.
classdef RespondToToggle < handle
methods
function obj = RespondToToggle(toggle_button_obj)
addlistener(toggle_button_obj,'ToggledState',@RespondToToggle.handleEvnt);
end
end
methods (Static)
function handleEvnt(src,~)
if src.State
disp('ToggledState is true')
else
disp('ToggledState is false')
end
end
end
end

The class RespondToToggle adds the listener in its constructor. In this case, the class
defines the callback (handleEvnt) as a static method that accepts the two required
arguments:
src The handle of the object triggering the event (that is, a ToggleButton object)
evtdata An event.EventData object
For example, this code creates objects of both classes:
tb = ToggleButton;
rtt = RespondToToggle(tb);

Whenever you call the OnStateChange method of the ToggleButton object, notify
triggers the event. For this example, the callback displays the value of the State
property:
tb.OnStateChange(true)
ToggledState is true
tb.OnStateChange(false)

11-24

Events and Listeners Syntax

ToggledState is false

Remove Listeners
Remove a listener object by calling delete on its handle. For example, if the class
RespondToToggle saved the listener handle as a property, you could delete the listener.
classdef RespondToToggle < handle
properties
ListenerHandle % Property for listener handle
end
methods
function obj = RespondToToggle(toggle_button_obj)
hl = addlistener(toggle_button_obj,'ToggledState',@RespondToToggle.handleEvnt);
obj.ListenerHandle = hl; % Save listener handle
end
end
methods (Static)
function handleEvnt(src,~)
if src.State
disp('ToggledState is true')
else
disp('ToggledState is false')
end
end
end
end

With this code change, you can remove the listener from an instance of the
RespondToToggle class. For example:
tb = ToggleButton;
rtt = RespondToToggle(tb);

The object rtt is listening for the ToggleState event triggered by object tb. To remove
the listener, call delete on the property containing the listener handle.
delete(rtt.ListenerHandle)

To deactivate a listener temporarily, see Temporarily Deactivate Listeners on page

11-27.

Define Event-Specific Data

Suppose that you want to pass the state of the toggle button as a result of the event to
the listener callback. You can add more data to the default event data by subclassing the
event.EventData class and adding a property to contain this information. Then you can
pass this object to the notify method.
11-25

11

Events Sending and Responding to Messages

Note: To save and load objects that are subclasses of event.EventData, such as
ToggleEventData, enable the ConstructOnLoad class attribute for the subclass.
classdef (ConstructOnLoad) ToggleEventData < event.EventData
properties
NewState
end
methods
function data = ToggleEventData(newState)
data.NewState = newState;
end
end
end

The call to notify can use the ToggleEventData constructor to create the necessary
argument.
evtdata = ToggleEventData(newState);
notify(obj,'ToggledState',evtdata);

Related Examples

11-26

Listener Callback Syntax on page 11-29

Listen for Changes to Property Values on page 11-37

Update Graphs Using Events and Listeners on page 11-45

Listener Lifecycle

Listener Lifecycle
In this section...
Control Listener Lifecycle on page 11-27
Temporarily Deactivate Listeners on page 11-27
Permanently Delete Listeners on page 11-28

Control Listener Lifecycle

There are two ways to create listeners:
addlistener creates a coupling between the listener and event source object. The
listener object persists until you delete it or until the event object is destroyed. When
the event source object is destroyed, MATLAB automatically destroys the listener
object.
event.listener constructs listener objects that are not coupled to the lifecycle of
the event source object. The listener is active as long as the listener object remains
in scope and is not explicitly deleted. Therefore, your application must maintain
a reference to the listener object by storing the listener handle. The advantage of
uncoupling the listener and event objects is that you can define and destroy each
independently.
For more information, see Events and Listeners Syntax on page 11-21.
Note: Do not use the pack command with objects that define events and listeners. The
pack command causes the destructor of any listeners defined for the objects in the
workspace. For information on restoring listeners when saving objects, see Restore
Listeners on page 13-33.

Temporarily Deactivate Listeners

The addlistener method returns the listener object so that you can set its properties.
For example, you can temporarily disable a listener by setting its Enabled property to
false:
ListenerHandle.Enabled = false;

11-27

11

Events Sending and Responding to Messages

To re-enable the listener, set Enabled to true.

ListenerHandle.Enabled = true;

Permanently Delete Listeners

Calling delete on a listener object destroys it and permanently removes the listener:
delete(ListenerHandle)

Related Examples

11-28

Enable and Disable Listeners on page 11-58

Listener Callback Syntax

Listener Callback Syntax

In this section...
Specifying Listener Callbacks on page 11-29
Input Arguments for Callback Function on page 11-29
Additional Arguments for Callback Function on page 11-30

Specifying Listener Callbacks

Callbacks are functions that execute when the listener receives notification of the
event. Pass a function handle referencing the callback function to addlistener or
event.listener when creating the listener.
All callback functions must accept at least two arguments:
The handle of the object that is the source of the event
An event.EventData object or an object that is derived from the event.EventData
class.
Syntax to Reference Callback
For a function: functionName
lh = addlistener(eventSourceObj,'EventName',@functionName)

For an ordinary method called with an object of the class: obj.methodName

lh = addlistener(eventSourceObj,'EventName',@obj.methodName)

For a static method:ClassName.methodName

lh = addlistener(eventSourceObj,'EventName',@ClassName.methodName)

For a function in a package:PackageName.functionName

lh = addlistener(eventSourceObj,'EventName',@PackageName.functionName)

Input Arguments for Callback Function

Define the callback function to accept the required arguments:
function callbackFunction(src,evnt)

11-29

11

Events Sending and Responding to Messages

...
end

If you do not use the event source and event data arguments, you can define the function
to ignore these inputs:
function callbackFunction(~,~)
...
end

For a method:
function callbackMethod(obj,src,evnt)
...
end

Additional Arguments for Callback Function

To pass arguments to your callback in addition to the source and event data arguments
passed by MATLAB, use an anonymous function. Anonymous functions can use any
variables that are available in the current workspace.
Syntax Using Anonymous Function
Here is the syntax for an ordinary method. The input arguments (arg1,...argn) must
be define in the context in which you call addlistener.
lh = addlistener(src,'EventName',@(src,evnt)obj.callbackMethod(src,evnt,arg1,...argn)

Use varargin to define the callback function.

function callbackMethod(src,evnt,varargin)
arg1 = varargin{1};
...
argn = varargin{n};
...
end

For general information on anonymous function, see Anonymous Functions.

Using Methods for Callbacks
The TestAnonyFcn class shows the use of an anonymous function with an additional
argument. The listener callback displays the inputs arguments to show how MATLAB
calls the callback method.
11-30

Listener Callback Syntax

classdef TestAnonyFcn < handle

events
Update
end
methods
function obj = TestAnonyFcn
t = datestr(now);
addlistener(obj,'Update',@(src,evnt)obj.evntCb(src,evnt,t));
end
function triggerEvnt(obj)
notify(obj,'Update')
end
end
methods (Access = private)
function evntCb(~,~,evnt,varargin)
disp(['Number of inputs: ',num2str(nargin)])
disp(evnt.EventName)
disp(varargin{:})
end
end
end

Create an object and trigger the event by calling the triggerEvt method:
obj = TestAnonyFcn;
obj.triggerEvnt;
Number of inputs: 4
Update
01-Jul-2008 17:19:36

Related Examples

Callback Execution on page 11-32

Create Function Handle

11-31

11

Events Sending and Responding to Messages

Callback Execution
In this section...
When Callbacks Execute on page 11-32
Listener Order of Execution on page 11-32
Callbacks That Call notify on page 11-32
Manage Callback Errors on page 11-33
Invoke Functions from Function Handles on page 11-33

When Callbacks Execute

Listeners execute their callback function when notified that the event has occurred.
Listeners are passive observers in the sense that errors in the execution of a listener
callback does not prevent the execution of other listeners responding to the same event,
or execution of the function that triggered the event.
Callback function execution continues until the function completes. If an error occurs in
a callback function, execution stops and control returns to the calling function. Then any
remaining listener callback functions execute.

Listener Order of Execution

The order in which listeners callback functions execute after the firing of an event is
undefined. However, all listener callbacks execute synchronously with the event firing.
The handle class notify method calls all listeners before returning execution to the
function that called notify.

Callbacks That Call notify

Do not modify and reuse or copy and reuse the event data object that you pass to notify,
which is then passed to the listener callback.
Listener callbacks can call notify to trigger events, including the same event that
invoked the callback. When a function calls notify, MATLAB sets the property values
of the event data object that is passed to callback functions. To ensure these properties
have appropriate values for subsequently called callbacks, you should always create a
new event data object if you call notify with custom event data.
11-32

Callback Execution

Manage Callback Errors

If you want to control how your program responds to errors, use a try/catch statement
in your listener callback function to handle errors.

Invoke Functions from Function Handles

When you create a function handle inside a class method, the context of the method
determines the context in which the function executes. This context gives the function
access to private and protected methods that are accessible to that class.
For example, the UpdateEvt class defines an event named Update and a listener for
that event. The listener callback is the private method evtCb.
classdef UpdateEvt < handle
events
Update
end
methods
function obj = UpdateEvt
addlistener(obj,'Update',@evtCb);
end
end
methods (Access = private)
function obj = evtCb(obj,varargin)
disp('Updated Event Triggered')
end
end
end

Private methods are normally accessible only by class methods. However, because the
function handle is created in a class method, notify can execute the callback from outside
of the class:
a = UpdateEvt;
a.notify('Update')
Updated Event Triggered

Related Examples

Listener Callback Syntax on page 11-29

11-33

11

Events Sending and Responding to Messages

Determine If Event Has Listeners

In this section...
Do Listeners Exist for This Event? on page 11-34
Why Test for Listeners on page 11-34
Coding Patterns on page 11-34
Listeners in Heterogeneous Arrays on page 11-35

Do Listeners Exist for This Event?

Use the event.hasListener function to determine if a specific event has listeners.
event.hasListener accepts an array of event source objects and an event name as
input arguments. It returns an array of logical values indicating if listeners exist for the
specified event on each object in the array.
Note: When called, event.hasListener must have NotifyAccess for the event.
That is, call event.Listener in a context in which you can call notify for the event in
question.

Why Test for Listeners

Use event.hasListener to avoid sending event notifications when there are no
listeners for the event. For example, if creating custom event data consumes significant
resources, or if events are triggered repeatedly, use event.hasListener to test for
listeners before performing these steps.

Coding Patterns
Conditionalize the creation of event data and the call to notify using
event.hasListener. For an object array a, determine if there are listeners before
creating event data and triggering the event:
if any(event.hasListener(a,'NameOfEvent'))
evt = MyCustomEventData(...);
notify(a,'NameOfEvent',evt)
end

11-34

Determine If Event Has Listeners

Trigger events selectively using logical indexing with the values returned by
event.hasListener. Send event notifications only for array elements that have
listeners:
ind = event.hasListeners(a,'NameOfEvent');
notify(a(ind),'NameOfEvent',evt)

Listeners in Heterogeneous Arrays

If the input object array is heterogeneous, the class of the array must define the specified
event. You can query the listeners only for events that are defined by all objects in the
array.
For example, in the following diagram, the class of a heterogeneous array formed with
objects of classes SpecificA, SpecificB, and SpecificC is RootSuperclass.
Therefore, event.hasListener can find listeners only for the RootEvent event,
because this is the only event common to all array elements.

Create a heterogeneous array with the three most specific classes:

11-35

11

Events Sending and Responding to Messages

het = [SpecificA,SpecificB,SpecificC];
class(het)
ans
RootSuperclass
events(het)
Events for class RootSuperclass
RootEvent

event.hasListener cannot determine if there are listeners for events that are defined
by some but not all objects in the array:
event.hasListener(het,'ClassAEvent')
Error using event.hasListener
Event 'ClassAEvent' is not defined for class 'RootSuperclass'.

Determine if individual objects in the heterogeneous array have listeners defined for
their specific events, by indexing into the array:
event.hasListener(het(1),'ClassAEvent')

For more information about determining the class of heterogeneous arrays, see
Heterogeneous Arrays on page 10-21.

Related Examples

11-36

Listener Lifecycle on page 11-27

Listen for Changes to Property Values

Listen for Changes to Property Values

In this section...
Create Property Listeners on page 11-37
Property Event and Listener Classes on page 11-39

Create Property Listeners

You can define listeners for the predeclared property events (named: PreSet, PostSet,
PreGet, and PostGet). To create listeners for those named events:
Specify the SetObservable and/or GetObservable property attributes.
Define callback functions
Create the property listener by including the name of the property as well as the
event in the call to addlistener.
If required, subclass event.data to create a specialized event data object to pass to
the callback function.
Prevent execution of the callback if the new value is the same as the current value
(see Abort Property Set Events on page 11-41).
Set Property Attributes to Enable Property Events
In the properties block, enable the SetObservable attribute. You can define PreSet
and PostSet listeners for the properties defined in this block:
properties (SetObservable)
PropOne
PropTwo
...
end

Define Callback Function for Property Event

The listener executes the callback function when MATLAB triggers the property event.
You must define the callback function to have two specific arguments, which are passed
to the function automatically when called by the listener:
Event source a meta.property object describing the object that is the source of
the property event
11-37

11

Events Sending and Responding to Messages

Event data a event.PropertyEvent object containing information about the

event
You can pass additional arguments if necessary. It is often simple to define this method
as Static because these two arguments contain most necessary information in their
properties.
For example, suppose the handlePropEvents function is a static method of the class
creating listeners for two properties of an object of another class:
methods (Static)
function handlePropEvents(src,evnt)
switch src.Name
case 'PropOne'
% PropOne has triggered an event
...
case 'PropTwo'
% PropTwo has triggered an event
...
end
end
end

Another possibility is to use the event.PropertyEvent object's EventName property in

the switch statement to key off the event name (PreSet or PostSet in this case).
Class Metadata on page 16-2 provides more information about the
meta.property class.
Add Listener to Property
The addlistener handle class method enables you to attach a listener to a property
without storing the listener object as a persistent variable. For a property events, use the
four-argument version of addlistener.
If the call
addlistener(EventObject,'PropOne','PostSet',@ClassName.handlePropertyEvents);

The arguments are:

EventObject handle of the object generating the event
PropOne name of the property to which you want to listen
PostSet name of the event for which you want to listen
@ClassName.handlePropertyEvents function handle referencing a static
method, which requires the use of the class name
11-38

Listen for Changes to Property Values

If your listener callback is an ordinary method and not a static method, the syntax is:
addlistener(EventObject,'PropOne','PostSet',@obj.handlePropertyEvents);

where obj is the handle of the object defining the callback method.
If the listener callback is a function that is not a class method, you pass a function handle
to that function. Suppose the callback function is a package function:
addlistener(EventObject,'PropOne','PostSet',@package.handlePropertyEvents);

For more information on passing functions as arguments, see Create Function Handle.

Property Event and Listener Classes

The following two classes show how to create PostSet property listeners for two
properties PropOne and PropTwo.
Class Generating the Event
The PropEvent class enables property PreSet and PostSet event triggering by
specifying the SetObservable property attribute. These properties also enable
the AbortSet attribute, which prevents the triggering of the property events if the
properties are set to a value that is the same as their current value (see Abort Property
Set Events on page 11-41).
classdef PropEvent < handle
properties (SetObservable, AbortSet)
PropOne
PropTwo
end
methods
function obj = PropEvent(p1,p2)
if nargin > 0
obj.PropOne = p1;
obj.PropTwo = p2;
end
end
end
end

Class Defining the Listeners

The PropListener class defines two listeners:
11-39

11

Events Sending and Responding to Messages

Property PropOne PostSet event

Property PropTwo PostSet event
You could define listeners for other events or other properties using a similar approach
and it is not necessary to use the same callback function for each listener. See the
meta.property and event.PropertyEvent reference pages for more on the
information contained in the arguments passed to the listener callback function.
classdef PropListener < handle
% Define property listeners
methods
function obj = PropListener(evtobj)
if nargin > 0
addlistener(evtobj,'PropOne','PostSet',@PropListener.handlePropEvents);
addlistener(evtobj,'PropTwo','PostSet',@PropListener.handlePropEvents);
end
end
end
methods (Static)
function handlePropEvents(src,evnt)
switch src.Name
case 'PropOne'
sprintf('PropOne is %s\n',num2str(evnt.AffectedObject.PropOne))
case 'PropTwo'
sprintf('PropTwo is %s\n',num2str(evnt.AffectedObject.PropTwo))
end
end
end
end

Related Examples

11-40

Abort Property Set Events on page 11-41

Abort Property Set Events

Abort Property Set Events

In this section...
AbortSet When Value Does Not Change on page 11-41
When to Use AbortSet on page 11-41
Implement AbortSet on page 11-41

AbortSet When Value Does Not Change

By default, MATLAB triggers the property PreSet and PostSet events, invokes the
propertys set method (if defined), and sets the property value, even when the current
value of the property is the same as the new value. You can prevent this behavior by
setting the property's AbortSet attribute to true. When AbortSet is true, MATLAB
does not:
Set the property value
Trigger the PreSet and PostSet events
Call the propertys set method, if one exists
When AbortSet is true, MATLAB gets the current property value to compare it
to the value you are assigning to the property. This causes the property get method
(get.Property) to execute, if one exists. However, MATLAB does not catch errors
resulting from the execution of this method and these errors are visible to the user.

When to Use AbortSet

Consider using AbortSet only when the cost of setting a property value is much greater
than the cost of always comparing the current value of the property with the new value
being assigned.

Implement AbortSet
The following example shows how the AbortSet attribute works. The AbortTheSet
class defines a property, PropOne, that has listeners for the PreGet and PreSet events
and enables the AbortSet attribute. The behavior of the post set/get events is equivalent
so only the pre set/get events are used for simplicity:
11-41

11

Events Sending and Responding to Messages

Note: Save the AbortTheSet class in a file with the same name in a folder on your
MATLAB path.
classdef AbortTheSet < handle
properties (SetObservable, GetObservable, AbortSet)
PropOne = 7
end
methods
function obj = AbortTheSet(val)
obj.PropOne = val;
addlistener(obj,'PropOne','PreGet',@obj.getPropEvt);
addlistener(obj,'PropOne','PreSet',@obj.setPropEvt);
end
function propval = get.PropOne(obj)
disp('get.PropOne called')
propval = obj.PropOne;
end
function set.PropOne(obj,val)
disp('set.PropOne called')
obj.PropOne = val;
end
function getPropEvt(obj,src,evnt)
disp ('Pre-get event triggered')
% ...
end
function setPropEvt(obj,src,evnt)
disp ('Pre-set event triggered')
% ...
end
function disp(obj)
% Overload disp to avoid accessing property
disp (class(obj))
end
end
end

The class specifies an initial value of 7 for the PropOne property. Therefore, if you create
an object with the property value of 7, there is not need to trigger the PreSet event:
ats = AbortTheSet(7);
get.PropOne called

If you specify a value other than 7, then MATLAB triggers the PreSet event:
11-42

Abort Property Set Events

ats = AbortTheSet(9);
get.PropOne called
set.PropOne called
get.PropOne called

Similarly, if you set the PropOne property to the value 9, the AbortSet attribute
prevents the property assignment and the triggering of the PreSet event. Notice also,
that there is no PreGet event generated. Only the property get method is called:
ats.PropOne = 9;
get.PropOne called

If you query the property value, the PreGet event is triggered:

a = ats.PropOne
Pre-get event triggered
get.PropOne called
a =
9

If you set the PropOne property to a different value, MATLAB:

Calls the property get method to determine if the value is changing
Triggers the PreSet event
Calls the property set method to set the new value
Calls the property get method again to determine if the result of calling the set
method changed the value.
ats.PropOne = 11;
get.PropOne called
Pre-set event triggered
set.PropOne called
get.PropOne called

Because a property set method might modify the value that is actually assigned to a
property, MATLAB must query the property value that would result from an assignment
after a call to the property set method. This results in multiple calls to a property get
method, if one is defined for that property.
11-43

11

Events Sending and Responding to Messages

Related Examples

11-44

Determine If Event Has Listeners on page 11-34

Update Graphs Using Events and Listeners

Update Graphs Using Events and Listeners

In this section...
Example Overview on page 11-45
Techniques Demonstrated in This Example on page 11-46
Summary of fcneval Class on page 11-46
Summary of fcnview Class on page 11-47
Methods Inherited from Handle Class on page 11-49
Using the fcneval and fcnview Classes on page 11-49
Implement UpdateGraph Event and Listener on page 11-51
The PostSet Event Listener on page 11-55
Enable and Disable Listeners on page 11-58
@fcneval/fcneval.m Class Code on page 11-59
@fcnview/fcnview.m Class Code on page 11-60

Example Overview
This example defines two classes:
fcneval The function evaluator class contains a MATLAB expression and
evaluates this expression over a specified range
fcnview The function viewer class contains a fcneval object and displays surface
graphs of the evaluated expression using the data contained in fcneval.
This class defines two events:
A class-defined event that occurs when a new value is specified for the MATLAB
function
A property event that occurs when the property containing the limits is changed
The following diagram shows the relationship between the two objects. The fcnview
object contains a fcneval object and creates graphs from the data it contains. fcnview
creates listeners to change the graphs if any of the data in the fcneval object change.

11-45

11

Events Sending and Responding to Messages

fcnview
Properties
fcneval object
graph

fcneval
Properties
FofXY
Lm observable
Data
Events
UpdateGraph

Listeners
Lm property
UpdateGraph

Techniques Demonstrated in This Example

Naming an event in the class definition
Triggering an event by calling notify
Enabling a property event via the SetObservable attribute
Creating listeners for class-defined events and property PostSet events
Defining listener callback functions that accept additional arguments
Enabling and disabling listeners

Summary of fcneval Class

The fcneval class evaluates a MATLAB expression over a specified range of two
variables. The fcneval is the source of the data that objects of the fcnview class graph
as a surfaces. fcneval is the source of the events used in this example. For a listing of
the class definition, see @fcneval/fcneval.m Class Code on page 11-59

11-46

Update Graphs Using Events and Listeners

Property

Value

Purpose

FofXY

function
handle

MATLAB expression (function of two variables).

Lm

two-element
vector

Limits over which function is evaluated in both

variables. SetObservable attribute set to true to
enable property event listeners.

Data

structure with Data resulting from evaluating the function. Used

x, y, and z
for surface graph. Dependent attribute set to true,
matrices
which means the get.Data method is called to
determine property value when queried and no data
is stored.

Event

When Triggered

UpdateGraph

FofXY property set function (set.FofXY) calls the notify method

when a new value is specified for the MATLAB expression on an
object of this class.

Method

Purpose

fcneval

Class constructor. Inputs are function handle and two-element

vector specifying the limits over which to evaluate the function.

set.FofXY

FofXY property set function. Called whenever property value is set,

including during object construction.

set.Lm

Lm property set function. Used to test for valid limits.

get.Data

Data property get function. This method calculates the values for
the Data property whenever that data is queried (by class members
or externally).

grid

A static method (Static attribute set to true) used in the

calculation of the data.

Summary of fcnview Class

Objects of the fcnview class contain fcneval objects as the source of data for the four
surface graphs created in a function view. fcnview creates the listeners and callback
functions that respond to changes in the data contained in fcneval objects. For a listing
of the class definition, see @fcnview/fcnview.m Class Code on page 11-60
11-47

11

Events Sending and Responding to Messages

Property

Value

Purpose

FcnObject

fcneval object

This object contains the data that is used to

create the function graphs.

HAxes

axes handle

Each instance of a fcnview object stores the

handle of the axes containing its subplot.

HLUpdateGraph event.listener
object for
UpdateGraph event

11-48

Setting the event.listener object's

Enabled property to true enables the
listener; false disables listener.

HLLm

event.listener
Setting the event.listener object's
object for Lm property Enabled property to true enables the
event
listener, false disables listener.

HEnableCm

uimenu handle

Item on context menu used to enable listeners

(used to handle checked behavior)

HDisableCm

uimenu handle

Item on context menu used to disable

listeners (used to manage checked behavior)

HSurface

surface handle

Used by event callbacks to update surface

data.

Method

Purpose

fcnview

Class constructor. Input is fcneval object.

createLisn

Calls addlistener to create listeners for UpdateGraph and

Lm property PostSet listeners.

lims

Sets axes limits to current value of fcneval object's Lm

property. Used by event handlers.

updateSurfaceData

Updates the surface data without creating a new object. Used

by event handlers.

listenUpdateGraph

Callback for UpdateGraph event.

listenLm

Callback for Lm property PostSet event

delete

Delete method for fcnview class.

createViews

Static method that creates an instance of the fcnview class

for each subplot, defines the context menus that enable/
disable listeners, and creates the subplots

Update Graphs Using Events and Listeners

Methods Inherited from Handle Class

Both the fcneval and fcnview classes inherit methods from the handle class. The
following table lists only those inherited methods used in this example.
Handle Class Methods on page 7-13 provides a complete list of methods that are
inherited when you subclass the handle class.
Methods Inherited
from Handle Class

Purpose

addlistener

Register a listener for a specific event and attach listener to eventdefining object.

notify

Trigger an event and notify all registered listeners.

Using the fcneval and fcnview Classes

This sections explains how to use the classes.
Create an instance of the fcneval class to contain the MATLAB expression of a
function of two variables and the range over which you want to evaluate this function
Use the fcnview class static function createViews to visualize the function
Change the MATLAB expression or the limits contained by the fcneval object and
all the fcnview objects respond to the events generated.
You create a fcneval object by calling its constructor with two argumentsan
anonymous function and a two-element, monotonically increasing vector. For example:
feobject = fcneval(@(x,y) x.*exp(-x.^2-y.^2),[-2 2]);

Use the createViews static method to create the graphs of the function. Note that you
must use the class name to call a static function:
fcnview.createViews(feobject);

The createView method generates four views of the function contained in the fcneval
object.

11-49

11

Events Sending and Responding to Messages

Each subplot defines a context menu that can enable and disable the listeners associated
with that graph. For example, if you disable the listeners on subplot 221 (upper left) and
change the MATLAB expression contained by the fcneval object, only the remaining
three subplots update when the UpdateGraph event is triggered:
feobject.FofXY = @(x,y) x.*exp(-x.^.5-y.^.5);

11-50

Update Graphs Using Events and Listeners

Similarly, if you change the limits by assigning a value to the feobject.Lm property,
the feobject triggers a PostSet property event and the listener callbacks update the
graph.
feobject.Lm = [-8 3];

In this figure the listeners are re-enabled via the context menu for subplot 221. Because
the listener callback for the property PostSet event also updates the surface data, all
views are now synchronized

Implement UpdateGraph Event and Listener

The UpdateGraph event occurs when the MATLAB representation of the mathematical
function contained in the fcneval object is changed. The fcnview objects that contain
the surface graphs are listening for this event, so they can update the graphs to represent
the new function.
Define and Trigger UpdateGraph Event
The UpdateGraph event is a class-defined event. The fcneval class names the event
and calls notify when the event occurs.

11-51

11

Events Sending and Responding to Messages

1. A property is assigned a new value.

myfunceval

obj.FofXY = @(x,y)x^2+y^2

Properties
FofXY

2. Setting the property runs a set access method,

which, in turn, executes notify.

function set.FofXY(obj,func)
obj.FofXY = func;
notify(obj,UpdateGraph);
end

Methods
set.FofXY
Events
UpdateGraph

3. The notify method triggers an

event, and a message is broadcast.
4. A listener awaiting the message
executes its callback.

5. The callback function is executed.

UpdateGraph

Listener
Properties
EventName = UpdateGraph
FunctionHandle = @listenUpdateGraph

myfuncview
Methods
listenUpdateGraph

The fcnview class defines a listener for this event. When fcneval triggers the event,
the fcnview listener executes a callback function that performs the follow actions:
Determines if the handle of the surface object stored by the fcnview object is still
valid (that is, does the object still exist)
Updates the surface XData, YData, and ZData by querying the fcneval object's
Data property.
The fcneval class defines an event name in an event block:
11-52

Update Graphs Using Events and Listeners

events
UpdateGraph
end

Determine When to Trigger Event

The fcneval class defines a property set method for the FofXY property. FofXY is
the property that stores the MATLAB expression for the mathematical function. This
expression must be a valid MATLAB expression for a function of two variables.
The set.FofXY method:
Determines the suitability of the expression
If the expression is suitable:
Assigns the expression to the FofXY property
Triggers the UpdateGraph event
If fcneval.isSuitable does not return an MException object, the set.FofXY
method assigns the value to the property and triggers the UpdateGraph event.
function set.FofXY(obj,func)
% Determine if function is suitable to create a surface
me = fcneval.isSuitable(func);
if ~isempty(me)
throw(me)
end
% Assign property value
obj.FofXY = func;
% Trigger UpdateGraph event
notify(obj,'UpdateGraph');
end

Determine Suitability of Expression

The set.FofXY method calls a static method (fcneval.isSuitable) to determine the
suitability of the specified expression. fcneval.isSuitable returns an MException
object if it determines that the expression is unsuitable. fcneval.isSuitable calls the
MException constructor directly to create more useful error messages for the user.
set.FofXY issues the exception using the MException.throw method. Issuing the
exception terminates execution of set.FofXY and prevents the method from making an
assignment to the property or triggering the UpdateGraph event.
11-53

11

Events Sending and Responding to Messages

Here is the fcneval.isSuitable method:

function isOk = isSuitable(funcH)
v = [1 1;1 1];
% Can the expression except 2 numeric inputs
try
funcH(v,v);
catch %#ok<CTCH>
me = MException('DocExample:fcneval',...
['The function ',func2str(funcH),' Is not a suitable F(x,y)']);
isOk = me;
return
end
% Does the expression return non-scalar data
if isscalar(funcH(v,v));
me = MException('DocExample:fcneval',...
['The function ',func2str(funcH),'' Returns a scalar when evaluated']);
isOk = me;
return
end
isOk = [];
end

The fcneval.isSuitable method could provide additional test to ensure that the
expression assigned to the FofXY property meets the criteria required by the class
design.
Other Approaches
The class could have implemented a property set event for the FofXY property and
would, therefore, not need to call notify (see Listen for Changes to Property Values on
page 11-37). Defining a class event provides more flexibility in this case because you can
better control event triggering.
For example, suppose you wanted to update the graph only if the new data is
significantly different. If the new expression produced the same data within some
tolerance, the set.FofXY method could not trigger the event and avoid updating the
graph. However, the method could still set the property to the new value.
Listener and Callback for UpdateGraph Event
The fcnview class creates a listener for the UpdateGraph event using the
addlistener method:
obj.HLUpdateGraph = addlistener(obj.FcnObject,'UpdateGraph',...
@(src,evnt)listenUpdateGraph(obj,src,evnt)); % Add obj to argument list

11-54

Update Graphs Using Events and Listeners

The fcnview object stores a handle to the event.listener object in its

HLUpdateGraph property, which is used to enable/disable the listener by a context menu
(see Enable and Disable Listeners on page 11-58).
The fcnview object (obj) is added to the two default arguments (src, evnt) passed to
the listener callback. Keep in mind, the source of the event (src) is the fcneval object,
but the fcnview object contains the handle of the surface object that is updated by the
callback.
The listenUpdateGraph function is defined as follows:
function listenUpdateGraph(obj,src,evnt)
if ishandle(obj.HSurface) % If surface exists
obj.updateSurfaceData % Update surface data
end
end

The updateSurfaceData function is a class method that updates the surface data when
a different mathematical function is assigned to the fcneval object. Updating a graphics
object data is generally more efficient than creating a new object using the new data:
function updateSurfaceData(obj)
% Get data from fcneval object and set surface data
set(obj.HSurface,...
'XData',obj.FcnObject.Data.X,...
'YData',obj.FcnObject.Data.Y,...
'ZData',obj.FcnObject.Data.Matrix);
end

The PostSet Event Listener

All properties support the predefined PostSet event (See Property-Set and Query
Events on page 11-17 for more information on property events). This example uses
the PostSet event for the fcneval Lm property. This property contains a two-element
vector specifying the range over which the mathematical function is evaluated. Just after
this property is changed (by a statement like obj.Lm = [-3 5];), the fcnview objects
listening for this event update the graph to reflect the new data.

11-55

11

Events Sending and Responding to Messages

1. New limits are assigned.

myfunceval

obj.Lm = [-3 5];

Properties (SetObservable)
Lm

2. The SetObservable attribute of Properties

is set to True, so setting the property
automatically triggers a PostSet event.
Note that methods and events did not have
to be declared in myfunceval.
3. A message is broadcast.

PostSet

4. A listener awaiting the message

executes its callback.

Listener
Properties
EventName = PostSet
FunctionHandle = @listenLm

5. The callback function is executed.

myfuncview
Methods
listenLm

Sequence During the Lm Property Assignment

The fcneval class defines a set function for the Lm property. When a value is assigned to
this property during object construction or property reassignment, the following sequence
occurs:

11-56

An attempt is made to assign argument value to Lm property.

The set.Lm method executes to check whether the value is in appropriate range
if yes, it makes assignment, if no, it generates an error.

If the value of Lm is set successfully, the MATLAB runtime triggers a PostSet

event.

All listeners execute their callbacks, but the order is nondeterministic.

Update Graphs Using Events and Listeners

The PostSet event does not occur until an actual assignment of the property occurs. The
property set function provides an opportunity to deal with potential assignment errors
before the PostSet event occurs.
Enable PostSet Property Event
To create a listener for the PostSet event, you must set the property's SetObservable
attribute to true:
properties (SetObservable = true)
Lm = [-2*pi 2*pi]; % specifies default value
end

The MATLAB runtime automatically triggers the event so it is not necessary to call
notify.
Specify Property Attributes on page 8-6 provides a list of all property attributes.
Listener and Callback for PostSet Event
The fcnview class creates a listener for the PostSet event using the addlistener
method:
obj.HLLm = addlistener(obj.FcnObject,'Lm','PostSet',...
@(src,evnt)listenLm(obj,src,evnt)); % Add obj to argument list

The fcnview object stores a handle to the event.listener object in its HLLm property,
which is used to enable/disable the listener by a context menu (see Enable and Disable
Listeners on page 11-58).
The fcnview object (obj) is added to the two default arguments (src, evnt) passed to
the listener callback. Keep in mind, the source of the event (src) is the fcneval object,
but the fcnview object contains the handle of the surface object that is updated by the
callback.
The callback sets the axes limits and updates the surface data because changing the
limits causes the mathematical function to be evaluated over a different range:
function listenLm(obj,src,evnt)
if ishandle(obj.HAxes) % If there is an axes
lims(obj); % Update its limits
if ishandle(obj.HSurface) % If there is a surface
obj.updateSurfaceData % Update its data
end
end

11-57

11

Events Sending and Responding to Messages

end

Enable and Disable Listeners

Each fcnview object stores the handle of the listener objects it creates so that the
listeners can be enabled or disabled via a context menu after the graphs are created. All
listeners are instances of the event.listener class, which defines a property called
Enabled. By default, this property has a value of true, which enables the listener. If you
set this property to false, the listener still exists, but is disabled. This example creates
a context menu active on the axes of each graph that provides a way to change the value
of the Enabled property.
Context Menu Callback
There are two callbacks used by the context menu corresponding to the two items on the
menu:
Listen Sets the Enabled property for both the UpdateGraph and PostSet
listeners to true and adds a check mark next to the Listen menu item.
Don't Listen Sets the Enabled property for both the UpdateGraph and PostSet
listeners to false and adds a check mark next to the Don't Listen menu item.
Both callbacks include the fcnview object as an argument (in addition to the required
source and event data arguments) to provide access to the handle of the listener objects.
The enableLisn function is called when the user selects Listen from the context menu.
function enableLisn(obj,src,evnt)
obj.HLUpdateGraph.Enabled = true; % Enable listener
obj.HLLm.Enabled = true; % Enable listener
set(obj.HEnableCm,'Checked','on') % Check Listen
set(obj.HDisableCm,'Checked','off') % Uncheck Don't Listen
end

The disableLisn function is called when the user selects Don't Listen from the
context menu.
function disableLisn(obj,src,evnt)
obj.HLUpdateGraph.Enabled = false; % Disable listener
obj.HLLm.Enabled = false; % Disable listener
set(obj.HEnableCm,'Checked','off') % Unheck Listen
set(obj.HDisableCm,'Checked','on') % Check Don't Listen
end

11-58

Update Graphs Using Events and Listeners

@fcneval/fcneval.m Class Code

classdef fcneval < handle
properties
FofXY
end
properties (SetObservable = true)
Lm = [-2*pi 2*pi];
end % properties SetObservable = true
properties (Dependent = true)
Data
end
events
UpdateGraph
end
methods
function obj = fcneval(fcn_handle,limits)
if nargin > 0
obj.FofXY = fcn_handle;
obj.Lm = limits;

% Constructor returns object

% Assign property values

end
end
function set.FofXY(obj,func)
me = fcneval.isSuitable(func);
if ~isempty(me)
throw(me)
end
obj.FofXY = func;
notify(obj,'UpdateGraph');
end
function set.Lm(obj,lim)
if ~(lim(1) < lim(2))
error('Limits must be monotonically increasing')
else
obj.Lm = lim;
end
end

11-59

11

Events Sending and Responding to Messages

function data = get.Data(obj)

[x,y] = fcneval.grid(obj.Lm);
matrix = obj.FofXY(x,y);
data.X = x;
data.Y = y;
data.Matrix = real(matrix);
end
end % methods
methods (Static = true)
function [x,y] = grid(lim)
inc = (lim(2)-lim(1))/20;
[x,y] = meshgrid(lim(1):inc:lim(2));
end % grid
function isOk = isSuitable(funcH)
v = [1 1;1 1];
try
funcH(v,v);
catch %#ok<CTCH>
me = MException('DocExample:fcneval',...
['The function ',func2str(funcH),' Is not a suitable F(x,y)']);
isOk = me;
return
end
if isscalar(funcH(v,v));
me = MException('DocExample:fcneval',...
['The function ',func2str(funcH),' Returns a scalar when evaluated']);
isOk = me;
return
end
isOk = [];
end
end
end

@fcnview/fcnview.m Class Code

classdef fcnview < handle

11-60

Update Graphs Using Events and Listeners

properties
FcnObject
HAxes
HLUpdateGraph
HLLm
HEnableCm
HDisableCm
HSurface
end

%
%
%
%
%
%
%

fcneval object
subplot axes handle
UpdateGraph listener handle
Lm property PostSet listener handle
"Listen" context menu handle
"Don't Listen" context menu handle
Surface object handle

methods
function obj = fcnview(fcnobj)
if nargin > 0
obj.FcnObject = fcnobj;
obj.createLisn;
end
end
function createLisn(obj)
obj.HLUpdateGraph = addlistener(obj.FcnObject,'UpdateGraph',...
@(src,evnt)listenUpdateGraph(obj,src,evnt));
obj.HLLm = addlistener(obj.FcnObject,'Lm','PostSet',...
@(src,evnt)listenLm(obj,src,evnt));
end
function lims(obj)
lmts = obj.FcnObject.Lm;
set(obj.HAxes,'XLim',lmts);
set(obj.HAxes,'Ylim',lmts);
end
function updateSurfaceData(obj)
data = obj.FcnObject.Data;
set(obj.HSurface,...
'XData',data.X,...
'YData',data.Y,...
'ZData',data.Matrix);
end
function listenUpdateGraph(obj,~,~)
if ishandle(obj.HSurface)
obj.updateSurfaceData
end
end

11-61

11

Events Sending and Responding to Messages

function listenLm(obj,~,~)
if ishandle(obj.HAxes)
lims(obj);
if ishandle(obj.HSurface)
obj.updateSurfaceData
end
end
end
function delete(obj)
if ishandle(obj.HAxes)
delete(obj.HAxes);
else
return
end
end
end
methods (Static)
createViews(a)
end
end

@fcnview/createViews
function createViews(fcnevalobj)
p = pi; deg = 180/p;
hfig = figure('Visible','off',...
'Toolbar','none');
for k=4:-1:1
fcnviewobj(k) = fcnview(fcnevalobj);
axh = subplot(2,2,k);
fcnviewobj(k).HAxes = axh;
hcm(k) = uicontextmenu;
set(axh,'Parent',hfig,...
'FontSize',8,...
'UIContextMenu',hcm(k))
fcnviewobj(k).HEnableCm = uimenu(hcm(k),...
'Label','Listen',...
'Checked','on',...
'Callback',@(src,evnt)enableLisn(fcnviewobj(k),src,evnt));
fcnviewobj(k).HDisableCm = uimenu(hcm(k),...
'Label','Don''t Listen',...

11-62

Update Graphs Using Events and Listeners

'Checked','off',...
'Callback',@(src,evnt)disableLisn(fcnviewobj(k),src,evnt));
az = p/k*deg;
view(axh,az,30)
title(axh,['View: ',num2str(az),' 30'])
fcnviewobj(k).lims;
surfLight(fcnviewobj(k),axh)
end
set(hfig,'Visible','on')
end
function surfLight(obj,axh)
obj.HSurface = surface(obj.FcnObject.Data.X,...
obj.FcnObject.Data.Y,...
obj.FcnObject.Data.Matrix,...
'FaceColor',[.8 .8 0],'EdgeColor',[.3 .3 .2],...
'FaceLighting','phong',...
'FaceAlpha',.3,...
'HitTest','off',...
'Parent',axh);
lims(obj)
camlight left; material shiny; grid off
colormap copper
end
function enableLisn(obj,~,~)
obj.HLUpdateGraph.Enabled = true;
obj.HLLm.Enabled = true;
set(obj.HEnableCm,'Checked','on')
set(obj.HDisableCm,'Checked','off')
end
function disableLisn(obj,~,~)
obj.HLUpdateGraph.Enabled = false;
obj.HLLm.Enabled = false;
set(obj.HEnableCm,'Checked','off')
set(obj.HDisableCm,'Checked','on')
end

11-63

12
How to Build on Other Classes
Hierarchies of Classes Concepts on page 12-2
Create Subclasses Syntax and Techniques on page 12-7
Sequence of Constructor Calls in Class Hierarchy on page 12-13
Modify Superclass Methods on page 12-15
Modify Superclass Properties on page 12-18
Subclass Multiple Classes on page 12-20
Specify Allowed Subclasses on page 12-22
Control Access to Class Members on page 12-25
Property Access List on page 12-33
Method Access List on page 12-34
Event Access List on page 12-35
Support Both Handle and Value Subclasses on page 12-36
Subclasses of MATLAB Built-In Types on page 12-44
Behavior of Inherited Built-In Methods on page 12-48
Subclasses of Built-In Types Without Properties on page 12-53
Subclasses of Built-In Types with Properties on page 12-61
Use of size and numel with Classes on page 12-69
Class to Represent Hardware on page 12-75
Determine Array Class on page 12-78
Abstract Classes on page 12-82
Define an Interface Superclass on page 12-87

12

How to Build on Other Classes

Hierarchies of Classes Concepts

In this section...
Classification on page 12-2
Develop the Abstraction on page 12-3
Design of Class Hierarchies on page 12-4
Super and Subclass Behavior on page 12-4
Implementation and Interface Inheritance on page 12-5

Classification
Organizing classes into hierarchies facilitates the reuse of code and the reuse of solutions
to design problems that have already been solved. You can think of class hierarchies as
sets supersets (referred to as superclasses or base classes), and subsets (referred to as
subclasses or derived classes). For example, the following picture shows how you could
represent an employee database with classes.

12-2

Hierarchies of Classes Concepts

Base class

Sales People and Engineers are

subsets of Employees

Employees

Employees

Sales
People

Properties
Name
Address
Department

Engineers
Derived classes
Test
Engineers

SalesPerson
(is an Employees)
Properties
Commission
Region

Engineer
(is an Employees)
Properties
Products
Team

TestEngineer
(is an Engineer)
Properties
TestStage

At the root of the hierarchy is the Employees class. It contains data and operations that
apply to the set of all employees. Contained in the set of employees are subsets whose
members, while still employees, are also members of sets that more specifically define
the type of employee. Subclasses like TestEngineer are examples of these subsets.

Develop the Abstraction

Classes are representations of real world concepts or things. When designing a class,
form an abstraction of what the class represents. Consider an abstraction of an employee
and what are the essential aspects of employees for the intended use of the class. Name,
address, and department can be what all employees have in common.
12-3

12

How to Build on Other Classes

When designing classes, your abstraction should contain only those elements that are
necessary. For example, the employee hair color and shoe size certainly characterize the
employee, but are probably not relevant to the design of this employee class. Their sales
region is relevant only to some employee so this characteristic belongs in a subclass.

Design of Class Hierarchies

As you design a system of classes, put common data and functionality in a superclass,
which you then use to derive subclasses. The subclasses inherit the data and
functionality of the superclass and define only aspects that are unique to their particular
purposes. This approach provides advantages:
Avoid duplicating code that is common to all classes.
Add or change subclasses at any time without modifying the superclass or affecting
other subclasses.
If the superclass changes (for example, all employees are assigned a number), then
subclass automatically get these changes.

Super and Subclass Behavior

Subclass objects behave like objects of the superclass because they are specializations
of the superclass. This fact facilitates the development of related classes that behave
similarly, but are implemented differently.
A Subclass Object Is A Superclass Object
You can usually describe the relationship between an object of a subclass and an object of
its superclass with a statement like:
The subclass is a superclass. For example: An Engineer is an Employee.
This relationship implies that objects belonging to a subclass have the same properties,
methods, and events as the superclass. Subclass objects also have any new features
defined by the subclass. Test this relationship with the isa function.
Treat Subclass Objects like Superclass Objects
You can pass a subclass object to a superclass method, but you can access only those
properties that the superclass defines. This behavior enables you to modify the
subclasses without affecting the superclass.
12-4

Hierarchies of Classes Concepts

Two points about super and subclass behavior to keep in mind are:
Methods defined in the superclass can operate on subclass objects.
Methods defined in the subclass cannot operate on superclass objects.
Therefore, you can treat an Engineer object like any other Employees object, but an
Employee object cannot pass for an Engineer object.
Limitations to Object Substitution
MATLAB determines the class of an object based on its most specific class. Therefore, an
Engineer object is of class Engineer, while it is also an Employees object, as using
the isa function reveals.
Generally, MATLAB does not allow you to create arrays containing a mix of superclass
and subclass objects because an array can be of only one class. If you attempt to
concatenate objects of different classes, MATLAB looks for a converter method defined by
the less dominant class
See Concatenating Objects of Different Classes on page 10-15 for more information.
See matlab.mixin.Heterogeneous for information on defining heterogeneous class
hierarchies.
See Object Converters on page 17-11 for information on defining converter methods.

Implementation and Interface Inheritance

MATLAB classes support both the inheritance of implemented methods from a
superclass and the inheritance of interfaces defined by abstract methods in the
superclass.
Implementation inheritance enables code reuse by subclasses. For example, an
employee class can have a submitStatus method that all employee subclasses can
use. Subclasses can extend an inherited method to provide specialized functionality,
while reusing the common aspects. See Modify Superclass Methods on page 12-15
for more information on this process.
Interface inheritance is useful in these cases:
You want a group of classes to provide a common interface.
12-5

12

How to Build on Other Classes

Subclasses create specialized implementations of methods and properties.

Create an interface using an abstract class as the superclass. This class defines the
methods and properties that you must implement in the subclasses, but does not provide
an implementation.
The subclasses must provide their own implementation of the abstract members of the
superclass. To create an interface, define methods and properties as abstract using their
Abstract attribute. See Abstract Classes on page 12-82 for more information and
an example.

Related Examples

12-6

Create Subclasses Syntax and Techniques on page 12-7

Create Subclasses Syntax and Techniques

Create Subclasses Syntax and Techniques

In this section...
Subclass Definition on page 12-7
Initialize Superclasses from Subclasses on page 12-7
Call Superclass Constructor Explicitly on page 12-9
Constructor Arguments and Object Initialization on page 12-9
Call Only Direct Superclass from Constructor on page 12-10
Subclass Alias for Existing Class on page 12-11

Subclass Definition
To define a class that is a subclass of another class, add the superclass to the classdef
line after a < character:
classdef ClassName < SuperClass

When inheriting from multiple classes, use the & character to indicate the combination of
the superclasses:
classdef ClassName < SuperClass1 & SuperClass2

See Class Member Compatibility on page 12-20 for more information on deriving
from multiple superclasses.
Class Attributes
Subclasses do not inherit superclass attributes.

Initialize Superclasses from Subclasses

To initialize the object for each superclass within the subclass constructor, use the
following syntax:
obj@SuperClass1(args,...);
...
obj@SuperclassN(args,...);
12-7

12

How to Build on Other Classes

Where obj is the output of the constructor, SuperClass... is the name of a superclass,
and args are any arguments required by the respective superclass constructor.
For example, the following segment of a class definition shows that a class called stock
that is a subclass of a class called asset.
classdef stock < asset
methods
function s = stock(asset_args,...)
if nargin == 0
... % Assign values to asset_args
end
% Call asset constructor
s@asset(asset_args);
...
end
end
end

Constructing Subclasses on page 9-23 provides more information on creating subclass

constructor methods.
Reference Superclasses Contained in Packages
If a superclass is contained in a package, include the package name. For example:
classdef stock < financial.asset
methods
function s = stock(asset_args,...)
if nargin == 0
...
end
% Call asset constructor
s@financial.asset(asset_args);
...
end
end
end

Initialize Objects Using Multiple Superclasses

To derive a class from multiple superclasses, initialize the subclass object with calls to
each superclass constructor:
classdef stock < financial.asset & trust.member

12-8

Create Subclasses Syntax and Techniques

methods
function s = stock(asset_args,member_args,...)
if nargin == 0
...
end
% Call asset and member class constructors
s@financial.asset(asset_args)
s@trust.member(member_args)
...
end
end
end

Call Superclass Constructor Explicitly

Explicitly calling each superclass constructor enables you to:
Pass arguments to superclass constructors
Control the order in which the superclass constructors are called
If you do not explicitly call the superclass constructors from the subclass constructor,
MATLAB implicitly calls these constructors with no arguments. In this case, the
superclass constructors must support no argument syntax.
In the case of multiple superclasses, MATLAB does not guarantee any specific calling
sequence. If the order in which MATLAB calls the superclass constructors is important,
Call the superclass constructors explicitly from the subclass constructor.

Constructor Arguments and Object Initialization

You cannot conditionalize the object initialization calls to the superclass. Locate calls to
superclass constructors outside any conditional code blocks.
Ensure that your class constructor supports the zero arguments syntax. To satisfy the
need for a zero-argument syntax, assign appropriate values to input argument variables
before constructing the object.
For example, the stock class constructor supports the no argument case with the if
statement, but initializes the object for the superclass outside of the if code block.
classdef stock < financial.asset
properties

12-9

12

How to Build on Other Classes

SharePrice
end
methods
function s = stock(name,pps)
% Support no input argument case
if nargin == 0
name = '';
pps = 0;
end
% Call superclass constructor
s@financial.asset(name)
% Assign property value
s.SharePrice = pps;
end
end
end

Call Only Direct Superclass from Constructor

You can call only a direct superclass constructor from a subclass constructor. For
example, suppose class B derives from class A and class C derives from class B. The
constructor for class C cannot call the constructor for class A to initialize properties. Class
B must initialize class A properties.
The following implementations of classes A, B, and C show how to design this relationship
in each class.
Class A defines properties x and y, but assigns a value only to x:
classdef A
properties
x
y
end
methods
function obj = A(x)
...
obj.x = x;
end
end
end

Class B inherits properties x and y from class A. The class B constructor calls the class A
constructor to initialize x and then assigns a value to y.
12-10

Create Subclasses Syntax and Techniques

classdef B < A
methods
function obj = B(x,y)
...
obj@A(x);
obj.y = y;
end
end
end

Class C accepts values for the properties x and y, and passes these values to the class B
constructor, which in turn calls the class A constructor:
classdef C < B
methods
function obj = C(x,y)
...
obj@B(x,y);
end
end
end

Subclass Alias for Existing Class

You can refer to a class using a different name by creating an alias for that class. This
technique is like the C++ typedef concept. To create an alias, create an empty subclass:
classdef NewClassName < OldClassName
end

The old class constructor must be callable with zero input arguments.
This technique is useful when reloading objects that you saved using the old class name.
However, the class of the object reflects the new name. That is, this code returns the new
class name.
class(obj)

Old Class Constructor Requires Arguments

If the old class constructor requires arguments, add a constructor to the new class:
classdef NewClass < OldClass
methods

12-11

12

How to Build on Other Classes

function obj = NewClass(x,y)

obj@OldClass(x,y);
end
end
end

Related Examples

12-12

No Input Argument Constructor Requirement on page 9-22

Sequence of Constructor Calls in Class Hierarchy

Sequence of Constructor Calls in Class Hierarchy

MATLAB does not guarantee the sequence in which superclass constructors are called
when constructing a subclass object. However, you can control the order in which class
constructors are called by calling superclass constructors explicitly from the subclass
constructor.
If you explicitly call a superclass constructor from the most specific subclass constructor,
then MATLAB calls the most specific subclass constructor first. If you do not make an
explicit call to a superclass constructor from the subclass constructor, MATLAB makes
the implicit call before accessing the object.
Suppose that you have a hierarchy of classes in which ClassC derives from ClassB,
which derives from ClassA. The constructor for a subclass can call only direct
superclasses. Therefore, each class constructor can call the direct superclass constructor:

In cases of multiple inheritance, the subclass constructor can call each superclass
constructor. To ensure that a specific superclass constructor calling sequence is followed,
your most specific subclass constructor must explicitly call ALL superclass constructors:

12-13

12

How to Build on Other Classes

If you do not explicitly call all direct superclass constructors, MATLAB does not
guarantee the order in which the superclass constructors are called.

Related Examples

12-14

Class Constructor Methods on page 9-20

Modify Superclass Methods

Modify Superclass Methods

In this section...
When to Modify Superclass Methods on page 12-15
Extend Superclass Methods on page 12-15
Complete Superclass Methods in Subclass on page 12-16
How to Redefine Superclass Methods on page 12-17

When to Modify Superclass Methods

An important concept in class design is that a subclass object is also an object of its
superclass. Therefore, you can pass a subclass object to a superclass method and have
the method execute properly. At the same time, you can apply special processing to the
unique aspects of the subclass. Some useful techniques include:
Calling a superclass method from within a subclass method
Redefining in the subclass protected methods called from within a public superclass
method
Defining the same named methods in both super and subclass, but using different
implementations

Extend Superclass Methods

Subclass methods can call superclass methods of the same name. This fact enables you
to extend a superclass method in a subclass without completely redefining the superclass
method. For example, suppose that both superclass and subclass defines a method called
foo. The method names are the same so the subclass method can call the superclass
method. However, the subclass method can also perform other steps before and after the
call to the superclass method. It can operate on the specialized parts to the subclass that
are not part of the superclass.
For example, this subclass defines a foo method, which calls the superclass foo method
classdef sub < super
methods
function foo(obj)
% preprocessing steps
foo@super(obj);

12-15

12

How to Build on Other Classes

% postprocessing steps
end
end
end

Complete Superclass Methods in Subclass

A superclass method can define a process that executes in a series of steps using a
protected method for each step (Access attribute set to protected). Then, subclasses
can create their own versions of the protected methods that implement the individual
steps in the process.
Implement this technique as shown here:
classdef super
methods
function foo(obj)
step1(obj)
step2(obj)
step3(obj)
end
end
methods (Access = protected)
function step1(obj)
% superclass version
end
...
end
end

The subclass does not reimplement the foo method, it reimplements only the methods
that carry out the series of steps (step1(obj), step2(obj), step3(obj)). That is, the
subclass can specialize the actions taken by each step, but does not control the order of
the steps in the process. When you pass a subclass object to the superclass foo method,
MATLAB calls the subclass step methods because of the dispatching rules.
classdef sub < super
...
methods (Access = protected)
function step1(obj)
% subclass version
end
...

12-16

Modify Superclass Methods

end
end

How to Redefine Superclass Methods

You can completely redefine a superclass method. In this case, both the superclass and
the subclass would define the same named method.

Related Examples

Invoking Superclass Methods in Subclass Methods on page 9-18

12-17

12

How to Build on Other Classes

Modify Superclass Properties

In this section...
Allowed Superclass Property Modification on page 12-18
Private Local Property Takes Precedence in Method on page 12-18

Allowed Superclass Property Modification

There are two separate conditions under which you can redefine superclass properties:
The value of the superclass property Abstract attribute is true
The values of the superclass property SetAccess and GetAccess attributes are
private
In the first case, the superclass is just requesting that you define a concrete version of
this property to ensure a consistent interface. In the second case, only the superclass can
access the private property, so the subclass is free to reimplement it in any way.

Private Local Property Takes Precedence in Method

When superclass and subclass define a property with the same name, methods that refer
to this property name access the property of the class defining the method.
For example, a subclass property has the same name as a superclass private property,
and a method of the superclass references the property name. MATLAB accesses the
property defined by the superclass. Given the following classes, Super and Sub:
classdef Super
properties (Access = private)
Prop = 2;
end
methods
function p = superMethod(obj)
p = obj.Prop;
end
end
end
classdef Sub < Super
properties

12-18

Modify Superclass Properties

Prop = 1;
end
end

If you create an instance of the subclass and use it to call the superclass method,
MATLAB access the private property of the superclass:
subObj = Sub
subObj =
Sub with properties:
Prop: 1
subObj.superMethod
ans =
2

More About

Property Attributes on page 8-7

12-19

12

How to Build on Other Classes

Subclass Multiple Classes

In this section...
Class Member Compatibility on page 12-20
Multiple Inheritance on page 12-21

Class Member Compatibility

When you create a subclass derived from multiple classes, the subclass inherits the
properties, methods, and events defined by all specified superclasses. If more than one
superclass defines a property, method, or event having the same name, there must be an
unambiguous resolution to the multiple definitions. You cannot derive a subclass from
any two or more classes that define incompatible class members.
There are various situations where you can resolve name and definition conflicts, as
described in the following sections.
Property Conflicts
If two or more superclasses define a property with the same name, then at least one of
the following must be true:
All, or all but one of the properties must have their SetAccess and GetAccess
attributes set to private
The properties have the same definition in all superclasses (for example, when all
superclasses inherited the property from a common base class)
Method Conflicts
If two or more superclasses define methods with the same name, then at least one of the
following must be true:
The method Access attribute is private so only the defining superclass can access
the method.
The method has the same definition in all subclasses. This situation can occur
when all superclasses inherit the method from a common base class and none of the
superclasses override the inherited definition.
The subclass redefines the method to disambiguate the multiple definitions across
all superclasses. Therefore, the superclass methods must not have their Sealed
attribute set to true.
12-20

Subclass Multiple Classes

Only one superclass defines the method as Sealed, in which case, the subclass adopts
the sealed method definition.
The superclasses define the methods as Abstract and rely on the subclass to define
the method.
Event Conflicts
If two or more superclasses define events with the same name, then at least one of the
following must be true:
The event ListenAccess and NotifyAccess attributes must be private.
The event has the same definition in all superclasses (for example, when all
superclasses inherited the event from a common base class)

Multiple Inheritance
Resolving the potential conflicts involved when defining a subclass from multiple classes
often reduces the value of this approach. For example, problems can arise when you
enhance superclasses in future versions and introduce new conflicts.
Reduce potential problems by implementing only one unrestricted superclass. In all other
superclasses, all methods are
Abstract
Defined by a subclass or inherited from the unrestricted superclass
In general, when using multiple inheritance, ensure that all superclasses remain free of
conflicts in definition.

Related Examples

Create Subclasses Syntax and Techniques on page 12-7

Support Both Handle and Value Subclasses on page 12-36

12-21

12

How to Build on Other Classes

Specify Allowed Subclasses

In this section...
Basic Knowledge on page 12-22
Why Control Allowed Subclasses on page 12-22
Specify Allowed Subclasses on page 12-22
Define Sealed Hierarchy of Classes on page 12-24

Basic Knowledge
The material presented in this section builds on an understanding of the following
information:
Class Metadata on page 16-2
Attribute Specification on page 5-22

Why Control Allowed Subclasses

A class definition can specify a list of classes that it allows to subclass the class. Classes
not in the list cannot subclass the class. To specify the allowed subclasses, use the
AllowedSubclasses class attribute.
The AllowedSubclasses attribute provides a design point between Sealed classes,
which do not allow subclassing, and the default behavior, which does not restrict
subclassing.
By controlling the allowed subclasses, you can create a sealed hierarchy of classes. That
is, a system of classes that enables a specific set of classes to derive from specific base
classes, but that does not allow unrestricted subclassing.
See Define Sealed Hierarchy of Classes on page 12-24 for more about this
technique.

Specify Allowed Subclasses

Note: Specify attribute values explicitly, not as values returned from functions or other
MATLAB expressions.
12-22

Specify Allowed Subclasses

Specify a list of one or more allowed subclasses in the classdef statement by assigning
meta.class objects to the AllowedSubclasses attribute. Create the meta.class
object referencing a specific class using the ? operator and the class name:
classdef (AllowedSubclasses = ?ClassName) MySuperClass
...
end

Use a cell array of meta.class objects to define more than one allowed subclass:
classdef (AllowedSubclasses = {?ClassName1,?ClassName2,...?ClassNameN}) MySuperClass
...
end

Always use the fully qualified class name when referencing the class name:
classdef (AllowedSubclasses = ?Package.SubPackage.ClassName1) MySuperClass
...
end

Assigning an empty cell array to the AllowedSubclasses attribute is effectively the

same as defining a Sealed class.
classdef (AllowedSubclasses = {}) MySuperClass
...
end

Note: Use only the ? operator and the class name to generate meta.class objects.
Values assigned to the AllowedSubclasses attribute cannot contain any other
MATLAB expressions, including functions that return either meta.class objects or cell
arrays of meta.class objects.
Result of Declaring Allowed Subclasses
Including a class in the list of AllowedSubclasses does not define that class as a
subclass or require you to define the class as a subclass. It just allows the referenced
class to be defined as a subclass.
Declaring a class as an allowed subclass does not affect whether this class can itself be
subclassed.
A class definition can contain assignments to the AllowedSubclasses attribute that
reference classes that are not currently defined or available on the MATLAB path.
12-23

12

How to Build on Other Classes

However, any referenced subclass that MATLAB cannot find when loading the class is
effectively removed from the list without causing an error or warning.
Note: If MATLAB does not find any of the classes in the allowed classes list, the class is
effectively Sealed. A sealed class is equivalent to AllowedSubclasses = {}.

Define Sealed Hierarchy of Classes

The AllowedSubclasses attribute enables you to define a sealed class hierarchy by
sealing the allowed subclasses:
classdef (AllowedSubclasses = {?SubClass1,?SubClass2}) SuperClass
...
end

Define the allowed subclasses as Sealed:

classdef (Sealed) SubClass1
...
end
classdef (Sealed) SubClass2
...
end

Sealed class hierarchies enable you to use the level of abstraction that your design
requires while maintaining a closed system of classes.

Related Examples

12-24

Support Both Handle and Value Subclasses on page 12-36

Control Access to Class Members

Control Access to Class Members

In this section...
Basic Knowledge on page 12-25
Applications for Access Control Lists on page 12-26
Specify Access to Class Members on page 12-26
Properties with Access Lists on page 12-27
Methods with Access Lists on page 12-28
Abstract Methods with Access Lists on page 12-32

Basic Knowledge
The material presented in this section builds on an understanding of the following
information:
Related Topics
Class Metadata on page 16-2
Attribute Specification on page 5-22
Terminology and Concepts
Class members Properties, methods, and events defined by a class
Defining class The class defining the class member for which access is being
specified
Get access Permission to read the value of a property; controlled by the property
GetAccess attribute
Set access Permission to assign a value to a property; controlled by the property
SetAccess attribute
Method access Determines what other methods and functions can call the class
method; controlled by the method Access attribute
Listen access Permission to define listeners; controlled by the event ListenAccess
attribute
Notify access Permission to trigger events; controlled by the event NotifyAccess
attribute
12-25

12

How to Build on Other Classes

Possible Values for Access to Class Members

The following class member attributes can contain a list of classes:
Properties Access, GetAccess, and SetAccess. For a list of all property
attributes, see Property Attributes on page 8-7 .
Methods Access. For a list of all method attributes, see Method Attributes on
page 9-5 .
Events ListenAccess and NotifyAccess. For a list of all event attributes, see
Event Attributes on page 11-19.
These attributes accept the following possible values:
public Unrestricted access
protected Access by defining class and its subclasses
private Access by defining class only
Access list A list of one or more classes. Only the defining class and the classes in
the list have access to the class members to which the attribute applies. If you specify
a list of classes, MATLAB does not allow access by any other class (that is, access is
private, except for the listed classes).

Applications for Access Control Lists

Access control lists enable you to control access to specific class properties, methods, and
events. Access control lists specify a list of classes to which you grant access to these class
members.
This technique provides greater flexibility and control in the design of a system of
classes. For example, use access control lists to define separate classes, but not allow
access to class members from outside the class system.

Specify Access to Class Members

Specify the classes that are allowed to access a particular class member in the member
access attribute statement. For example:
methods (Access = {?ClassName1,?ClassName2,...})

Use the class meta.class object to refer to classes in the access list. To specify more
than one class, use a cell array of meta.class objects. Use the package name when
referring to classes that are in packages.
12-26

Control Access to Class Members

Note: Specify the meta.class objects explicitly (created with the ? operator), not as
values returned by functions or other MATLAB expressions.
How MATLAB Interprets Attribute Values
Granting access to a list of classes restricts access to only:
The defining class
The classes in the list
Subclasses of the classes in the list
Including the defining class in the access list gives all subclasses of the defining class
access.
MATLAB resolves references to classes in the access list only when the class is
loaded. If MATLAB cannot find a class that is included in the access list, that class is
effectively removed from access.
MATLAB replaces unresolved meta.class entries in the list with empty
meta.class objects.
An empty access list (that is, an empty cell array) is equivalent to private access.
Specify Metaclass Objects
Generate the meta.class objects using only the ? operator and the class name. Values
assigned to the attributes cannot contain any other MATLAB expressions, including
functions that return allowed attribute values:
meta.class objects
Cell arrays of meta.class objects
The values public, protected, or private
Specify these values explicitly, as shown in the example code in this section.

Properties with Access Lists

These sample classes show the behavior of a property that grants read access
(GetAccess) to a class. The GrantAccess class gives GetAccess to the NeedAccess
class for the Prop1 property:
classdef GrantAccess

12-27

12

How to Build on Other Classes

properties (GetAccess = ?NeedAccess)

Prop1 = 7;
end
end

The NeedAccess class defines a method that uses the value of the GrantAccess Prop1
value. The dispObj method is defined as a Static method, however, it could be an
ordinary method.
classdef NeedAccess
methods (Static)
function dispObj(GrantAccessObj)
disp(['Prop1 is: ',num2str(GrantAccessObj.Prop1)])
end
end
end

Get access to Prop1 is private so MATLAB returns an error if you try to access the
property from outside the class definition. For example, from the command line:
a = GrantAccess;
a.Prop1
Getting the 'Prop1' property of the 'GrantAccess' class is not allowed.

However, MATLAB allows access to Prop1 by the NeedAccess class:

NeedAccess.dispObj(a)
Prop1 is: 7

Methods with Access Lists

Classes granted access to a method can:
Call the method using an instance of the defining class.
Define their own method with the same name (if not a subclass).
Override the method in a subclass only if the superclass defining the method includes
itself or the subclass in the access list.
These sample classes show the behavior of methods called from methods of other classes
that are in the access list. The class AcListSuper gives the AcListNonSub class access
to itsm1 method:
12-28

Control Access to Class Members

classdef AcListSuper
methods (Access = {?AcListNonSub})
function obj = m1(obj)
disp ('Method m1 called')
end
end
end

Because AcListNonSub is in the access list of m1, its methods can call m1 using an
instance of AcListSuper:
classdef AcListNonSub
methods
function obj = nonSub1(obj,AcListSuper_Obj)
% Call m1 on AcListSuper class
AcListSuper_Obj.m1;
end
function obj = m1(obj)
% Define a method named m1
disp(['Method m1 defined by ',class(obj)])
end
end
end

Create objects of both classes:

a = AcListSuper;
b = AcListNonSub;

Call the AcListSuper m1 method using an AcListNonSub method:

b.nonSub1(a);
Method m1 called

Call the AcListNonSub m1 method:

b.m1;
Method m1 defined by AcListNonSub

Subclasses Without Access

Including the defining class in the access list for a method grants access to all subclasses
derived from that class. When you derive from a class that has a method with an access
list and that list does not include the defining class:
12-29

12

How to Build on Other Classes

Subclass methods cannot call the superclass method because it is effectively private.
Subclasses cannot override the superclass method.
Subclass methods can call the superclass method indirectly using an instance of a
class that is in the access list.
Methods of classes that are in the superclass method access list, but that are not
subclasses, can call the superclass method. To call the superclass method, use an
object of a subclass that is not in the superclass method access list.
For example, AcListSub is a subclass of AcListSuper. The AcListSuper class defines
an access list for method m1. However, this list does not include AcListSuper, which
would implicitly include all subclasses of AcListSuper in the access list:
classdef AcListSub < AcListSuper
methods
function obj = sub1(obj,AcListSuper_Obj)
% Access m1 via superclass object (NOT ALLOWED)
AcListSuper_Obj.m1;
end
function obj = sub2(obj,AcListNonSub_Obj,AcListSuper_obj)
% Access m1 via object that is in access list (is allowed)
AcListNonSub_Obj.nonSub1(AcListSuper_Obj);
end
end
end

Attempting to call the superclass m1 method results in an error because subclasses are
not in the access list for the method:
a = AcListSuper;
b = AcListNonSub;
c = AcListSub;
c.sub1(a);
Error using AcListSuper/m1
Cannot access method 'm1' in class 'AcListSuper'.
Error in AcListSub/sub1 (line 4)
AcListSuper_Obj.m1;

The AcListSub sub2 method can call a method of a class that is on the access list for m1,
and that method (nonSub1) does have access to the superclass m1 method:
c.sub2(b,a);
Method m1 called

12-30

Control Access to Class Members

When subclasses are not included in the access list for a method, those subclasses cannot
define a method with the same name. This behavior is not the same as cases in which the
method Access is explicitly declared as private.
For example, adding the following method to the AcListSub class definition produces an
error when you attempt to instantiate the class.
methods (Access = {?AcListNonSub})
function obj = m1(obj)
disp('AcListSub m1 method')
end
end

If you attempt to instantiate the class, MATLAB returns an error:

c = AcListSub;

Error using AcListSub

Class 'AcListSub' is not allowed to override the method 'm1' because neither it nor its
superclasses have been granted access to the method by class 'AcListSuper'.

The AcListNonSub class, which is in the m1 method access list, can define a method that
calls the m1 method using an instance of the AcListSub class. While AcListSub is not
in the access list for method m1, it is a subclass of AcListSuper.
For example, add the following method to the AcListNonSub class:
methods
function obj = nonSub2(obj,AcListSub_Obj)
disp('Call m1 via subclass object:')
AcListSub_Obj.m1;
end
end

Calling the nonSub2 method results in execution of the superclass m1 method:

b = AcListNonSub;
c = AcListSub;
b.nonSub2(c);
Call m1 via subclass object:
Method m1 called

This behavior is consistent with the behavior of any subclass object, which can substitute
for an object of its superclass.
12-31

12

How to Build on Other Classes

Abstract Methods with Access Lists

A class containing a method declared as Abstract is an abstract class. It is the
responsibility of subclasses to implement the abstract method using the function
signature declared in the class definition.
When an abstract method has an access list, only the classes in the access list can
implement the method. A subclass that is not in the access list cannot implement the
abstract method so that subclass is itself abstract.

12-32

Property Access List

Property Access List

This class declares access lists for the property GetAccess and Access attributes:
classdef PropertyAccess
properties (GetAccess = {?ClassA, ?ClassB}, SetAccess = private)
Prop1
end
properties (Access = ?ClassC)
Prop2
end
end

The class PropertyAccess specifies the following property access:

Gives the classes ClassA and ClassB get access to the Prop1 property.
Gives all subclasses of ClassA and ClassB get access to the Prop1 property.
Does not give get access to Prop1 from subclasses of PropertyAccess.
Defines private set access for the Prop1 property.
Gives set and get access to Prop2 for ClassC and its subclasses.

Related Examples

Properties with Access Lists on page 12-27

12-33

12

How to Build on Other Classes

Method Access List

This class declares an access list for the method Access attribute:
classdef MethodAccess
methods (Access = {?ClassA, ?ClassB, ?MethodAccess})
function listMethod(obj)
...
end
end
end

The MethodAccess class specifies the following method access:

Access to listMethod from an instance of MethodAccess by methods of the classes
ClassA and ClassB.
Access to listMethod from an instance of MethodAccess by methods of subclasses
of MethodAccess, because of the inclusion of MethodAccess in the access list.
Subclasses of ClassA and ClassB are allowed to define a method named
listMethod, and MethodAccess is allowed to redefine listMethod. However,
if MethodAccess was not in the access list, its subclasses could not redefine
listMethod.

Related Examples

12-34

Methods with Access Lists on page 12-28

Event Access List

Event Access List

This class declares an access list for the event ListenAccess attribute:
classdef EventAccess
events (NotifyAccess = private, ListenAccess = {?ClassA, ?ClassB})
Event1
Event2
end
end

The class EventAccess specifies the following event access:

Limits notify access for Event1 and Event2 to EventAccess; only methods of the
EventAccess can trigger these events.
Gives listen access for Event1 and Event2 to methods of ClassA and ClassB.
Methods of EventAccess, ClassA, and ClassB can define listeners for these events.
Subclasses of MyClass cannot define listeners for these events.

Related Examples

Events and Listeners Syntax on page 11-21

12-35

12

How to Build on Other Classes

Support Both Handle and Value Subclasses

In this section...
Basic Knowledge on page 12-36
Handle Compatibility Rules on page 12-36
Define Handle-Compatible Classes on page 12-37
Subclass Handle-Compatible Classes on page 12-39
Methods for Handle Compatible Classes on page 12-41
Handle-Compatible Classes and Heterogeneous Arrays on page 12-42

Basic Knowledge
The material presented in this section builds on knowledge of the following information.
Create Subclasses Syntax and Techniques on page 12-7
Subclass Multiple Classes on page 12-20
Comparison of Handle and Value Classes on page 7-2
Key Concepts
Handle-compatible class is a class that you can combine with handle classes when
defining a set of superclasses.
All handle classes are handle-compatible.
All superclasses of handle-compatible classes must also be handle compatible.
HandleCompatible the class attribute that defines nonhandle classes as handle
compatible.

Handle Compatibility Rules

Handle-compatible classes (that is, classes whose HandleCompatible attribute is set to
true) follow these rules:
All superclasses of a handle-compatible class must also be handle compatible
12-36

Support Both Handle and Value Subclasses

If a class explicitly sets its HandleCompatibility attribute to false, then none of

the class superclasses can be handle classes.
If a class does not explicitly set its HandleCompatible attribute and, if any
superclass is a handle, then all superclasses must be handle compatible.
The HandleCompatible attribute is not inherited.
A class that does not explicitly set its HandleCompatible attribute to true is:
A handle class if any of its superclasses are handle classes
A value class if none of the superclasses are handle classes

Define Handle-Compatible Classes

A class is handle compatible if:
It is a handle class
Its HandleCompatible attribute is set to true
The HandleCompatible class attribute identifies classes that you can combine with
handle classes when specifying a set of superclasses.
Handle compatibility provides greater flexibility when defining abstract superclasses.
For example, mixin and interface classes in which the superclass supports both handle
and value subclasses. Handle compatibility removes the need to define both a handle
version and a nonhandle version of a class.
A Handle Compatible Class
The Utility class is useful to both handle and value subclasses. In this example, the
Utility class defines a method to reset property values to the default values defined in
the respective class definition:
classdef (HandleCompatible) Utility
methods
function obj = resetDefaults(obj)
mc = metaclass(obj);
mp = mc.PropertyList;
for k=1:length(mp)
if mp(k).HasDefault && ~strcmp(mp(k).SetAccess,'private')
obj.(mp(k).Name) = mp(k).DefaultValue;

12-37

12

How to Build on Other Classes

end
end
end
end
end

The Utility class is handle compatible. Therefore, you can use it in the derivation
of classes that are either handle classes or value classes. See Class Metadata for
information on using meta-data classes.
Return Modified Objects
The resetDefaults method defined by the Utility class returns the object it modifies.
When you call resetDefaults with a value object, the method must return the modified
object. It is important to implement methods that work with both handle and value
objects in a handle compatible superclass. See Object Modification on page 5-59 for
more information on modifying handle and value objects.
Consider the behavior of a value class that subclasses the Utility class. The
PropertyDefaults class defines three properties, all of which have default values:
classdef PropertyDefaults < Utility
properties
p1 = datestr(rem(now,1)); % Current time
p2 = 'red';
% Character vector
p3 = pi/2;
% Result of division operation
end
end

Create a PropertyDefaults object. MATLAB evaluates the expressions assigned as

default property values when the class is first loaded. MATLAB uses these same default
values whenever you create an instance of this class in the current MATLAB session.
pd = PropertyDefaults
pd =
PropertyDefaults with properties:
p1: ' 4:42 PM'
p2: 'red'
p3: 1.5708

Assign new values that are different from the default values:
12-38

Support Both Handle and Value Subclasses

pd.p1 = datestr(rem(now,1));
pd.p2 = 'green';
pd.p3 = pi/4;

All pd object property values now contain values that are different from the default
values originally defined by the class:
pd
pd =
PropertyDefaults with properties:
:
p1: ' 4:45 PM'
p2: 'green'
p3: 0.7854

Call the resetDefaults method, which is inherited from the Utility class. Because
the PropertyDefaults class is not a handle class, return the modified object.
pd = pd.resetDefaults
pd =
PropertyDefaults with properties:
p1: ' 4:54 PM'
p2: 'red'
p3: 1.5708

If the PropertyDefaults class was a handle class, then you would not need to save the
object returned by the resetDefaults method. To design a handle compatible class like
Utility, ensure that all methods work with both kinds of classes.

Subclass Handle-Compatible Classes

According to the rules described in Handle Compatibility Rules on page 12-36, when
you combine a handle superclass with a handle-compatible superclass, the result is a
handle subclass, which is handle compatible.
However, subclassing a handle-compatible class does not necessarily result in the
subclass being handle compatible. Consider the following two cases, which demonstrate
two possible results.
12-39

12

How to Build on Other Classes

Combine Nonhandle Utility Class with Handle Classes

Suppose that you define a class that subclasses a handle class, and the handle compatible
Utility class discussed in A Handle Compatible Class on page 12-37. The
HPropertyDefaults class has these characteristics:
It is a handle class (it derives from handle).
All its superclasses are handle compatible (handle classes are handle compatible by
definition).
classdef HPropertyDefaults < handle & Utility
properties
GraphPrim = line;
Width = 1.5;
Color = 'black';
end
end

The HPropertyDefaults class is handle compatible:

hpd = HPropertyDefaults;
mc = metaclass(hpd);
mc.HandleCompatible
ans =
1

Nonhandle Subclasses of a Handle-Compatible Class

If you subclass both a value class that is not handle compatible and a handle compatible
class, the subclass is a nonhandle compatible value class. The ValueSub class:
Is a value class (It does not derive from handle.)
One of its superclasses is handle compatible (the Utility class).
classdef ValueSub < MException & Utility
methods
function obj = ValueSub(str1,str2)
obj = obj@MException(str1,str2);
end
end
end

12-40

Support Both Handle and Value Subclasses

The ValueSub class is a nonhandle-compatible value class because the MException class
does not define the HandleCompatible attribute as true:
hv = ValueSub('MATLAB:narginchk:notEnoughInputs',...
'Not enough input arguments.');
mc = metaclass(hv);
mc.HandleCompatible
ans =
0

Methods for Handle Compatible Classes

Objects passed to methods of handle compatible classes can be either handle or value
objects. There are two different behaviors to consider when implementing methods for a
class that operate on both handles and values:
If an input object is a handle object and the method alters the handle object, these
changes are visible to all workspaces that contain the same handle.
If an input object is a value object, then changes to the object made inside the method
affect only the value inside the method workspace.
Handle compatible methods generally do not alter input objects because the effects of
such changes are not the same for handle and nonhandle objects.
See Object Modification on page 5-59 for information about modifying handle and value
objects.
Identify Handle Objects
To determine if an object is a handle object, use the isa function:
isa(obj,'handle')

Modify Value Objects in Methods

If a method operates on both handle and value objects, the method must return the
modified object. For example, the setTime method returns the object it modifies:
classdef (HandleCompatible) Util
% Utility class that adds a time stamp
properties

12-41

12

How to Build on Other Classes

TimeStamp
end
methods
function obj = setTime(obj)
obj.TimeStamp = now;
end
end
end

Handle-Compatible Classes and Heterogeneous Arrays

A heterogeneous array contains objects of different classes. Members of a heterogeneous
array have a common superclass, but can belong to different subclasses. See the
matlab.mixin.Heterogeneous class for more information on heterogeneous arrays. The
matlab.mixin.Heterogeneous class is a handle-compatible class.
Methods Must Be Sealed
You can invoke only those methods that are sealed by the common superclass on
heterogeneous arrays (Sealed attribute set to true). Sealed methods prevent subclasses
from overriding those methods and guarantee that methods called on heterogeneous
arrays have the same definition for the entire array.
Subclasses cannot override sealed methods. In situations requiring subclasses to
specialize methods defined by a utility class, you can employ the design pattern referred
to as the template method.
Template Technique
Suppose that you implement a handle compatible class that works with heterogeneous
arrays. This approach enables you to seal public methods, while providing a way for each
subclass to specialize how the method works on each subclass instance. In the handle
compatible class:
Define a sealed method that accepts a heterogeneous array as input.
Define a protected, abstract method that each subclass must implement.
Within the sealed method, call the overridden method for each array element.
Each subclass in the heterogeneous hierarchy implements a concrete version of the
abstract method. The concrete method provides specialized behavior required by the
particular subclass.
12-42

Support Both Handle and Value Subclasses

The Printable class shows how to implement a template method approach:

classdef (HandleCompatible) Printable
methods(Sealed)
function print(aryIn)
n = numel(aryIn);
for k=1:n
printElement(aryIn(k));
end
end
end
methods(Access=protected, Abstract)
printElement(objIn)
end
end

More About

Heterogeneous Arrays on page 10-21

12-43

12

How to Build on Other Classes

Subclasses of MATLAB Built-In Types

In this section...
MATLAB Built-In Types on page 12-44
Built-In Types You Can Subclass on page 12-44
Why Subclass Built-In Types on page 12-45
Which Functions Work with Subclasses of Built-In Types on page 12-45
Behavior of Built-In Functions with Subclass Objects on page 12-45
Built-In Subclasses That Define Properties on page 12-46

MATLAB Built-In Types

Built-in types represent fundamental kinds of data such as numeric arrays, logical
arrays, and character arrays. Other built-in types like cell arrays and structures contain
data belonging to any class.
Built-in types define methods that perform operations on objects of these classes. For
example, you can perform operations on numeric arrays such as, sorting, arithmetic, and
logical operations.
See Fundamental MATLAB Classes for more information on MATLAB built-in classes.
Note: It is an error to define a class that has the same name as a built-in class.

Built-In Types You Can Subclass

You can subclass MATLAB numeric classes. for a list of numeric types, see Numeric
Types.
You cannot subclass any class that has its Sealed attribute set to true. To determine if
the class is Sealed, query the class metadata:
mc = ?ClassName;
mc.Sealed

A value of 0 indicates that the class is not Sealed and can be subclasses.
12-44

Subclasses of MATLAB Built-In Types

Why Subclass Built-In Types

Subclass a built-in type to extend the operations that you can perform on a particular
class of data. For instance , when you want to:
Define unique operations to perform on class data.
Be able to use methods of the built-in class and other built-in functions directly
with objects of the subclass. For example, you do not need to reimplement all the
mathematical operators if you derived from a class such as double that defines these
operators.

Which Functions Work with Subclasses of Built-In Types

Consider a class that defines enumerations. It can derive from an integer class and
inherit methods that enable you to compare and sort values. For example, integer classes
like int32 support all the relational methods (eq, ge, gt, le, lt, ne).
To see a list of functions that the subclass has inherited as methods, use the methods
function:
methods('SubclassName')

Generally, you can use an object of the subclass with any:

Inherited methods
Functions that normally accept input arguments of the same class as the superclass.

Behavior of Built-In Functions with Subclass Objects

When you define a subclass of a built-in class, the subclass inherits all the methods
defined by that built-in class. MATLAB also provides additional methods to subclasses of
built-in classes that override several built-in functions.
Built-in functions and methods that work on built-in classes can behave differently when
called with subclasses of built-in classes. Their behavior depends on which function you
are using and whether your subclass defines properties.
Behavior Categories
When you call an inherited method on a subclass of a built-in class, the result depends on
the nature of the operation performed by the method. The behaviors of these methods fit
into several categories.
12-45

12

How to Build on Other Classes

Operations on data values return objects of the superclass. For example, if you
subclass double and perform addition on two subclass objects, MATLAB adds the
numeric values and returns a value of class double.
Operations on the orientation or structure of the data return objects of the subclass.
Methods that perform these kinds of operations include, reshape, permute,
transpose, and so on.
Converting a subclass object to a built-in class returns an object of the specified class.
Functions such as uint32, double, char work with subclass objects the same as
they work with built-in objects.
Comparing objects or testing for inclusion in a specific set returns logical or built-in
objects, depending on the function. Functions such as isequal, ischar, isobject
work with subclass objects the same as they work with superclass objects.
Indexing expressions return objects of the subclass. If the subclass defines properties,
then default indexing no longer works. The subclass must define its own indexing
methods.
Concatenation returns an object of the subclass. If the subclass defines properties,
then default concatenation no longer works and the subclass must define its own
concatenation methods.
To list the built-in functions that work with a subclass of a built-in class, use the
methods function.

Built-In Subclasses That Define Properties

When a subclass of a built-in class defines properties, MATLAB no longer supports
indexing and concatenation operations. MATLAB cannot use the built-in functions
normally called for these operations because subclass properties can contain any data.
The subclass must define what indexing and concatenation mean for a class with
properties. If your subclass needs indexing and concatenation functionality, then the
subclass must implement the appropriate methods.
Methods for Indexing
To support indexing operations, the subclass must implement these methods:
subsasgn Implement dot notation and indexed assignments
subsref Implement dot notation and indexed references
12-46

Subclasses of MATLAB Built-In Types

subsindex Implement object as index value

Methods for Concatenation
To support concatenation, the subclass must implement the following methods:
horzcat Implement horizontal concatenation of objects
vertcat Implement vertical concatenation of objects
cat Implement concatenation of object arrays along specified dimension

Related Examples

Class to Represent Hardware on page 12-75

Subclasses of Built-In Types with Properties on page 12-61

Subclasses of Built-In Types Without Properties on page 12-53

12-47

12

How to Build on Other Classes

Behavior of Inherited Built-In Methods

In this section...
Subclass double on page 12-48
Built-In Data Value Methods on page 12-49
Built-In Data Organization Methods on page 12-50
Built-In Indexing Methods on page 12-51
Built-In Concatenation Methods on page 12-51

Subclass double
Most built-in functions used with built-in classes are actually methods of the built-in
class. For example, the double and single classes define several methods to perform
arithmetic operations, indexing, matrix operation, and so on. All these built-in class
methods work with subclasses of the built-in class.
Subclassing double enables your class to use features without implementing the
methods that a MATLAB built-in class defines.
The DocSimpleDouble class subclasses the built-in double class.
classdef DocSimpleDouble < double
methods
function obj = DocSimpleDouble(data)
if nargin == 0
data = 0;
end
obj = obj@double(data);
end
end
end

Create an instance of the class DocSimpleDouble.

sc = DocSimpleDouble(1:10)
sc =
1x10 DocSimpleDouble:
double data:
1
2
3
4

12-48

10

Behavior of Inherited Built-In Methods

Call a method inherited from class double that operates on the data, such as sum. sum
returns a double and, therefore, uses the display method of class double:
sum(sc)
ans =
55

Index sc like an array of doubles. The returned value is the class of the subclass:
a = sc(2:4)
a =
1x3 DocSimpleDouble:
double data:
2
3
4

Indexed assignment works the same as the built-in class. The returned value is the class
of the subclass:
sc(1:5) = 5:-1:1
sc =
1x10 DocSimpleDouble:
double data:
5
4
3
2

10

Calling a method that modifies the order of the data elements operates on the data, but
returns an object of the subclass:
sc = DocSimpleDouble(1:10);
sc(1:5) = 5:-1:1;
a = sort(sc)
a =
1x10 DocSimpleDouble:
double data:
1
2
3
4

10

Built-In Data Value Methods

When you call a built-in data value method on a subclass object, MATLAB uses the
superclass part of the subclass object as inputs to the method. The value returned is
same class as the built-in class. For example:
12-49

12

How to Build on Other Classes

sc = DocSimpleDouble(1:10);
a = sin(sc);
class(a)
ans =
double

Built-In Data Organization Methods

This group of built-in methods reorders or reshapes the input argument array. These
methods operate on the superclass part of the subclass object, but return an object of the
same type as the subclass.
sc = DocSimpleDouble(randi(9,1,10))
sc = DocSimpleDouble(randi(9,1,10))
sc =
1x10 DocSimpleDouble:
double data:
6
1

b = sort(sc)
b =
1x10 DocSimpleDouble:
double data:
1
2

Methods in this group include:

reshape
permute
sort
transpose
ctranspose
12-50

Behavior of Inherited Built-In Methods

Built-In Indexing Methods

Built-in classes use specially implemented versions of the subsref, subsasgn, and
subsindex methods to implement indexing. When you index a subclass object, only the
built-in data is referenced (not the properties defined by your subclass).
For example, indexing element 2 in the DocSimpleDouble subclass object returns the
second element in the vector:
sc = DocSimpleDouble(1:10);
a = sc(2)
a =
DocSimpleDouble
double data:
2

The value returned from an indexing operation is an object of the subclass. You cannot
make indexed references if your subclass defines properties, unless your subclass
overrides the default subsref method.
Assigning a new value to the second element in the DocSimpleDouble object operates
only on the superclass data:
sc(2) = 12
sc =
1x10 DocSimpleDouble:
double data:
1
12
3
4

10

The subsref method also implements dot notation for methods.

Built-In Concatenation Methods

Built-in classes use the functions horzcat, vertcat, and cat to implement
concatenation. When you use these functions with subclass objects of the same type,
MATLAB concatenates the superclass data to form a new object. For example, you can
concatenate objects of the DocSimpleDouble class:
sc1 = DocSimpleDouble(1:10);
sc2 = DocSimpleDouble(11:20);
[sc1,sc2]

12-51

12

How to Build on Other Classes

ans =
1x20 DocSimpleDouble:
double data:
Columns 1 through 13
1
2
3
4
Columns 14 through 20
14
15
16
17

18

19

20

5
15

6
16

7
17

10

8
18

9
19

10
20

11

12

13

[sc1;sc2]
ans =
2x10 DocSimpleDouble:
double data:
1
2
3
4
11
12
13
14

Concatenate two objects along a third dimension:

c = cat(3,sc1,sc2)
c =
1x10x2 DocSimpleDouble:
double data:
(:,:,1) =
1

10

12

13

14

15

16

17

18

19

20

(:,:,2) =
11

If the subclass of a built-in class defines properties, you cannot concatenate objects of the
subclass. There is no way to determine how to combine properties of different objects.
However, your subclass can define custom horzcat and vertcat methods to support
concatenation in whatever way makes sense for your subclass.

Related Examples

12-52

Subclasses of Built-In Types Without Properties on page 12-53

Subclasses of Built-In Types with Properties on page 12-61

Subclasses of Built-In Types Without Properties

Subclasses of Built-In Types Without Properties

In this section...
Specialized Numeric Types on page 12-53
A Class to Manage uint8 Data on page 12-53
Using the DocUint8 Class on page 12-54

Specialized Numeric Types

Subclass built-in numeric types to create customized data types that inherit the
functionality of the built-in type. Add functionality to that provided by the superclass
by implementing class methods. Subclasses without properties store numeric data as
the superclass type. If your subclass design does not require properties to store other
data, the implementation is simpler because you do not need to define indexing and
concatenation methods.
For more information, see Subclasses of MATLAB Built-In Types on page 12-44.

A Class to Manage uint8 Data

This example shows a class derived from the built-in uint8 class. This class simplifies
the process of maintaining a collection of intensity image data defined by uint8 values.
The basic operations of the class include:
Capability to convert various classes of image data to uint8 to reduce object data
storage.
A method to display the intensity images contained in the subclass objects.
Ability to use all the methods supported by uint8 data (for example, size, indexing,
reshape, bitshift, cat, fft, arithmetic operators, and so on).
The class data are matrices of intensity image data stored in the superclass part of the
subclass object. This approach requires no properties.
The DocUint8 class stores the image data, which converts the data, if necessary:
classdef DocUint8 < uint8

12-53

12

How to Build on Other Classes

methods
function obj = DocUint8(data)
if nargin == 0
data = uint8(0);
end
obj = obj@uint8(data); % Store data on superclass
end
function h = showImage(obj)
data = uint8(obj);
figure; colormap(gray(256))
h = imagesc(data,[0 255]);
axis image
brighten(.2)
end
end
end

Using the DocUint8 Class

Create DocUint8 Objects
The DocUint8 class provides a method to display all images stored as DocUint8 objects
in a consistent way. For example:
cir = imread('circuit.tif');
img1 = DocUint8(cir);
img1.showImage;

12-54

Subclasses of Built-In Types Without Properties

50

100

150

200

250

50

100

150

200

250

Because DocUint8 subclasses uint8, you can use any uint8 methods. For example,
size(img1)
ans =
280

272

returns the size of the image data.

Indexing Operations
Inherited methods perform indexing operations, but return objects of the same class as
the subclass.
Therefore, you can index into the image data and call a subclass method:
12-55

12

How to Build on Other Classes

showImage(img1(100:200,1:160));

Subscripted reference operations (controlled by the inherited subsref method) return a

DocUint8 object.

10
20
30
40
50
60
70
80
90
100
20

40

60

80

100

120

140

160

You can assign values to indexed elements:

img1(100:120,140:160) = 255;
img1.showImage;

Subscripted assignment operations (controlled by the inherited subsasgn method)

return a DocUint8 object.
12-56

Subclasses of Built-In Types Without Properties

50

100

150

200

250

50

100

150

200

250

Concatenation Operations
Concatenation operations work on DocUint8 objects because this class inherits the
uint8 horzcat and vertcat methods, which return a DocUint8 object:
showImage([img1 img1]);

12-57

12

How to Build on Other Classes

50
100
150
200
250
50

100

150

200

250

300

350

400

450

500

Data Operations
Methods that operate on data values, such as arithmetic operators, always return an
object of the built-in type (not of the subclass type). For example, multiplying DocUint8
objects returns a uint8 object:
a = img1.*1.8;
showImage(a);
Undefined function 'showImage' for input arguments of type 'uint8'.

To perform operations of this type, implement a subclass method to override the

inherited method. The times method implements array (element-by-element)
multiplication.
12-58

Subclasses of Built-In Types Without Properties

Add this method to the DocUint8 class:

function o = times(obj,val)
u8 = uint8(obj).*val;
o = DocUint8(u8);
end

When you override a uint8 method, MATLAB calls the subclass method, not the base
class method. The subclass method must:
Call the uint8 times method on the DocUint8 object data.
Construct a new DocUint8 object using the uint8 data.
After adding the times method to the DocUint8 class, the output of multiplication
expressions is an object of the DocUint8 class:
showImage(img1.*1.8);

12-59

12

How to Build on Other Classes

50

100

150

200

250

50

100

150

200

Related Examples

12-60

Operator Overloading on page 17-48

Subclasses of Built-In Types with Properties on page 12-61

250

Subclasses of Built-In Types with Properties

Subclasses of Built-In Types with Properties

In this section...
Specialized Numeric Types with Additional Data Storage on page 12-61
Subclasses with Properties on page 12-61
Property Added on page 12-61
Methods Implemented on page 12-62
Class Definition Code on page 12-62
Using ExtendDouble on page 12-64
Concatenation of ExtendDouble Objects on page 12-67

Specialized Numeric Types with Additional Data Storage

Subclass built-in numeric types to create customized data types that inherit the
functionality of the built-in type. Add or modify functionality to that provided by the
superclass by implementing class methods.
Providing additional data storage in the subclass by defining properties can be a useful
extension to the built-in data class. However, the addition of properties to the subclass
requires the subclass to define methods to implement standard array behaviors.
For more information, see Subclasses of MATLAB Built-In Types on page 12-44.

Subclasses with Properties

When a subclass of a built-in class defines properties, default indexing and concatenation
do not work. The default subsref, subsasgn, horzcat, and vertcat functions cannot
work with unknown property types and values. Therefore, the subclass must define these
behaviors by implementing these methods.
This sample implementation of the ExtendDouble class derives from the double class
and defines a single property. The ExtendDouble class definition demonstrates how to
implement indexing and concatenation for subclasses of built-in classes

Property Added
The ExtendDouble class defines the DataString property to contain text that describes
the data. The superclass part of the class contains the numeric data.
12-61

12

How to Build on Other Classes

Methods Implemented
The following methods modify the behavior of the ExtendDouble class:
ExtendDouble The constructor supports a no argument syntax that initializes
properties to empty values.
subsref Enables subscripted reference to the superclass part of the subclass, dot
notation reference to the DataString property, and dot notation reference the builtin data via the name Data.
subsasgn Enables subscripted assignment to the superclass part of the subclass,
dot notation reference to the DataString property, and dot notation reference the
built-in data via the name Data.
horzcat Defines horizontal concatenation of ExtendDouble objects. concatenates
the superclass part using the double class horzcat method and forms a cell array of
the DataString properties.
vertcat The vertical concatenation equivalent of horzcat (both are required).
char A ExtendDouble to char converter used by horzcat and vertcat.
disp ExtendDouble implements a disp method to provide a custom display for
the object.

Class Definition Code

The ExtendDouble class extends double and implements methods to support
subscripted indexing and concatenation.
classdef ExtendDouble < double
properties
DataString
end
methods
function obj = ExtendDouble(data,str)
if nargin == 0
data = 0;
str = '';
elseif nargin == 1
str = '';
end
obj = obj@double(data);

12-62

Subclasses of Built-In Types with Properties

obj.DataString = str;
end
function sref = subsref(obj,s)
switch s(1).type
case '.'
switch s(1).subs
case 'DataString'
sref = obj.DataString;
case 'Data'
d = double(obj);
if length(s)<2
sref = d;
elseif length(s)>1 && strcmp(s(2).type,'()')
sref = subsref(d,s(2:end));
end
otherwise
error('Not a supported indexing expression')
end
case '()'
d = double(obj);
newd = subsref(d,s(1:end));
sref = ExtendDouble(newd,obj.DataString);
case '{}'
error('Not a supported indexing expression')
end
end
function obj = subsasgn(obj,s,b)
switch s(1).type
case '.'
switch s(1).subs
case 'DataString'
obj.DataString = b;
case 'Data'
if length(s)<2
obj = ExtendDouble(b,obj.DataString);
elseif length(s)>1 && strcmp(s(2).type,'()')
d = double(obj);
newd = subsasgn(d,s(2:end),b);
obj = ExtendDouble(newd,obj.DataString);
end
otherwise
error('Not a supported indexing expression')

12-63

12

How to Build on Other Classes

end
case '()'
d = double(obj);
newd = subsasgn(d,s(1),b);
obj = ExtendDouble(newd,obj.DataString);
case '{}'
error('Not a supported indexing expression')
end
end
function newobj = horzcat(varargin)
d1 = cellfun(@double,varargin,'UniformOutput',false );
data = horzcat(d1{:});
str = horzcat(cellfun(@char,varargin,'UniformOutput',false));
newobj = ExtendDouble(data,str);
end
function newobj = vertcat(varargin)
d1 = cellfun(@double,varargin,'UniformOutput',false );
data = vertcat(d1{:});
str = vertcat(cellfun(@char,varargin,'UniformOutput',false));
newobj = ExtendDouble(data,str);
end
function str = char(obj)
str = obj.DataString;
end
function disp(obj)
disp(obj.DataString)
disp(double(obj))
end
end
end

Using ExtendDouble
Create an instance of ExtendDouble and notice that the display is different from the
default:
ed = ExtendDouble(1:10,'One to ten')
ed =

12-64

Subclasses of Built-In Types with Properties

One to ten
1
2

10

Inherited Methods
The ExtendDouble class inherits methods from the class double. To see a list of all
public methods defined by the double class, use the methods function:
methods(double.empty)

The sum function continues to operate on the superclass part of the object:
sum(ed)
ans =
55

The sort function works on the superclass part of the object:

sort(ed(10:-1:1))
ans =
1

10

Arithmetic operators work on the superclass part of the object:

ed.^2
ans =
1

16

25

36

49

64

81

100

Subscripted Indexing
Because the ExtendDouble class defines a property, the class must implement its own
subsref and subsasgn methods. The class can implement
This class implements the following subscripted indexing expressions for reference and
assignment.
obj.DataString access the DataString property.
obj.Data, obj.Data(ind) access the data using a property-style reference.
Reference returns values of type double.
12-65

12

How to Build on Other Classes

obj(ind) access the numeric data (same as obj.Data(ind)). Reference returns

values of type ExtendDouble.
The class subsref method enables you to use ExtendDouble objects like numeric
arrays to reference the numeric data:
ed = ExtendDouble(1:10,'One to ten');
ed(10:-1:1)
ans =
One to ten
10
9

Access the numeric data of the ExtendDouble using property-style indexing with the
arbitrarily chosen name Data:
ed.Data(10:-1:1)
ans =
One to ten
10
9

Access the DataString property:

ed.DataString
ans =
One to ten

Subscripted assignment implements similar syntax in the class subsasgn method.

ed = ExtendDouble(1:10,'One to ten');
ed(11:13) = [11,12,13];
ed.DataString = 'one to thirteen';
ed
ed =
One to thirteen'
1
2
3

10

11

12

The ExtendDouble inherits converter methods from the double class. For example,
MATLAB calls the char method to perform this assignment statement.
12-66

13

Subclasses of Built-In Types with Properties

ed(11:13) = ['a','b','c']
ed =
one to thirteen
1
2

10

97

98

99

Class of Value Returned by Indexing Expression

The ExtendDouble implements two forms of indexed reference in the subsref method:
obj.Data and obj.Data(ind) Return values of class double
obj(ind) Return values of class ExtendDouble
For example, compare the values returned by these expressions.
ed = ExtendDouble(1:10,'One to ten');
a = ed(1)
a =
One to ten
1
b = ed.Data(1)
b =
1
whos
Name

Size

Bytes

a
b
ed

1x1
1x1
1x10

132
8
204

Class

Attributes

ExtendDouble
double
ExtendDouble

The increased flexibility of the implementation of indexed reference in the

ExtendDouble class .

Concatenation of ExtendDouble Objects

Create these two objects:
12-67

12

How to Build on Other Classes

ed1 = ExtendDouble([1:10],'One to ten');

ed2 = ExtendDouble([10:-1:1],'Ten to one');

Concatenate these objects along the horizontal dimension:

hcat = [ed1,ed2]
hcat =
'One to ten'

'Ten to one'

Columns 1 through 13
1

10

10

Columns 14 through 20
7

whos
Name

Size

Bytes

ed1
ed2
hcat

1x10
1x10
1x20

204
204
528

Class

Attributes

ExtendDouble
ExtendDouble
ExtendDouble

Vertical concatenation works in a similar way:

vcat = [ed1;ed2]
vcat =
'One to ten'
1
10

2
9

'Ten to one'
3
8

4
7

5
6

6
5

7
4

8
3

9
2

10
1

Both horzcat and vertcat return a new object of the same class as the subclass.

Related Examples

12-68

Subclasses of Built-In Types Without Properties on page 12-53

Use of size and numel with Classes

Use of size and numel with Classes

In this section...
size and numel on page 12-69
Built-In Class Behavior on page 12-69
Subclasses Inherit Behavior on page 12-70
Classes Not Derived from Built-In Classes on page 12-71
Change the Behavior of size or numel on page 12-73
Overload numArgumentsFromSubscript Instead of numel on page 12-74

size and numel

The size function returns the dimensions of an array. The numel function returns the
number of elements in an array, which is equivalent to prod(size(objArray)). That
is, the product of the array dimensions.
The size and numel functions work consistently with arrays of user-defined objects.
There is generally no need to overload size or numel in user-defined classes.
Several MATLAB functions use size and numel to perform their operations. Therefore,
if you do overload either of these functions in your class, be sure that objects of your class
work as designed with other MATLAB functions.
If your class modifies array indexing, see Overload numArgumentsFromSubscript
Instead of numel on page 12-74

Built-In Class Behavior

When you use the size and numel functions in classes derived from built-in classes,
these functions behave the same as they behave in the superclass.
Consider the built-in class double:
d = 1:10;
size(d)
ans =

12-69

12

How to Build on Other Classes

10

numel(d)
ans =
10
dsub = d(7:end);
size(dsub)
ans =
1

The double class defines these behaviors, including parentheses indexing.

Subclasses Inherit Behavior

Unless the subclass explicitly overrides superclass behavior, subclasses behave like their
superclasses. For example, SimpleDouble subclasses double and defines no properties:
classdef SimpleDouble < double
methods
function obj = SimpleDouble(data)
if nargin == 0
data = 0;
end
obj = obj@double(data);
end
end
end

Create an object and assign the values 1:10:

sd = SimpleDouble(1:10);

The size function returns the size of the superclass part:

size(sd)
ans =
1

12-70

10

Use of size and numel with Classes

The numel function returns the number of elements in the superclass part:
numel(sd)
ans =
10

Object arrays return the size of the superclass arrays:

size([sd;sd])
ans =
2

10

numel([sd;sd])
ans =
20

The SimpleDouble class inherits the indexing behavior of the double class:
sdsub = sd(7:end);
size(sdsub)
ans =
1

Classes Not Derived from Built-In Classes

Consider a simple value class. This class does not inherit the array-like behaviors of the
double class. For example:
classdef VerySimpleClass
properties
Value
end
end

Create an object and assign a 10-element array to the Value property:

vs = VerySimpleClass;
vs.Value = 1:10;

12-71

12

How to Build on Other Classes

size(vs)
ans =
1

numel(vs)
ans =
1
size([vs;vs])
ans =
2

numel([vs;vs])
ans =
2

vs is a scalar object. The Value property is an array of doubles:

size(vs.Value)
ans =
1

10

Apply indexing expressions to the object property:

vssub = vs.Value(7:end);
size(vssub)
ans =
1

The vs.Value property is an array of class double:

class(vs.Value)
ans =

12-72

Use of size and numel with Classes

double

Create an array of VerySimpleClass objects:

vsArray(1:10) = VerySimpleClass;

The Value property for array elements 2 through 10 is empty:

isempty([vsArray(2:10).Value])
ans =
1

MATLAB does not apply scalar expansion to object array property value assignment. Use
the deal function for this purpose:
[vsArray.Value] = deal(1:10);
isempty([vsArray.Value])
ans =
0

The deal function assigns values to each Value property in the vsArray object array.
Indexing rules for object arrays are equivalent to the rules for arrays of struct:
vsArray(1).Value
ans =
1

10

vsArray(1).Value(6)
ans =
6

Change the Behavior of size or numel

Subclasses of built-in numeric classes inherit a size method, which operates on the
superclass part of the subclass object (these methods are hidden). If you want size or
12-73

12

How to Build on Other Classes

numel to behave differently, override them by defining a size or numel method in your
subclass.
Other MATLAB functions use the values returned by these functions. If you change the
way that size and numel behave, ensure that the values returned make sense for the
intended use of your class.

Overload numArgumentsFromSubscript Instead of numel

If classes implement a numArgumentsFromSubscript method, MATLAB calls it instead
of numel to determine the number of elements returned by indexed expressions that
return comma-separated lists. For example, expressions such as:
A(1:2).Prop

Both subsref and subsasgn use numArgumentsFromSubscript:

subsref numArgumentsFromSubscript computes the number of expected
outputs (nargout) returned subsref.
subsasgn numArgumentsFromSubscript computes the number of expected
inputs (nargin) that MATLAB assigns as a result of a call to subsasgn.
Subclasses of built-in classes always return scalar objects as a result of subscripted
reference and always use scalar objects for subscripted assignment.
If you define a class in which nargout for subsref or nargin for subsasgn must be a
specific value, then overload numArgumentsFromSubscript to return that value.

See Also
numArgumentsFromSubscript

Related Examples

12-74

Modify nargout and nargin for Indexing Methods on page 17-8

Class to Represent Hardware

Class to Represent Hardware

In this section...
Objective on page 12-75
Why Derive from int32 on page 12-75
Implementation on page 12-75
Construct MuxCard Object on page 12-76
Call Methods of int32 on page 12-77

Objective
This example implements a class to represent an optical multiplex card. These cards
typically have several input ports and an output port. The MuxCard class represents the
ports by the port names and port data rates. The output rate of a multiplex card is the
sum of the input port data rates.

Why Derive from int32

The MuxCard class derives from the int32 class because 32bit integers represent the
input port data rates. The MuxCard class inherits the methods of the int32 class, which
simplifies the implementation of this subclass. For example, numeric array indexing
and arithmetic operations work on MuxCard objects because the class inherits these
operations from the int32 class.

Implementation
Here is the definition of the MuxCard class. Notice that the input port rates initialize the
int32 portion of class.
classdef MuxCard < int32
properties
InPutNames
OutPutName
end
properties (Dependent = true)
OutPutRate

12-75

12

How to Build on Other Classes

end
methods
function obj = MuxCard(inptnames, inptrates, outpname)
obj = obj@int32(inptrates);
obj.InPutNames = inptnames;
obj.OutPutName = outpname;
end
function x = get.OutPutRate(obj)
x = sum(obj);
end
function x = subsref(card, s)
if strcmp(s(1).type,'.')
base = subsref@int32(card, s(1));
if isscalar(s)
x = base;
else
x = subsref(base, s(2:end));
end
else
x = subsref(int32(card), s);
end
end
end
end

Construct MuxCard Object

The constructor takes three arguments:
inptnames Cell array of input port names
inptrates Vector of input port rates
outpname Name for the output port
omx = MuxCard({'inp1','inp2','inp3','inp4'},[3 12 12 48],'outp')
omx =
1x4 MuxCard array with properties:
InPutNames: {'inp1'

12-76

'inp2'

'inp3'

'inp4'}

Class to Represent Hardware

OutPutName: 'outp'
OutPutRate: 75
int32 data:
3

12

12

48

Call Methods of int32

Use a MuxCard object like an array of int32 values. For example, this indexing
statement accesses the data in the object to determine the names of the input ports that
have a rate of 12:
omx.InPutNames(omx==12)
ans =
'inp2'

'inp3'

The indexing statement generates a logical array index:

omx == 12
ans =
0

Indexing the MuxCard object accesses the int32 vector of input port rates:
omx(1:2)
ans =
3

12

The OutPutRate property get access method uses sum to sum the output port rates:
omx.OutPutRate
ans =
75

Related Examples

Subclasses of Built-In Types with Properties on page 12-61

12-77

12

How to Build on Other Classes

Determine Array Class

In this section...
Query the Class Name on page 12-78
Test for Array Class on page 12-78
Test for Specific Types on page 12-79
Test for Most Derived Class on page 12-80

Query the Class Name

To determine the class of an array, use the class function:
a = [2,5,7,11];
class(a)
ans =
double
str = 'Character array';
class(str)
ans =
char

Test for Array Class

The isa function enables you to test for a specific class or a category of numeric class
(numeric, float, integer):
a = [2,5,7,11];
isa(a,'double')
ans =
1

Floating-point values (single and double precision values):

isa(a,'float')
ans =

12-78

Determine Array Class

Numeric values (floating-point and integer values):

isa(a,'numeric')
ans =
1

isa Returns True for Subclasses

isa returns true for classes derived from the specified class. For example, the SubInt
class derives from the built-in type int16:
classdef SubInt < int16
methods
function obj = SubInt(data)
if nargin == 0
data = 0;
end
obj = obj@int16(data);
end
end
end

By definition, an instance of the SubInt class is also an instance of the int16 class:
aInt = SubInt;
isa(aInt,'int16')
ans =
1

Using the integer category also returns true:

isa(aInt,'integer')
ans =
1

Test for Specific Types

The class function returns the name of the most derived class of an object:
class(aInt)

12-79

12

How to Build on Other Classes

ans =
SubInt

Use the strcmp function with the class function to check for a specific class of an
object:
a = int16(7);
strcmp(class(a),'int16')
ans =
1

Because the class function returns the class name as a char vector, the inheritance of
objects does not affect the result of the comparison performed by strcmp:
aInt = SubInt;
strcmp(class(aInt),'int16')
ans =
0

Test for Most Derived Class

If you define functions that require inputs that are:
MATLAB built-in types
Not subclasses of MATLAB built-in types
Use the following techniques to exclude subclasses of built-in types from the input
arguments.
Define a cell array that contains the names of built-in types accepted by your
function.
Call class and strcmp to test for specific types in a MATLAB control statement.
Test an input argument:
if strcmp(class(inputArg),'single')
% Call function
else
inputArg = single(inputArg);
end

12-80

Determine Array Class

Test for Category of Types

Suppose that you create a MEX-function, myMexFcn, that requires two numeric inputs
that must be of type double or single:
outArray = myMexFcn(a,b)

Define a cell array that contains the character arrays double and single:
floatTypes = {'double','single'};
% Test for proper types
if any(strcmp(class(a),floatTypes)) && ...
any(strcmp(class(b),floatTypes))
outArray = myMexFcn(a,b);
else
% Try to convert inputs to avoid error
...
end

Another Test for Built-In Types

Use isobject to separate built-in types from subclasses of built-in types. The isobject
function returns false for instances of built-in types:
% Create a int16 array
a = int16([2,5,7,11]);
isobject(a)
ans =
0

Determine if an array is one of the built-in integer types:

if isa(a,'integer') && ~isobject(a)
% a is a built-in integer type
...
end

12-81

12

How to Build on Other Classes

Abstract Classes
In this section...
Abstract Classes on page 12-82
Declare Classes as Abstract on page 12-83
Determine If a Class Is Abstract on page 12-84
Find Inherited Abstract Properties and Methods on page 12-85

Abstract Classes
Abstract classes are useful for describing functionality that is common to a group of
classes, but requires unique implementations within each class.
Abstract Class Terminology
abstract class A class that cannot be instantiated, but that defines class components
used by subclasses.
abstract members Properties or methods declared in an abstract class, but
implemented in subclasses.
concrete members Properties or methods that are fully implement by a class.
concrete class A class that can be instantiated. Concrete classes contain no abstract
members.
interface An abstract class describing functionality that is common to a group of
classes, but that requires unique implementations within each class. The abstract class
defines the interface of each subclass without specifying the actual implementation.
An abstract class serves as a basis (that is, a superclass) for a group of related subclasses.
An abstract class can define abstract properties and methods that subclasses must
implement. Each subclass can implement the concrete properties and methods in a way
that supports their specific requirements.
Abstract classes can define properties and methods that are not abstract, and do not
need to define any abstract members. Abstract classes pass on their concrete members
through inheritance.
12-82

Abstract Classes

Implementing a Concrete Subclass

A subclass must implement all inherited abstract properties and methods to become a
concrete class. Otherwise, the subclass is itself an abstract class.

Declare Classes as Abstract

A class is abstract when it declares:
The Abstract class attribute
An abstract method
An abstract property
If a subclass of an abstract class does not define concrete implementations for all
inherited abstract methods or properties, it is also abstract.
Abstract Class
Declare a class as abstract in the classdef statement:
classdef (Abstract) AbsClass
...
end

For classes that declare the Abstract class attribute:

Concrete subclasses must redefine any properties or methods that are declared as
abstract.
The abstract class does not need to define any abstract methods or properties.
When you define any abstract methods or properties, MATLAB automatically sets the
class Abstract attribute to true.
Abstract Methods
Define an abstract method:
methods (Abstract)
abstMethod(obj)
end

For methods that declare the Abstract method attribute:

12-83

12

How to Build on Other Classes

Do not use a function...end block to define an abstract method, use only the
method signature.
Abstract methods have no implementation in the abstract class.
Concrete subclasses are not required to support the same number of input and output
arguments and do not need to use the same argument names. However, subclasses
generally use the same signature when implementing their version of the method.
Abstract Properties
Define an abstract property:
properties (Abstract)
AbsProp
end

For properties that declare the Abstract property attribute:

Concrete subclasses must redefine abstract properties without the Abstract
attribute.
Concrete subclasses must use the same values for the SetAccess and GetAccess
attributes as those attributes used in the abstract superclass.
Abstract properties cannot define access methods and cannot specify initial values.
The subclass that defines the concrete property can create access methods and specify
initial values.
For more information on access methods, see Property Access Methods on page 8-23.

Determine If a Class Is Abstract

Determine if a class is abstract by querying the Abstract property of its meta.class
object. For example, the AbsClass defines two abstract methods:
classdef AbsClass
methods(Abstract)
result = absMethodOne(obj)
output = absMethodTwo(obj)
end
end

Use the logical value of the meta.class Abstract property to determine if the class is
abstract:
12-84

Abstract Classes

mc = ?AbsClass;
if ~mc.Abstract
% not an abstract class
end

Display Abstract Member Names

Use the meta.abstractDetails function to display the names of abstract properties or
methods and the names of the defining classes:
meta.abstractDetails('AbsClass');
Abstract methods for class AbsClass:
absMethodTwo
% defined in AbsClass
absMethodOne
% defined in AbsClass

Find Inherited Abstract Properties and Methods

The meta.abstractDetails function returns the names and defining class of any
inherited abstract properties or methods that you have not implemented in your
subclass. Use this function if you want the subclass to be concrete and must determine
what abstract members the subclass inherits.
For example, suppose that you create a subclass of the AbsClass class that is defined
in the previous section. In this case, the subclass implements only one of the abstract
methods defined by AbsClass.
classdef SubAbsClass < AbsClass
% Does not implement absMethodOne
% defined as abstract in AbsClass
methods
function out = absMethodTwo(obj)
...
end
end
end

Determine if you implemented all inherited class members using

meta.abstractDetails:
meta.abstractDetails(?SubAbsClass)
Abstract methods for class SubAbsClass:

12-85

12

How to Build on Other Classes

absMethodOne

% defined in AbsClass

The SubAbsClass class is abstract because it has not implemented the absMethodOne
method defined in AbsClass.
msub = ?SubAbsClass;
msub.Abstract
ans =
1

If you implement both methods defined in AbsClass, the subclass becomes concrete.

Related Examples

12-86

Define an Interface Superclass on page 12-87

Define an Interface Superclass

Define an Interface Superclass

In this section...
Interfaces on page 12-87
Interface Class Implementing Graphs on page 12-87

Interfaces
The properties and methods defined by a class form the interface that determines how
class users interact with objects of the class. When creating a group of related classes,
interfaces define a common interface to all these classes. The actual implementations of
the interface can differ from one class to another.
Consider a set of classes designed to represent various types of graphs. All classes must
implement a Data property to contain the data used to generate the graph. However, the
form of the data can differ considerably from one type of graph to another. Each class can
implement the Data property differently.
The same differences apply to methods. All classes can have a draw method that creates
the graph, but the implementation of this method changes with the type of graph.
The basic idea of an interface class is to specify the properties and methods that each
subclass must implement without defining the actual implementation. This approach
enables you to enforce a consistent interface to a group of related objects. As you add
more classes in the future, the interface remains the same.

Interface Class Implementing Graphs

This example creates an interface for classes used to represent specialized graphs. The
interface is an abstract class that defines properties and methods that the subclasses
must implement, but does not specify how to implement these components.
This approach enforces the use of a consistent interface while providing the necessary
flexibility to implement the internal workings of each specialized subclass differently.
In this example, a package folder contains the interface, derived subclasses, and a utility
function:
+graphics/GraphInterface.m % abstract interface class

12-87

12

How to Build on Other Classes

+graphics/LineGraph.m

% concrete subclass

Interface Properties and Methods

The graph class specifies the following properties, which the subclasses must define:
Primitive Handle of the graphics object used to implement the specialized
graph. The class user has no need to access these objects directly so this property has
protected SetAccess and GetAccess.
AxesHandle Handle of the axes used for the graph. The specialized graph
objects can set axes object properties. This property has protected SetAccess and
GetAccess.
Data All subclasses of the GraphInterface class must store data. The type of
data varies and each subclass defines the storage mechanism. Subclass users can
change the data values so this property has public access rights.
The GraphInterface class names three abstract methods that subclasses must
implement. The GraphInterface class also suggests in comments that each subclass
constructor must accept the plot data and property name/property value pairs for all
class properties.
Subclass constructor Accept data and P/V pairs and return an object.
draw Used to create a drawing primitive and render a graph of the data according
to the type of graph implemented by the subclass.
zoom Implementation of a zoom method by changing the axes CameraViewAngle
property. The interface suggests the use of the camzoom function for consistency
among subclasses. The zoom buttons created by the addButtons static method use
this method as a callback.
updateGraph Method called by the set.Data method to update the plotted data
whenever the Data property changes.
Interface Guides Class Design
The package of classes that derive from the GraphInterface abstract class implement
the following behaviors:
Creating an instance of a specialized GraphInterface object (subclass object)
without rendering the plot
Specifying any or none of the object properties when you create a specialized
GraphInterface object
12-88

Define an Interface Superclass

Changing any object property automatically updates the currently displayed plot
Allowing each specialized GraphInterface object to implement whatever additional
properties it requires to give class users control over those characteristics.
Define the Interface
The GraphInterface class is an abstract class that defines the methods and
properties used by the subclasses. Comments in the abstract class describe the intended
implementation:
classdef GraphInterface < handle
% Abstract class for creating data graphs
% Subclass constructor should accept
% the data that is to be plotted and
% property name/property value pairs
properties (SetAccess = protected, GetAccess = protected)
Primitive
AxesHandle
end
properties
Data
end
methods (Abstract)
draw(obj)
% Use a line, surface,
% or patch graphics primitive
zoom(obj,factor)
% Change the CameraViewAngle
% for 2D and 3D views
% use camzoom for consistency
updateGraph(obj)
% Update the Data property and
% update the drawing primitive
end
methods
function set.Data(obj,newdata)
obj.Data = newdata;
updateGraph(obj)
end
function addButtons(gobj)
hfig = get(gobj.AxesHandle,'Parent');
uicontrol(hfig,'Style','pushbutton','String','Zoom Out',...
'Callback',@(src,evnt)zoom(gobj,.5));

12-89

12

How to Build on Other Classes

uicontrol(hfig,'Style','pushbutton','String','Zoom In',...
'Callback',@(src,evnt)zoom(gobj,2),...
'Position',[100 20 60 20]);
end
end
end

The GraphInterface class implements the property set method (set.Data) to

monitor changes to the Data property. An alternative is to define the Data property as
Abstract and enable the subclasses to determine whether to implement a set access
method for this property. The GraphInterface class defines a set access method that
calls an abstract method (updateGraph, which each subclass must implement). The
GraphInterface interface imposes a specific design on the whole package of classes,
without limiting flexibility.
Method to Work with All Subclasses
The addButtons method adds push buttons for the zoom methods, which each subclass
must implement. Using a method instead of an ordinary function enables addButtons
to access the protected class data (the axes handle). Use the object zoom method as the
push-button callback.
function addButtons(gobj)
hfig = get(gobj.AxesHandle,'Parent');
uicontrol(hfig,'Style','pushbutton',...
'String','Zoom Out',...
'Callback',@(src,evnt)zoom(gobj,.5));
uicontrol(hfig,'Style','pushbutton',...
'String','Zoom In',...
'Callback',@(src,evnt)zoom(gobj,2),...
'Position',[100 20 60 20]);
end

Derive a Concrete Class LineGraph

This example defines only a single subclass used to represent a simple line graph. It
derives from GraphInterface, but provides implementations for the abstract methods
draw, zoom, updateGraph, and its own constructor. The base class GraphInterface
and subclass are all contained in a package (graphics), which you must use to reference
the class name:
classdef LineGraph < graphics.GraphInterface

12-90

Define an Interface Superclass

Add Properties
The LineGraph class implements the interface defined in the GraphInterface class
and adds two additional propertiesLineColor and LineType. This class defines initial
values for each property, so specifying property values in the constructor is optional. You
can create a LineGraph object with no data, but you cannot produce a graph from that
object.
properties
LineColor = [0 0 0];
LineType = '-';
end

The LineGraph Constructor

The constructor accepts a struct with x and y coordinate data, and property name/
property value pairs:
function gobj = LineGraph(data,varargin)
if nargin > 0
gobj.Data = data;
if nargin > 2
for k=1:2:length(varargin)
gobj.(varargin{k}) = varargin{k+1};
end
end
end
end

Implement the draw Method

The LineGraph draw method uses property values to create a line object. The
LineGraph class stores the line handle as protected class data. To support the use of no
input arguments for the class constructor, draw checks the Data property to determine if
it is empty before proceeding:
function gobj = draw(gobj)
if isempty(gobj.Data)
error('The LineGraph object contains no data')
end
h = line(gobj.Data.x,gobj.Data.y,...
'Color',gobj.LineColor,...
'LineStyle',gobj.LineType);
gobj.Primitive = h;

12-91

12

How to Build on Other Classes

gobj.AxesHandle = get(h,'Parent');
end

Implement the zoom Method

The LineGraph zoom method follows the comments in the GraphInterface class which
suggest using the camzoom function. camzoom provides a convenient interface to zooming
and operates correctly with the push buttons created by the addButtons method.
Define the Property Set Methods
Property set methods provide a convenient way to execute code automatically when
the value of a property changes for the first time in a constructor. (See Property Set
Methods on page 8-29.) The linegraph class uses set methods to update the line
primitive data (which causes a redraw of the plot) whenever a property value changes.
The use of property set methods provides a way to update the data plot quickly without
requiring a call to the draw method. The draw method updates the plot by resetting all
values to match the current property values.
Three properties use set methods: LineColor, LineType, and Data. LineColor and
LineType are properties added by the LineGraph class and are specific to the line
primitive used by this class. Other subclasses can define different properties unique to
their specialization (for example, FaceColor).
The GraphInterface class implements the Data property set method. However, the
GraphInterface class requires each subclass to define a method called updateGraph,
which handles the update of plot data for the specific drawing primitive used.
The LineGraph Class
Here is the LineGraph class definition.
classdef LineGraph < graphics.GraphInterface
properties
LineColor = [0 0 0];
LineType = '-';
end
methods
function gobj = LineGraph(data,varargin)
if nargin > 0
gobj.Data = data;
if nargin > 1
for k=1:2:length(varargin)

12-92

Define an Interface Superclass

gobj.(varargin{k}) = varargin{k+1};
end
end
end
end
function gobj = draw(gobj)
if isempty(gobj.Data)
error('The LineGraph object contains no data')
end
h = line(gobj.Data.x,gobj.Data.y,...
'Color',gobj.LineColor,...
'LineStyle',gobj.LineType);
gobj.Primitive = h;
gobj.AxesHandle = h.Parent;
end
function zoom(gobj,factor)
camzoom(gobj.AxesHandle,factor)
end
function updateGraph(gobj)
set(gobj.Primitive,...
'XData',gobj.Data.x,...
'YData',gobj.Data.y)
end
function set.LineColor(gobj,color)
gobj.LineColor = color;
set(gobj.Primitive,'Color',color)
end
function set.LineType(gobj,ls)
gobj.LineType = ls;
set(gobj.Primitive,'LineStyle',ls)
end
end
end

Use the LineGraph Class

The LineGraph class defines the simple API specified by the graph base class and
implements its specialized type of graph:
d.x = 1:10;

12-93

12

How to Build on Other Classes

d.y = rand(10,1);
lg = graphics.LineGraph(d,'LineColor','b','LineType',':');
lg.draw;
lg.addButtons;

Clicking the Zoom In button shows the zoom method providing the callback for the
button.

Changing properties updates the graph:

12-94

Define an Interface Superclass

d.y = rand(10,1);
lg.Data = d;
lg.LineColor = [0.9,0.1,0.6];

Now click Zoom Out and see the new results:

Related Examples

Abstract Classes on page 12-82

12-95

13
Saving and Loading Objects
Save and Load Process for Objects on page 13-2
Reduce MAT-File Size for Saved Objects on page 13-4
Save Object Data to Recreate Graphics Objects on page 13-6
Improve Version Compatibility with Default Values on page 13-8
Avoid Property Initialization Order Dependency on page 13-10
Modify the Save and Load Process on page 13-14
Basic saveobj and loadobj Pattern on page 13-17
Maintain Class Compatibility on page 13-21
Initialize Objects When Loading on page 13-28
Save and Load Objects from Class Hierarchies on page 13-30
Restore Listeners on page 13-33
Save and Load Dynamic Properties on page 13-36

13

Saving and Loading Objects

Save and Load Process for Objects

In this section...
Save and Load Objects on page 13-2
What Information Is Saved? on page 13-2
How Is the Property Data Loaded? on page 13-2
Errors During Load on page 13-3

Save and Load Objects

Use save and load to store and reload objects:
save filename object
load filename object

What Information Is Saved?

Saving objects in MAT-files saves:
The full name of the object class, including any package qualifiers
Values of dynamic properties
The names and values of all properties, except properties that have their Transient,
Constant, or Dependent attributes set to true
For a description of property attributes, see Specify Property Attributes on page 8-6
To save graphics objects, see savefig.
Note: Do not use the pack command with objects that define events and listeners. The
pack command causes the destructor of any listeners defined for the objects in the
workspace. For information on restoring listeners when saving objects, see Restore
Listeners on page 13-33.

How Is the Property Data Loaded?

When loading objects from MAT-files, load restores the object. The load function:
13-2

Save and Load Process for Objects

Creates a new object.

Calls the class constructor with no arguments only if the class ConstructOnLoad
attribute is set to true. Otherwise, load does not call the class constructor.
Assigns the saved property values to the object properties. These assignments result
in calls to property set methods defined by the class (except in the case of Dependent
or Transient properties, which are not saved or loaded).
You can use property set methods to ensure that property values are still valid in cases
where the class definition has changed.
For information on property set methods, see Property Set Methods on page 8-29.

Errors During Load

If a new version of a class removes or renames a property, load can generate an error
when attempting to set the altered or deleted property.
When an error occurs while an object is being loaded from a file, MATLAB does one of the
following:
If the class defines a loadobj method, MATLAB returns the saved values to the
loadobj method in a struct.
If the class does not define a loadobj method, MATLAB silently ignores the errors.
The load function reconstitutes the object with property values that do not produce
an error.
In the struct passed to the loadobj method, the field names correspond to the
property names. The field values are the saved values for the corresponding properties.
If the saved object derives from multiple superclasses that have private properties with
same name, the struct contains only the property value of the most direct superclass.
For information on how to implement saveobj and loadobj methods, see Modify the
Save and Load Process on page 13-14.

13-3

13

Saving and Loading Objects

Reduce MAT-File Size for Saved Objects

In this section...
Default Values on page 13-4
Dependent Properties on page 13-4
Transient Properties on page 13-4
Avoid Saving Unwanted Variables on page 13-5

Default Values
If a property often has the same value, define a default value for that property. When the
user saves the object to a MAT-file, MATLAB does not save the value of a property if the
current value equals the default value. MATLAB saves the default value on a per class
basis to avoid saving the value for every object.
For more information on how MATLAB evaluates default value expressions, see
Property Default Values on page 8-14.

Dependent Properties
Use a dependent property when the property value must be calculated at run time. A
dependent property is not saved in the MAT-file when you save an object. Instances of
the class do not allocate memory to hold a value for a dependent property.
Dependent is a property attribute (see Property Attributes on page 8-7 for a complete
list.)

Transient Properties
MATLAB does not store the values of transient properties. Transient properties can store
data in the object temporarily as an intermediate computation step or for faster retrieval.
Use transient properties when you easily can reproduce the data at run time or when the
data represents intermediate state that can be discarded.

13-4

Reduce MAT-File Size for Saved Objects

Avoid Saving Unwanted Variables

Do not save variables that you do not want to load. Be sure that an object is still valid
before you save it. For example, if you save a deleted handle object, MATLAB loads it as
a deleted handle.

Related Examples

Modify the Save and Load Process on page 13-14

13-5

13

Saving and Loading Objects

Save Object Data to Recreate Graphics Objects

In this section...
What to Save on page 13-6
Regenerate When Loading on page 13-6
Change to a Stairstep Chart on page 13-7

What to Save
Use transient properties to avoid saving what you can recreate when loading the object.
For example, an object can contain component parts that you can regenerate from data
that is saved. Regenerating these components also enables newer versions of the class to
create the components in a different way.

Regenerate When Loading

The YearlyRainfall class illustrates how to regenerate a graph when loading objects
of that class. YearlyRainfall objects contain a bar chart of the monthly rainfall for
a given location and year. The Location and Year properties are ordinary properties
whose values are saved when you save the object.
The Chart property contains the handle to the bar chart. When you save a bar chart,
MATLAB also saves the figure, axes, and Bar object as well as the data required to create
these graphics objects. The YearlyRainfall class design eliminates the need to save
objects that it can regenerate:
The Chart property is Transient so the graphics objects are not saved.
ChartData is a private property that provides storage for the Bar object data
(YData).
The load function calls the set.ChartData method, passing it the saved bar chart
data.
The setup method regenerates the bar chart and assigns the handle to the Chart
property. Both the class constructor and the set.ChartData method call setup.
classdef YearlyRainfall < handle
properties
Location
Year

13-6

Save Object Data to Recreate Graphics Objects

end
properties(Transient)
Chart
end
properties(Access = private)
ChartData
end
methods
function rf = YearlyRainfall(data)
setup(rf,data);
end
function set.ChartData(obj,V)
setup(obj,V);
end
function V = get.ChartData(obj)
V = obj.Chart.YData;
end
end
methods(Access = private)
function setup(rf,data)
rf.Chart = bar(data);
end
end
end

Change to a Stairstep Chart

An advantage of the YearlyRainfall class design is the flexibility to modify the type
of graph used without making previously saved objects incompatible. Loading the object
recreates the graph based only on the data that is saved to the MAT-file.
For example, change the type of graph from a bar chart to a stair-step graph by
modifying the setup method:
methods(Access = private)
function setup(rf,data)
rf.Chart = stairs(data);
end
end

Related Examples

Modify the Save and Load Process on page 13-14

13-7

13

Saving and Loading Objects

Improve Version Compatibility with Default Values

In this section...
Version Compatibility on page 13-8
Using a Default Property Value on page 13-8

Version Compatibility
Default property values can help you implement version compatibility for saved objects.
For example, suppose that you add a property to version 2 of your class. Having a default
value enables MATLAB to assign a value to the new property when loading a version 1
object.
Similarly, suppose version 2 of your class removes a property. If a version 2 object is
saved and loaded into version 1, your loadobj method can use the default value from
version 1.

Using a Default Property Value

The EmployeeInfo class shows how to use property default values as a way to enhance
compatibility among versions. Version 1 of the EmployeeInfo class defines three
properties Name, JobTitle, and Department.
classdef EmployeeInfo
properties
Name
JobTitle
Department
end
end

Version 2 of the EmployeeInfo class adds a property, Country, for the country name of
the employee location. The Country property has a default value of 'USA'.
classdef EmployeeInfo
properties
Name
JobTitle
Department
Country = 'USA';

13-8

Improve Version Compatibility with Default Values

end
end

The character array, 'USA', is a good default value because:

MATLAB assigns and empty double [] to properties that do not have default values
defined by the class. Empty double is not a valid value for the Country property.
In version 1, all employees were in the USA. Therefore, any version 1 object loaded
into version 2 receives a valid value for the Country property.

Related Examples

Modify the Save and Load Process on page 13-14

13-9

13

Saving and Loading Objects

Avoid Property Initialization Order Dependency

In this section...
Control Property Loading on page 13-10
Dependent Property with Private Storage on page 13-10
Property Value Computed from Other Properties on page 13-12

Control Property Loading

Problems loading properties can occur when property values depend on the order in
which the properties are set.
Suppose your class design is such that both of the following are true:
A property set method changes another property value.
A property value is computed solely from other property values.
Then the final state of an object after changing a series of property values can depend on
the order in which you set the properties. This order dependency can affect the result of
loading an object.
The load function sets property values in a particular order. This order can be different
from the order in which you set the properties in the saved object. As a result, the loaded
object can have different property values than the object had when it was saved.
Restore Nondependent Properties
If a property set function changes the values of other properties, then define the
Dependent attribute of that property as true. MATLAB does not save or restore
dependent property values.
Use nondependent properties for storing the values set by the dependent property. Then
the load function restores the nondependent properties with the same values that were
saved. The load function does not call the dependent property set method because there
is no value in the saved file for that property.

Dependent Property with Private Storage

The Odometer class avoids order dependences when loading objects by controlling which
properties are restored when loading:
13-10

Avoid Property Initialization Order Dependency

The Units property is dependent. Its property set method sets the TotalDistance
property. Therefore load does not call the Units property set method.
The load function restores TotalDistance to whatever value it had when you saved
the object.
classdef Odometer
properties(Constant)
ConversionFactor = 1.6
end
properties
TotalDistance = 0
end
properties(Dependent)
Units
end
properties(Access=private)
PrivateUnits = 'mi'
end
methods
function unit = get.Units(obj)
unit = obj.PrivateUnits;
end
function obj = set.Units(obj,newUnits)
% validate newUnits to be a char vector
switch(newUnits)
case 'mi'
if strcmp(obj.PrivateUnits,'km')
obj.TotalDistance = obj.TotalDistance / ...
obj.ConversionFactor;
obj.PrivateUnits = newUnits;
end
case 'km'
if strcmp(obj.PrivateUnits,'mi')
obj.TotalDistance = obj.TotalDistance * ...
obj.ConversionFactor;
obj.PrivateUnits = newUnits;
end
otherwise
error('Odometer:InvalidUnits', ...
'Units ''%s'' is not supported.', newUnits);
end
end
end
end

13-11

13

Saving and Loading Objects

Suppose that you create an instance of Odometer and set the following property values:
odObj = Odometer;
odObj.Units = 'km';
odObj.TotalDistance = 16;

When you save the object:

ConversionFactor is not saved because it is a Constant property.
TotalDistance is saved.
Units is not saved because it is a Dependent property.
PrivateUnits is saved and provides the storage for the current value of Units.
When you load the object:
ConversionFactor is obtained from the class definition.
TotalDistance is loaded.
Units is not loaded, so its set method is not called.
PrivateUnits is loaded from the saved object.
If the Units property was not Dependent, loading it calls its set method and causes the
TotalDistance property to be set again.

Property Value Computed from Other Properties

The Odometer2 class TripDistance property depends only on the values of two other
properties, TotalDistance and TripMarker.
The class avoids order dependence when initializing property values during the load
process by making the TripDistance property dependent. MATLAB does not save or
load a value for the TripDistance property, but does save and load values for the two
properties used to calculate TripDistance in its property get method.
classdef Odometer2
properties
TotalDistance = 0
TripMarker = 0
end
properties(Dependent)
TripDistance

13-12

Avoid Property Initialization Order Dependency

end
methods
function distance = get.TripDistance(obj)
distance = obj.TotalDistance - obj.TripMarker;
end
end
end

Related Examples

Modify the Save and Load Process on page 13-14

13-13

13

Saving and Loading Objects

Modify the Save and Load Process

In this section...
When to Modify the Save and Load Process on page 13-14
How to Modify the Save and Load Process on page 13-14
Implementing saveobj and loadobj Methods on page 13-14
Additional Considerations on page 13-15

When to Modify the Save and Load Process

The primary reason for modifying the save and load process is to support backward and
forward compatibility of classes. Consider modifying the save and load process when you:
Rename a class
Remove properties
Define a circular reference of handle objects where initialization order is important
Must call the constructor with arguments and, therefore, cannot use
ConstructOnLoad

How to Modify the Save and Load Process

The most versatile technique for modifying the save and load process is to implement
loadobj, and if necessary, saveobj methods for your class. MATLAB executes these
methods when you call save or load on an object of the class.
The save function calls your class saveobj method before performing the save
operation. The save function then saves the value returned by the saveobj method. You
can use saveobj to return a modified object or a struct that contains property values.
load calls your class loadobj method after loading the object. The load function loads
the value returned by the loadobj method into the workspace. A loadobj method can
modify the object being loaded or can reconstruct an object from the data saved by the
class saveobj method.

Implementing saveobj and loadobj Methods

Implement a saveobj method that modifies the object being saved, then implement a
loadobj method to return the object to the correct state when loading it.
13-14

Modify the Save and Load Process

Implement the loadobj method as a Static method because MATLAB can call the
loadobj method with a struct instead of an object of the class.
Implement the saveobj method as an ordinary method (that is, calling it requires an
instance of the class).
MATLAB saves the object class name so that load can determine which loadobj
method to call in cases where your saveobj method saves only the object data in a
structure. Therefore, the class must be accessible to MATLAB when you load the object.
Use a loadobj method when:
The class definition has changed since the object was saved, requiring you to modify
the object before loading.
A saveobj method modified the object during the save operation, perhaps saving
data in a struct. Implement the loadobj method to reconstruct the object from the
output of saveobj.

Additional Considerations
When you decide to modify the default save and load process, keep the following points in
mind:
If loading any property value from the MAT-file produces an error, load passes a
struct to loadobj. The struct field names correspond to the property names
extracted from the file.
loadobj must always be able to accept a struct as input and return an object, even
if there is no saveobj or saveobj does not return a struct.
If saveobj returns a struct, then load always passes that struct to loadobj.
Subclass objects inherit superclass loadobj and saveobj methods. Therefore, if you
do not implement a loadobj or saveobj method in the subclass, MATLAB calls only
the inherited methods.
If a superclass implements a loadobj or saveobj method, then a subclass can
also implement a loadobj or saveobj method that calls the superclass methods.
For more information, see Save and Load Objects from Class Hierarchies on page
13-30.
The load function does not call the constructor by default. For more information, see
Initialize Objects When Loading on page 13-28.
13-15

13

Saving and Loading Objects

Related Examples

13-16

Basic saveobj and loadobj Pattern on page 13-17

Basic saveobj and loadobj Pattern

Basic saveobj and loadobj Pattern

In this section...
Using saveobj and loadobj on page 13-17
Handle Load Problems on page 13-18

Using saveobj and loadobj

Depending on the requirements of your class, there are various ways you can use
saveobj and loadobj methods. This pattern is a flexible way to solve problems that you
cannot address by simpler means.
The basic process is:
Use saveobj to save all essential data in a struct and do not save the object.
Use loadobj to reconstruct the object from the saved data.
This approach is not useful in cases where you cannot save property values in a struct
field. Data that you cannot save, such as a file identifier, you can possibly regenerate in
the loadobj method.
saveobj
For this pattern, define saveobj as an ordinary method that accepts an object of the
class and returns a struct.
Copy each property value to a structure field of the same name.
You can save only the data that is necessary to rebuild the object. Avoid saving whole
objects hierarchies, such as those created by graphs.
methods
function s = saveobj(obj)
s.Prop1 = obj.Prop1;
s.Prop2 = obj.Prop2
s.Data = obj.GraphHandle.YData;
end
end

13-17

13

Saving and Loading Objects

loadobj
Define loadobj as a static method. Create an object by calling the class constructor.
Then assign values to properties from the struct passed to loadobj. Use the data to
regenerate properties that were not saved.
methods(Static)
function obj = loadobj(s)
if isstruct(s)
newObj = ClassConstructor;
newObj.Prop1 = s.Prop1;
newObj.Prop2 = s.Prop2
newObj.GraphHandle = plot(s.Data);
obj = newObj;
else
obj = s;
end
end
end

If the load function encounters an error, load passes loadobj a struct instead of
an object. Your loadobj method must always be able to handle a struct as the input
argument. The input to loadobj is always a scalar.

Handle Load Problems

loadobj can handle a struct input even if you are not using a saveobj method.
The GraphExpression class creates a graph of a MATLAB expression over a specified
range of data. GraphExpression uses its loadobj method to regenerate the graph,
which is not save with the object.
classdef GraphExpression
properties
FuncHandle
Range
end
methods
function obj = GraphExpression(fh,rg)
obj.FuncHandle = fh;
obj.Range = rg;
makeGraph(obj)
end

13-18

Basic saveobj and loadobj Pattern

function makeGraph(obj)
rg = obj.Range;
x = min(rg):max(rg);
data = obj.FuncHandle(x);
plot(data)
end
end
methods (Static)
function obj = loadobj(s)
if isstruct(s)
fh = s.FuncHandle;
rg = s.Range;
obj = GraphExpression(fh,rg);
else
makeGraph(s);
obj = s;
end
end
end
end

Save and Load Object

Create an object with an anonymous function and a range of data as inputs:
h = GraphExpression(@(x)x.^4,[1:25])
h =
GraphExpression with properties:
FuncHandle: @(x)x.^4
Range: [1x25 double]

Save the GraphExpression object and close the graph:

save myFile h
close

Load the object. MATLAB recreates the graph:

load myFile h

If the load function cannot create the object and passes a struct to loadobj, loadobj
attempts to create an object with the data supplied.
13-19

13

Saving and Loading Objects

Related Examples

13-20

Modify the Save and Load Process on page 13-14

Maintain Class Compatibility

Maintain Class Compatibility

In this section...
Rename Property on page 13-21
Update Property When Loading on page 13-23
Maintaining Compatible Versions of a Class on page 13-24
Version 2 of the PhoneBookEntry Class on page 13-25

Rename Property
Suppose you want to rename a property, but do not want to cause errors in existing
code that refer to the original property. For example, rename a public property called
OfficeNumber to Location. Here is the original class definition:
classdef EmployeeList
properties
Name
Email
OfficeNumber % Rename as Location
end
end

Use of a hidden dependent property can achieve the desired results.

In the class definition, set the OfficeNumber property attributes to Dependent and
Hidden.
Create a property set method for OfficeNumber that sets the value of the Location
property.
Create a property get method for OfficeNumber that returns the value of the
Location location property.
While the OfficeNumber property is hidden, existing code can continue to access this
property. The Hidden attribute does not affect access.
Because OfficeNumber is dependent, there is no redundancy in storage required by
adding the new property. MATLAB does not store or save dependent properties.
Here is the updated class definition.
13-21

13

Saving and Loading Objects

classdef EmployeeList
properties
Name
Email
Location
end
properties (Dependent, Hidden)
OfficeNumber
end
methods
function obj = set.OfficeNumber(obj,val)
obj.Location = val;
end
function val = get.OfficeNumber(obj)
val = obj.Location;
end
end
end

Saving and Loading EmployeeList Objects

You can load old instances of the EmployeeList class in the presence of the new class
version. Code that refers to the OfficeNumber property continues to work.
Forward and Backward Compatibility
Suppose you want to be able to load new EmployeeList objects into systems that still
have the old version of the EmployeeList class. To achieve compatibility with old and
new versions:
Define the OfficeNumber property as Hidden, but not Dependent.
Define the Location property as Dependent.
In this version of the EmployeeList class, the OfficeNumber property saves the value
used by the Location property. Loading an object assigns values of the three original
properties (Name, Email, and OfficeNumber), but does not assign a value to the new
Location property. The lack of the Location property in the old class definition is not a
problem.
classdef EmployeeList
properties
Name
Email

13-22

Maintain Class Compatibility

end
properties (Dependent)
Location
end
properties (Hidden)
OfficeNumber
end
methods
function obj = set.Location(obj,val)
obj.OfficeNumber = val;
end
function val = get.Location(obj)
val = obj.OfficeNumber;
end
end
end

Update Property When Loading

Suppose that you modify a class so that a property value changes in its form or type.
Previously saved objects of the class must be updated when loaded to have a conforming
property value.
Consider a class that has an AccountID property. Suppose that all account numbers
must migrate from eight-digit numeric values to 12-element character arrays.
You can accommodate this change by implementing a loadobj method.
The loadobj method:
Tests to determine if the load function passed a struct or object. All loadobj
methods must handle both struct and object when there is an error in load.
Tests to determine if the AccountID number contains eight digits. If so, change it to a
12-element character array by calling the paddAccID method.
After updating the AccountID property, loadobj returns a MyAccount object that
MATLAB loads into the workspace.
classdef MyAccount
properties
AccountID
end

13-23

13

Saving and Loading Objects

methods
function obj = padAccID(obj)
ac = obj.AccountID;
acstr = num2str(ac);
if length(acstr) < 12
obj.AccountID = [acstr,repmat('0',1,12-length(acstr))];
end
end
end
methods (Static)
function obj = loadobj(a)
if isstruct(a)
obj = MyAccount;
obj.AccountID = a.AccountID;
obj = padAccID(obj);
elseif isa(a,'MyAccount')
obj = padAccID(a);
end
end
end
end

You do not need to implement a saveobj method. You are using loadobj only to ensure
that older saved objects are brought up to date while loading.

Maintaining Compatible Versions of a Class

The PhoneBookEntry class uses a combination of techniques to maintain compatibility
with new versions of the class.
Suppose that you define a class to represent an entry in a phone book. The
PhoneBookEntry class defines three properties: Name, Address, and PhoneNumber.
classdef PhoneBookEntry
properties
Name
Address
PhoneNumber
end
end

However, in future releases, the class will add more properties. To provide flexibility,
PhoneBookEntry saves property data in a struct using its saveobj method.
13-24

Maintain Class Compatibility

methods
function s = saveobj(obj)
s.Name = obj.Name;
s.Address = obj.Address;
s.PhoneNumber = obj.PhoneNumber;
end
end

The loadobj method creates the PhoneBookEntry object, which is then loaded into the
workspace.
methods (Static)
function obj = loadobj(s)
if isstruct(s)
newObj = PhoneBookEntry;
newObj.Name = s.Name;
newObj.Address = s.Address;
newObj.PhoneNumber = s.PhoneNumber;
obj = newObj;
else
obj = s;
end
end
end

Version 2 of the PhoneBookEntry Class

In version 2 of the PhoneBookEntry class, you split the Address property into
StreetAddress, City, State, and ZipCode properties.
With these changes, you could not load a version 2 object in a previous release. However,
version 2 employs a number of techniques to enable compatibility:
Preserve the Address property (which is used in version 1) as a Dependent property
with private SetAccess.
Define an Address property get method (get.Address) to build a char vector that
is compatible with the version 2 Address property.
The saveobj method invokes the get.Address method to assign the object data to a
struct that is compatible with previous versions. The struct continues to have only
an Address field built from the data in the new StreetAddress, City, State, and
ZipCode properties.
13-25

13

Saving and Loading Objects

When the loadobj method sets the Address property, it invokes the property
set method (set.Address), which extracts the substrings required by the
StreetAddress, City, State, and ZipCode properties.
The Transient (not saved) property SaveInOldFormat enables you to specify
whether to save the version 2 object as a struct or an object.
classdef PhoneBookEntry
properties
Name
StreetAddress
City
State
ZipCode
PhoneNumber
end
properties (Constant)
Sep = ', ';
end
properties (Dependent, SetAccess=private)
Address
end
properties (Transient)
SaveInOldFormat = false;
end
methods (Static)
function obj = loadobj(s)
if isstruct(s)
obj = PhoneBookEntry;
obj.Name = s.Name;
obj.Address = s.Address;
obj.PhoneNumber = s.PhoneNumber;
else
obj = s;
end
end
end
methods
function address = get.Address(obj)
address = [obj.StreetAddress,obj.Sep,obj.City,obj.Sep,...
obj.State,obj.Sep,obj.ZipCode];
end
function obj = set.Address(obj,address)
addressItems = regexp(address,obj.Sep,'split');
if length(addressItems) == 4

13-26

Maintain Class Compatibility

obj.StreetAddress = addressItems{1};
obj.City = addressItems{2};
obj.State = addressItems{3};
obj.ZipCode = addressItems{4};
else
error('PhoneBookEntry:InvalidAddressFormat', ...
'Invalid address format.');
end
end
function s = saveobj(obj)
if obj.SaveInOldFormat
s.Name = obj.Name;
s.Address = obj.Address;
s.PhoneNumber = obj.PhoneNumber;
end
end
end
end

Related Examples

Modify the Save and Load Process on page 13-14

13-27

13

Saving and Loading Objects

Initialize Objects When Loading

In this section...
Calling Constructor When Loading Objects on page 13-28
Initializing Objects in the loadobj Method on page 13-28

Calling Constructor When Loading Objects

MATLAB does not call the class constructor when loading an object from a MAT-file.
However, if you set the ConstructOnLoad class attribute to true, load does call the
constructor with no arguments.
Enable ConstructOnLoad when you do not want to implement a loadobj method, but
must perform some actions at construction time. For example, enable ConstructOnLoad
when you are registering listeners for another object. Ensure that MATLAB can call the
class constructor with no arguments without generating an error.
If the constructor requires input arguments, use a loadobj method.

Initializing Objects in the loadobj Method

Use a loadobj method when the class constructor requires input arguments to perform
object initialization.
The LabResults class shares the constructor object initialization steps with the
loadobj method by performing these steps in the assignStatus method.
Objects of the LabResults class:
Hold values for the results of tests.
Assign a status for each value based on a set of criteria.
classdef LabResult
properties
CurrentValue
end
properties (Transient)
Status

13-28

Initialize Objects When Loading

end
methods
function obj = LabResult(cv)
obj.CurrentValue = cv;
obj = assignStatus(obj);
end
function obj = assignStatus(obj)
v = obj.CurrentValue;
if v < 10
obj.Status = 'Too low';
elseif v >= 10 && v < 100
obj.Status = 'In range';
else
obj.Status = 'Too high';
end
end
end
methods (Static)
function obj = loadobj(s)
if isstruct(s)
cv = s.CurrentValue;
obj = LabResults(cv);
else
obj = assignStatus(s);
end
end
end
end

The LabResults class uses loadobj to determine the status of a given test value. This
approach provides a way to:
Modify the criteria for determining status
Ensure that objects always use the current criteria
You do not need to implement a saveobj method.

Related Examples

Modify the Save and Load Process on page 13-14

13-29

13

Saving and Loading Objects

Save and Load Objects from Class Hierarchies

In this section...
Saving and Loading Subclass Objects on page 13-30
Reconstruct the Subclass Object from a Saved struct on page 13-30

Saving and Loading Subclass Objects

If the most specific class of an object does not define a loadobj or saveobj method, this
class can inherit loadobj or saveobj methods from a superclass.
If any class in the hierarchy defines saveobj or loadobj methods:
Define saveobj for all classes in the hierarchy.
Call superclass saveobj methods from the subclass saveobj method because the
save function calls only the most specific saveobj method.
The subclass loadobj method can call the superclass loadobj, or other methods as
required, to assign values to their properties.

Reconstruct the Subclass Object from a Saved struct

Suppose you want to save a subclass object by first converting its property data to a
struct in the class saveobj method. Then you reconstruct the object when loaded using
its loadobj method. This action requires that:
Superclasses implement saveobj methods to save their property data in the struct.
The subclass saveobj method calls each superclass saveobj method and returns the
completed struct to the save function. Then the save function writes the struct to
the MAT-file.
The subclass loadobj method creates a subclass object and calls superclass methods
to assign their property values in the subclass object.
The subclass loadobj method returns the reconstructed object to the load function,
which loads the object into the workspace.
The following superclass (MySuper) and subclass (MySub) definitions show how to code
these methods.
13-30

Save and Load Objects from Class Hierarchies

The MySuper class defines a loadobj method to enable an object of this class to be
loaded directly.
The subclass loadobj method calls a method named reload after it constructs the
subclass object.
reload first calls the superclass reload method to assign superclass property values
and then assigns the subclass property value.
classdef MySuper
properties
X
Y
end
methods
function S = saveobj(obj)
S.PointX = obj.X;
S.PointY = obj.Y;
end
function obj = reload(obj,S)
obj.X = S.PointX;
obj.Y = S.PointY;
end
end
methods (Static)
function obj = loadobj(S)
if isstruct(s)
obj = MySuper;
obj = reload(obj,S);
end
end
end
end

Call the superclass saveobj and loadobj methods from the subclass saveobj and
loadobj methods.
classdef MySub < MySuper
properties
Z
end
methods
function S = saveobj(obj)
S = saveobj@MySuper(obj);
S.PointZ = obj.Z;

13-31

13

Saving and Loading Objects

end
function obj = reload(obj,S)
obj = reload@MySuper(obj,S);
obj.Z = S.PointZ;
end
end
methods (Static)
function obj = loadobj(S)
if isstruct(s)
obj = MySub;
obj = reload(obj,S);
end
end
end
end

Related Examples

13-32

Modify the Save and Load Process on page 13-14

Restore Listeners

Restore Listeners
In this section...
Create Listener with loadobj on page 13-33
Use Transient Property to Load Listener on page 13-33
Using the BankAccount and AccountManager Classes on page 13-35

Create Listener with loadobj

Suppose that you create a property listener and want to be able to save and restore the
event source and the listener. One approach is to create a listener from the loadobj
method.

Use Transient Property to Load Listener

The BankAccount class stores the account balance and an account status. A PostSet
listener attached to the AccountBalance property controls the account status.
When the AccountBalance property value changes, the listener callback determines the
account status. Important points include:
The BankAccount class defines the AccountManagerListener property to contain
the listener handle. This property enables the loadobj method to create a listener
and return a reference to it in the object that is loaded into the workspace.
The AccountManagerListener property is Transient because there is no need
to store the listener handle with a BankAccount object. Create a listener that is
attached to the new BankAccount object created during the load process.
The AccountBalance listener sets the AccountStatus.
Only the AccountManager class can access AccountStatus property.
classdef BankAccount < handle
properties (SetObservable, AbortSet)
AccountBalance
end
properties (Transient)
AccountManagerListener
end
properties (Access = ?AccountManager)

13-33

13

Saving and Loading Objects

AccountStatus
end
methods
function obj = BankAccount(initialBalance)
obj.AccountBalance = initialBalance;
obj.AccountStatus = 'New Account';
obj.AccountManagerListener = AccountManager.addAccount(obj);
end
end
methods (Static)
function obj = loadobj(obj)
if isstruct(obj) % Handle possble error
initialBalance = obj.AccountBalance;
obj = BankAccount(initialBalance);
else
obj.AccountManagerListener = AccountManager.addAccount(obj);
end
end
end
end

Assume the AccountManager class provides services for various types of accounts. For
the BankAccount class, the AccountManager class defines two Static methods:
assignStatus Callback for the AccountBalance property PostSet listener.
This method determines the value of the BankAccount AccountStatus property.
addAccount Creates the AccountBalance property PostSet listener. The
BankAccount constructor and loadobj methods call this method.
classdef AccountManager
methods (Static)
function assignStatus(BA,~)
if BA.AccountBalance < 0 && BA.AccountBalance >= -100
BA.AccountStatus = 'overdrawn';
elseif BA.AccountBalance < -100
BA.AccountStatus = 'frozen';
else
BA.AccountStatus = 'open';
end
end
function lh = addAccount(BA)
lh = addlistener(BA,'AccountBalance','PostSet', ...
@(src,evt)AccountManager.assignStatus(BA));
end

13-34

Restore Listeners

end
end

Using the BankAccount and AccountManager Classes

Create an instance of the BankAccount class.
ba = BankAccount(100)
ba =
BankAccount with properties:
AccountBalance: 100
AccountManagerListener: [1x1 event.proplistener]
AccountStatus: 'New Account'

Now set an account value to confirm that the AccountManager sets AccountStatus
appropriately:
ba.AccountBalance = -10;
ba.AccountStatus
ans =
overdrawn

Related Examples

Modify the Save and Load Process on page 13-14

Property Attributes on page 8-7

Listen for Changes to Property Values on page 11-37

13-35

13

Saving and Loading Objects

Save and Load Dynamic Properties

In this section...
Saving Dynamic Properties on page 13-36
When You Need saveobj and loadobj Methods on page 13-36
Implementing saveobj and loadobj Methods on page 13-36

Saving Dynamic Properties

Use the addprop method to add dynamic properties to a class that is derived from the
dynamicprops class. The save function saves dynamic properties with the object to
which they are attached. For more information on dynamic properties, see Dynamic
Properties Adding Properties to an Instance on page 8-41.

When You Need saveobj and loadobj Methods

The save function saves dynamic properties and their values. However, save does not
save dynamic property attributes because these attributes are not specified in the class
definition. If you save an object that has dynamic properties with nondefault attributes
values, use saveobj and loadobj to manage the saving and loading of attribute values.
If the dynamic property has nondefault attribute values, convert the object to a struct
in the saveobj method. Save the dynamic property attribute values in the struct so
that the loadobj method can restore these values.

Implementing saveobj and loadobj Methods

Your saveobj method can obtain the nondefault attribute values from the
meta.DynamicProperty object associated with the dynamic property. Suppose the
object that you are saving has a dynamic property called DynoProp. Create a struct in
the saveobj method to save the data that the loadobj method uses to reconstruct the
object.
Here is how the saveobj method works:
Obtain the meta.DynamicProperty object for the dynamic property.
Store the name and value of the dynamic property in struct s.
13-36

Save and Load Dynamic Properties

Store the nondefault dynamic property attributes values for SetAccess and
GetAccess in the struct. The loadobj function restores these values.
methods
function s = saveobj(obj)
metaDynoProp = findprop(obj,'DynoProp');
s.dynamicprops(1).name = metaDynoProp.Name;
s.dynamicprops(1).value = obj.DynoProp;
s.dynamicprops(1).setAccess = metaDynoProp.SetAccess;
s.dynamicprops(1).getAccess = metaDynoProp.GetAccess;
...
end
end

Your loadobj method can add the dynamic property and set the attribute values:
Create an instance of the class.
Use addprop to add a new dynamic property to the object.
Restore the attributes of the dynamic property.
methods (Static)
function obj = loadobj(s)
if isstruct(s)
obj = ClassConstructor;
...
metaDynoProp = addprop(obj,s.dynamicprops(1).name);
obj.(s.dynamicprops(1).name) = s.dynamicprops(1).value;
metaDynoProp.SetAccess = s.dynamicprops(1).setAccess;
metaDynoProp.GetAccess = s.dynamicprops(1).getAccess;
end
end
end

Related Examples

Modify the Save and Load Process on page 13-14

13-37

14
Enumerations
Named Values on page 14-2
Define Enumeration Classes on page 14-5
Refer to Enumerations on page 14-11
Restrict Property Values to Enumerations on page 14-17
Operations on Enumerations on page 14-19
Enumeration Class Restrictions on page 14-27
Enumerations Derived from Built-In Types on page 14-28
Mutable Handle vs. Immutable Value Enumeration Members on page 14-34
Enumerations That Encapsulate Data on page 14-41
Save and Load Enumerations on page 14-45

14

Enumerations

Named Values
In this section...
Kinds of Predefined Names on page 14-2
Techniques for Defining Enumerations on page 14-3

Kinds of Predefined Names

MATLAB supports two kinds of predefined names:
Constant properties
Enumerations
Constant Properties
Use constant properties when you want a collection of related constant values whose
values can belong to different types (numeric values, character strings, and so on). Define
properties with constant values by setting the property Constant attribute. Reference
constant properties by name whenever you need access to that particular value.
See Properties with Constant Values on page 15-2 for more information.
Enumerations
Use enumerations when you want to create a fixed set of names representing a single
type of value. Use this new type in multiple places without redefining it for each class.
You can derive enumeration classes from other classes to inherit the operations of the
superclass. For example, if you define an enumeration class that subclasses a MATLAB
numeric class like double or int32, the enumeration class inherits all the mathematical
and relational operations that MATLAB defines for those classes.
Using enumerations instead of character strings to represent a value, such as colors
('red'), can result in more readable code because:
You can compare enumeration members with == instead of using strcmp
Enumerations maintain type information, char vectors do not. For example, passing
a char vector 'red' to functions means that every function must interpret what
'red' means. If you define red as an enumeration, the actual value of 'red' can
14-2

Named Values

change (from [1 0 0] to [.93 .14 .14], for example) without updating every
function that accepts colors, as you would if you defined the color as the char vector
'red'.
Define enumerations by creating an enumeration block in the class definition.
See Define Enumeration Classes on page 14-5 for more information.

Techniques for Defining Enumerations

Enumerations enable you to define names that represent entities useful to your
application, without using numeric values or character strings. All enumerations support
equality and inequality operations. Therefore, switch, if, and several comparison
functions like isequal and ismember work with enumeration members.
You can define enumeration classes in ways that are most useful to your application, as
described in the following sections.
Simple Enumerated Names
Simple enumeration classes have no superclasses and no properties. These classes define
a set of related names that have no underlying values associated with them. Use this
kind of enumeration when you want descriptive names, but your application does not
require specific information associated with the name.
See the WeekDays class in the Enumeration Class on page 14-5 and the Define
Methods in Enumeration Classes on page 14-7 sections.
Enumerations with Built-In Class Behaviors
Enumeration classes that subclass MATLAB built-in classes inherit most of the
behaviors of those classes. For example, an enumeration class derived from the double
class inherits the mathematical, relational, and set operations that work with variables
of the class.
Enumerations do not support the colon (:) operator, even if the superclass does.
Enumerations with Properties for Member Data
Enumeration classes that do not subclass MATLAB built-in numeric and logical classes
can define properties. These classes can define constructors that set each member's
unique property values.
14-3

14

Enumerations

The constructor can save input arguments in property values. For example, a Color
class can specify a Red enumeration member color with three (Red, Green, Blue) values:
enumeration
Red (1,0,0)
end

Related Examples

14-4

Enumeration Class Restrictions on page 14-27

Enumerations Derived from Built-In Types on page 14-28

Enumerations That Encapsulate Data on page 14-41

Define Enumeration Classes

Define Enumeration Classes

In this section...
Enumeration Class on page 14-5
Construct an Enumeration Member on page 14-5
Convert to Superclass Value on page 14-6
Define Methods in Enumeration Classes on page 14-7
Define Properties in Enumeration Classes on page 14-7
Enumeration Class Constructor Calling Sequence on page 14-8

Enumeration Class
Create an enumeration class by adding an enumeration block to a class definition. For
example, the WeekDays class enumerates a set of days of the week.
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday
end
end

To execute the MATLAB code in the following sections, place the WeekDays class
definition in a .m file on your path.

Construct an Enumeration Member

Refer to an enumeration member using the class name and the member name:
ClassName.MemberName

For example, assign the enumeration member WeekDays.Tuesday to the variable

today:
today = WeekDays.Tuesday;

today is a variable of class WeekDays:

whos

14-5

14

Enumerations

Name

Size

today

1x1

Bytes
104

Class

Attributes

WeekDays

today
today =
Tuesday

Convert to Superclass Value

If an enumeration class specifies a superclass, convert an enumeration object to the
superclass by passing the object to the superclass constructor. However, the superclass
constructor must be able to accept its own class as input and return an instance of the
superclass. MATLAB built-in numeric classes, such as uint32, allow this conversion.
For example, the Bearing class derives from the uint32 built-in class:
classdef Bearing < uint32
enumeration
North (0)
East (90)
South (180)
West (270)
end
end

Assign the Bearing.East member to the variable a:

a = Bearing.East;

Pass a to the superclass constructor and return a uint32 value:

b = uint32(a);
whos
Name

Size

a
b

1x1
1x1

Bytes
60
4

Class

Attributes

Bearing
uint32

The uint32 constructor accepts an object of the subclass Bearing and returns and
object of class uint32.
14-6

Define Enumeration Classes

Define Methods in Enumeration Classes

Define methods in an enumeration class like any MATLAB class. For example, here is
the WeekDays class with a method called isMeetingDay added:
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday
end
methods
function tf = isMeetingDay(obj)
tf = ~(WeekDays.Tuesday == obj);
end
end
end

Call isMeetingDay with an instance of the WeekDays class:

today = WeekDays.Tuesday;
today.isMeetingDay
ans =
0

Use the enumeration member directly as input to the method:

isMeetingDay(WeekDays.Wednesday)
ans =
1

Define Properties in Enumeration Classes

Add properties to an enumeration class when you must store data related to the
enumeration members. Set the property values in the class constructor. For example, the
SyntaxColors class defines three properties whose values the constructor assigns to the
values of the input arguments when you reference a class member.
classdef SyntaxColors
properties
R
G

14-7

14

Enumerations

B
end
methods
function c = SyntaxColors(r, g, b)
c.R = r; c.G = g; c.B = b;
end
end
enumeration
Error
(1, 0, 0)
Comment (0, 1, 0)
Keyword (0, 0, 1)
String (1, 0, 1)
end
end

When you refer to an enumeration member, the constructor initializes the property
values:
e = SyntaxColors.Error;
e.R
ans =
1

Because SyntaxColors is a value class (it does not derive from handle), only the class
constructor can set property values:
e.R = 0
You cannot set the read-only property 'R' of SyntaxColors.

For more information on enumeration classes that define properties, see Mutable
Handle vs. Immutable Value Enumeration Members on page 14-34.

Enumeration Class Constructor Calling Sequence

Each statement in an enumeration block is the name of an enumeration member,
optionally followed by an argument list. If the enumeration class defines a constructor,
MATLAB calls the constructor to create the enumerated instances.
MATLAB provides a default constructor for all enumeration classes that do not explicitly
define a constructor. The default constructor creates an instance of the enumeration
class:
14-8

Define Enumeration Classes

Using no input arguments, if the enumeration member defines no input arguments

Using the input arguments defined in the enumeration class for that member
For example, the input arguments for the Bool class are 0 for Bool.No and 1 for
Bool.Yes.
classdef Bool < logical
enumeration
No (0)
Yes (1)
end
end

The values of 0 and 1 are of class logical because the default constructor passes the
argument to the first superclass. That is, this statement:
n = Bool.No;

Results in a call to logical that is equivalent to the following statement in a

constructor:
function obj = Bool(val)
obj@logical(val)
end

MATLAB passes the member argument only to the first superclass. For example,
suppose Bool derived from another class:
classdef Bool < logical & MyBool
enumeration
No (0)
Yes (1)
end
end

The MyBool class can add some specialized behavior:

classdef MyBool
methods
function boolValues = testBools(obj)
...
end
end
end

14-9

14

Enumerations

The default Bool constructor behaves as if defined like this function:

Argument passed to first superclass constructor
No arguments passed to subsequent constructors
function obj = Bool(val)
obj@logical(val)
obj@MyBool
end

Related Examples

14-10

Refer to Enumerations on page 14-11

Operations on Enumerations on page 14-19

Refer to Enumerations

Refer to Enumerations
In this section...
Instances of Enumeration Classes on page 14-11
Conversion of Characters to Enumerations on page 14-13
Enumeration Arrays on page 14-15

Instances of Enumeration Classes

Enumeration members are instances of the enumeration class. You can assign
enumeration members to variables and form arrays of enumeration members. If an
enumeration class derives from a superclass, you can substitute an enumeration member
for an instance of the superclass.
The WeekDays class defines enumeration members for five days of the week.
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday
end
end

Create objects of the WeekDays class representing specific days.

today = WeekDays.Monday;
tomorrow = WeekDays.Tuesday;

The variables today and tomorrow are objects of the WeekDays class.
The PPM class defines three enumeration members. Each member has an associated
numeric value derived from the class superclass.
classdef PPM < double
enumeration
High (1000)
Medium (100)
Low (10)
end
end

Assign an enumeration member to a variable.

14-11

14

Enumerations

level = PPM.High;

When you substitute enumeration members for instances of the superclass, MATLAB
coerces the enumeration member to the superclass. For example, add an enumeration
member of the PPM class with a numeric values
levelNew = level + 100
levelNew =
1100

The result is of class double.

whos
Name

Size

level
levelNew

1x1
1x1

Bytes
108
8

Class

Attributes

PPM
double

You can substitute superclass values for enumeration members when the values
correspond. For example, pass one of the numeric values defined in the enumeration
class to the PPMSwitch function.
function PPMSwitch(ppm)
switch ppm
case PPM.Low
disp Low
case PPM.Medium
disp Medium
case PPM.High
disp High
end
end
PPMSwitch(100)
Medium

You can also use an enumeration member directly:

PPMSwitch(PPM.Medium)
Medium

14-12

Refer to Enumerations

For information on operations you can perform on enumeration class instances, see
Operations on Enumerations on page 14-19.

Conversion of Characters to Enumerations

Enumeration classes can convert char vectors to enumeration members when the char
vector represents an enumeration member defined by the class. This conversion enables
you to pass a valid char vector or a cell array of char vectors when enumerations are
expected.
Use a char vector instead of a direct reference to an enumeration member when you
want to use a simple character strings to specify an enumeration member. However,
specifying an enumeration member directly eliminates the conversion from char to
enumeration.
Enumeration classes provide a converter function using the constructor syntax.
today = WeekDays('Tuesday');

Because the char vector 'Tuesday' matches the enumeration member

WeekDays.Tuesday, the Weekdays char method can perform the conversion.
class(today)
ans =
WeekDays

Create an enumeration array using the WeekDay class constructor and a cell array of
char vectors.
wd = WeekDays({'Monday','Wednesday','Friday'})
wd =
Monday

Wednesday

Friday

class(wd)
ans =
WeekDays

14-13

14

Enumerations

All char vectors in the cell array must correspond to an enumeration member defined by
the class.
Coercion of char to Enumerations
MATLAB coerces char vectors into enumerations members when the dominant
argument is an enumeration. Because user-defined classes are dominant over the char
class, MATLAB attempts to convert the char vector to a member of the enumeration
class.
Create an enumeration array. Then insert a char vector that represents an enumeration
member into the array.
a = [WeekDays.Monday,WeekDays.Wednesday,WeekDays.Friday]
a =
Monday

Wednesday

Friday

Add a char vector to the WeekDays array.

a(end+1) = 'Tuesday'
a =
Monday

Wednesday

Friday

Tuesday

MATLAB coerces the char vector to a WeekDays enumeration member.

class(a)
ans =
WeekDays

Substitute Enumeration Members for char Vectors

You can use enumeration members in place of char vectors in cases where functions
require char vectors. For example, this call to sprintf expects a char vector,
designated by the %s format specifier.
sprintf('Today is %s',WeekDays.Friday)
ans =

14-14

Refer to Enumerations

Today is Friday

The automatic conversion of enumeration classes to char enable you to use enumeration
members in this case.

Enumeration Arrays
Create enumeration arrays by:
Concatenating enumeration members using []
Assigning enumeration members to an array using indexed assignment
Create an enumeration array of class WeekDays by concatenating enumeration members:
wd = [WeekDays.Tuesday,WeekDays.Wednesday,WeekDays.Friday];

Create an enumeration array of class WeekDays by indexed assignment:

a(1) = WeekDays.Tuesday;
a(2) = WeekDays.Wednesday;
a(3) = WeekDays.Friday;

Mixed Enumeration Members and char Vectors

You can concatenate enumeration members and char vectors as long as the char vector
represents an enumeration member.
clear a
a = [WeekDays.Wednesday,'Friday'];
class(a)
ans =
WeekDays

You can also assign a char vector to an enumeration array:

clear a
a(1) = WeekDays.Wednesday;
a(2) = 'Friday';
class(a)
ans =

14-15

14

Enumerations

WeekDays

Default Enumeration Member

The default member an enumeration class is the first enumeration member defined in
the enumeration block. For the WeekDays class, the default enumeration member is
WeekDays.Monday.
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday
end
end

MATLAB allows assignment to any element of an array, even if the array variable does
not previously exist. To fill in unassigned array elements, MATLAB uses the default
enumeration member.
For example, assign a value to element 5 of an array, a:
clear a
a(5) = WeekDays.Tuesday;

MATLAB must initialize the values of array elements a(1:4) with the default
enumeration member. The result of the assignment to the fifth element of the array a is:
a
a =
Monday

Monday

Monday

Related Examples

14-16

Operations on Enumerations on page 14-19

Monday

Tuesday

Restrict Property Values to Enumerations

Restrict Property Values to Enumerations

In this section...
Syntax for Property/Enumeration Definition on page 14-17
Example of Restricted Property on page 14-17

Syntax for Property/Enumeration Definition

You can restrict the values that are allowed for a property to members of an enumeration
class. Define the property as restricted to a specific enumeration class in the class
definition using this syntax:
properties
PropName EnumerationClass
end

This syntax restricts values of PropName to members of the enumeration class

EnumerationClass.

Example of Restricted Property

For example, the Days class defines a property named Today. The allowed values for the
Today property are enumeration members of the WeekDays class.
The WeekDays class defines the enumerations:
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday
end
end

Use the WeekDays enumerations to restrict the allowed values of the Today property:
classdef Days
properties
Today WeekDays
end
end

Create an object of the Days class.

14-17

14

Enumerations

d = Days;
d.Today = WeekDays.Tuesday;
d =
Days with properties:
Today: Tuesday

Representing Enumeration Members with char Vectors

The automatic conversion feature enables users of the Days class to assign values to the
Today property as either enumeration members or char vectors. The Today property is
restricted to members of the WeekDays enumeration class. Therefore, you can assign a
char vector that represents a member of the WeekDays class.
d = Days;
d.Today = 'Tuesday';

For more information on restricting property values, see Restrict Class of Properties on
page 8-20.

14-18

Operations on Enumerations

Operations on Enumerations
In this section...
Operations Supported by Enumerations on page 14-19
Enumeration Class on page 14-19
Default Methods on page 14-20
Convert Enumeration Member to Characters on page 14-20
Convert Enumeration Array to Cell Array of char Vectors on page 14-20
Enumerations and char Vectors in Relational Operations on page 14-21
Enumerations in switch Statements on page 14-22
Enumeration Set Membership on page 14-23
Enumeration Text Comparison Methods on page 14-24
How to Get Information About Enumerations on page 14-25
Testing for an Enumeration on page 14-25

Operations Supported by Enumerations

You can use logical, set membership, and string comparison operations on enumerations.
These operations also allow the use of enumeration in conditional statements, such as
switch and if statements. Converters enable you to use char vectors and cell arrays of
strings as enumerations.

Enumeration Class
The WeekDays class defines members that enumerate days of the week. This topic uses
the WeekDays class to illustrate how to perform operations on enumerations.
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday
end
end

For information on defining enumerations, see Define Enumeration Classes on page

14-5.
14-19

14

Enumerations

Default Methods
Enumeration classes have the following default methods:
methods('WeekDays')
Methods for class WeekDays:
WeekDays
cellstr
char

eq
intersect
ismember

ne
setdiff
setxor

strcmp
strcmpi
strncmp

strncmpi
union

The WeekDays method converts char vectors or a cell array of char vectors to
enumerations. Other methods behave similarly to the equivalent function when used
with enumerations. For information on a specific method, see the documentation for that
function.

Convert Enumeration Member to Characters

Conversion to char is useful because you can define enumeration members with
descriptive names. For example:
today = WeekDays.Friday;
['Today is ',char(today)]

ans =
Today is Friday

Convert Enumeration Array to Cell Array of char Vectors

Use cellstr to convert an enumeration array to a cell array of char vectors.
ca = cellstr([WeekDays.Tuesday,WeekDays.Thursday]);
class(ca)
ans =
cell

Both cells in the cell array contain char vectors:

14-20

Operations on Enumerations

class([ca{1:2}])
ans =
char

Enumerations and char Vectors in Relational Operations

Expression involving the relational operators, eq and ne, in which one operand is
an enumeration allow the other operand to be of type char. Before performing the
operation, MATLAB converts char vectors to scalar enumerations or cell arrays of char
vectors to enumeration arrays.
Note: Enumeration classes that derive from MATLAB built-in classes cannot substitute
char vectors for enumeration members.
today = WeekDays.Friday;
today == 'Friday'
ans =
1

Compare enumeration array to char vector:

wd = [WeekDays.Monday,WeekDays.Wednesday,WeekDays.Friday];
wd == 'Friday'
ans =
0

Compare enumeration array to cell array of char vectors:

cv = {'Monday','Wednesday','Friday'};
md = [WeekDays.Tuesday,WeekDays.Thursday,WeekDays.Friday];
md ~= cv
ans =
1

14-21

14

Enumerations

Test equality to implement if statements. The char vector Wednesday is equal to (==)
the enumeration member WeekDays.Wednesday:
today = 'Wednesday';
...
if today == WeekDays.Wednesday
disp('Team meeting at 2:00')
end

Enumerations in switch Statements

Equality (eq) and inequality (ne) methods enable you to use enumeration members
in switch statements. For example, using the WeekDays class defined previously,
construct a switch statement:
function c = Reminder(day)
% Add error checking here
switch(day)
case WeekDays.Monday
c = 'Department meeting at 10:00';
case WeekDays.Tuesday
c = 'Meeting Free Day!';
case {WeekDays.Wednesday WeekDays.Friday}
c = 'Team meeting at 2:00';
case WeekDays.Thursday
c = 'Volleyball night';
end
end

Pass a member of the WeekDays enumeration class to the Reminder function:

today = WeekDays.Wednesday;
Reminder(today)
ans =
Team meeting at 2:00

For more information, see Objects In Conditional Statements on page 5-34.

Substitute char Vectors
Note: Enumeration classes that derive from MATLAB built-in classes cannot substitute
char vectors for enumeration members.
14-22

Operations on Enumerations

You can use char vectors to represent specific enumeration members:

function c = Reminder2(day)
switch(day)
case 'Monday'
c = 'Department meeting at 10:00';
case 'Tuesday'
c = 'Meeting Free Day!';
case {'Wednesday' 'Friday'}
c = 'Team meeting at 2:00';
case 'Thursday'
c = 'Volleyball night';
end
end

Although you can use char vectors instead of specifying enumerations explicitly,
MATLAB must convert the char to an enumeration. Eliminate the need for this
conversion if it is not necessary.

Enumeration Set Membership

Enumeration classes provide methods to determine set membership.
ismember True for elements of an enumeration array if in a set
setdiff Set difference for enumeration arrays
intersect Set intersection for enumeration arrays
setxor Set exclusive-or for enumeration arrays
union Set union for enumeration arrays
Determine if today is a meeting day for your team. Create a set of enumeration members
corresponding to the days on which the team has meetings.
today = WeekDays.Tuesday;
teamMeetings = [WeekDays.Wednesday WeekDays.Friday];

Use ismember to determine if today is part of the teamMeetings set:

ismember(today,teamMeetings)
ans =
0

14-23

14

Enumerations

Mixed Sets of Enumeration and char

If you pass both enumeration and char arguments to an enumeration class method, the
class attempts to convert the char to the class of the enumeration.
Determine if char vector is a member of the enumeration array.
teamMeetings = [WeekDays.Wednesday WeekDays.Friday];
ismember('Friday',teamMeetings)
ans =
1

Determine if the enumeration member is a member of the cell array of char vectors.
ismember(WeekDays.Friday,{'Wednesday','Friday'})
ans =
1

Enumeration Text Comparison Methods

Enumeration classes provide methods to compare enumeration members with char
vectors. One of the arguments to the string comparison method must be a char vector.
Comparing two enumeration members returns false.
strcmp Compare enumeration members
strncmp Compare first n characters of enumeration members
strcmpi Case insensitive comparison of enumeration members
strncmpi Case insensitive first n character comparison of enumeration members
Comparing Enumeration Member with char Vector
The string comparison methods can compare enumeration members and char vectors.
today = WeekDays.Tuesday;
strcmp(today,'Friday')
ans =

14-24

Operations on Enumerations

0
strcmp(today,'Tuesday')
ans =
1

How to Get Information About Enumerations

Obtain information about enumeration classes using the enumeration function. For
example:
enumeration WeekDays
Enumeration members for class 'WeekDays':
Monday
Tuesday
Wednesday
Thursday
Friday

See also Metaclass EnumeratedValues Property on page 16-8

Testing for an Enumeration

To determine if a variable is an enumeration, use the isenum function. For example:
today = WeekDays.Wednesday;
isenum(today)
ans =
1

isenum returns true for empty enumeration objects:

noday = WeekDays.empty;
isenum(noday)
ans =
1

14-25

14

Enumerations

To determine if the class of a variable class is an enumeration class, use the meta.class
object.
today = WeekDays.Wednesday;
mc = metaclass(today);
mc.Enumeration
ans =
1

Related Examples

14-26

Enumeration Class Restrictions on page 14-27

Enumeration Class Restrictions

Enumeration Class Restrictions

Enumeration classes restrict certain aspects of their use and definition:
Enumeration classes are implicitly Sealed. You cannot define a subclass of an
enumeration class because doing so would expand the set.
The properties of value-based enumeration classes are immutable. Only the
constructor can assign property values. MATLAB implicitly defines the SetAccess
attributes of all properties defined by value-based enumeration classes as
immutable. You cannot set the SetAccess attribute to any other value.
All properties inherited by a value-based enumeration class that are not defined as
Constant must have immutable SetAccess.
The properties of handle-based enumeration classes are mutable. You can set
property values on instances of the enumeration class. See Mutable Handle vs.
Immutable Value Enumeration Members on page 14-34.
An enumeration member cannot have the same name as a property, method, or event
defined by the same class.
Enumerations do not support colon (a:b) operations. For example,
FlowRate.Low:FlowRate.High causes an error even if the FlowRate class derives
from a numeric superclass.
Classes that define enumerations cannot restrict properties of the same class to
an enumeration type. You must create a separate enumeration class to restrict
property values to an enumeration. For information on restricting property values,
see Example of Restricted Property on page 14-17.

Related Examples

Enumerations Derived from Built-In Types on page 14-28

14-27

14

Enumerations

Enumerations Derived from Built-In Types

In this section...
Subclassing Built-In Types on page 14-28
Derive Enumeration Class from Numeric Type on page 14-28
How to Alias Enumeration Names on page 14-30
Superclass Constructor Returns Underlying Value on page 14-31
Default Converter on page 14-32

Subclassing Built-In Types

Enumeration classes can subclass MATLAB built-in classes. Deriving an enumeration
class from a built-in classes is useful to extend the usefulness of the enumeration
members.
Enumeration inherit functionality from the built-in class.
You can associate a numeric or logical value with enumeration members.
For a more basic discussion of enumeration classes, see Define Enumeration Classes on
page 14-5.

Derive Enumeration Class from Numeric Type

Note: Enumeration classes derived from built-in numeric and logical classes cannot
define properties.
If an enumeration class subclasses a built-in numeric class, the subclass inherits
ordering and arithmetic operations that you can apply to the enumerated names.
For example, the Results class subclasses the int32 built-in class. This class associates
an integer value with each of the four enumeration members First, Second, Third,
and NoPoints.
classdef Results < int32
enumeration
First
(100)

14-28

Enumerations Derived from Built-In Types

Second (50)
Third
(10)
NoPlace (0)
end
end

The enumeration member inherits the methods of the int32 class (except the colon
operator). Use these enumerations like numeric values (summed, sorted, averaged).
isa(Results.Second,'int32')
ans =
1

For example, use enumeration names instead of numbers to rank two teams:
Team1 = [Results.First, Results.NoPlace, Results.Third, Results.Second];
Team2 = [Results.Second, Results.Third, Results.First, Results.First];

Perform int32 operations on these Results enumerations:

sum(Team1)
ans =
160
mean(Team1)
ans =
40
sort(Team2,'descend')
ans =
First

First

Second

Third

Team1 > Team2

ans =
1

sum(Team1) < sum(Team2)

14-29

14

Enumerations

ans =
1

How to Create Enumeration Instances

When you first refer to an enumeration class that derives from a built-in class such as,
int32, MATLAB passes the input arguments associated with the enumeration members
to the superclass constructor. For example, referencing the Second Results member,
defined as:
Second (50)

means that MATLAB calls:

int32(50)

to initialize the int32 aspect of this Results object.

How to Alias Enumeration Names

Enumeration classes that derive from MATLAB built-in numeric and logical classes can
define more than one name for an underlying value. The first name in the enumeration
block with a given underlying value is the actual name for that underlying value and
subsequent names are aliases.
Specify aliased names with the same superclass constructor argument as the actual
name:
classdef Bool < logical
enumeration
No (0)
Yes (1)
off (0)
on (1)
end
end

For example, the actual name of an instance of the Bool.off enumeration member is
No:
a = Bool.No
a =

14-30

Enumerations Derived from Built-In Types

No
b = Bool.off
b =
No

Superclass Constructor Returns Underlying Value

The actual underlying value associated with an enumeration member is the value
returned by the built-in superclass. For example, consider the Bool class defined with
constructor arguments that are of class double:
classdef Bool < logical
enumeration
No (0)
Yes (100)
end
end

This class derives from the built-in logical class. Therefore, underlying values for an
enumeration member depend only on what value logical returns when passed that
value:
a = Bool.Yes
a =
Yes
logical(a)
ans =
1

How to Subclass Numeric Built-In Classes

The FlowRate enumeration class defines three members, Low, Medium, and High.
classdef FlowRate < int32
enumeration

14-31

14

Enumerations

Low
(10)
Medium (50)
High
(100)
end
end

Reference an instance of an enumeration member:

setFlow = FlowRate.Medium;

This statement causes MATLAB to call the default constructor with the argument value
of 50. MATLAB passes this argument to the first superclass constructor (int32(50)
in this case). The result is an underlying value of 50 as a 32-bit integer for the
FlowRate.Medium member.
Because FlowRate subclasses a built-in numeric class (int32), this class cannot define
properties. However FlowRate inherits int32 methods including a converter method.
Programs can use the converter to obtain the underlying value:
setFlow = FlowRate.Medium;
int32(setFlow)
ans =
50

Default Converter
If an enumeration is a subclass of a built-in numeric class, you can convert from built-in
numeric data to the enumeration using the name of the enumeration class. For example:
a = Bool(1)
a =
Yes

An enumerated class also accepts enumeration members of its own class as input
arguments:
Bool(a)
ans =

14-32

Enumerations Derived from Built-In Types

Yes

The converter returns an object of the same size as in input:

Bool([0,1])
ans =
No

Yes

Create an empty enumeration array using the empty static method:

Bool.empty
ans =
0x0 empty Boolean enumeration.

Related Examples

Mutable Handle vs. Immutable Value Enumeration Members on page 14-34

Fundamental MATLAB Classes

14-33

14

Enumerations

Mutable Handle vs. Immutable Value Enumeration Members

In this section...
Select Handle- or Value-Based Enumerations on page 14-34
Value-Based Enumeration Classes on page 14-34
Handle-Based Enumeration Classes on page 14-36
Represent State with Enumerations on page 14-39

Select Handle- or Value-Based Enumerations

Use a handle enumeration to enumerate a set of objects whose state can change over
time. Use a value enumeration to enumerate a set of abstract (and immutable) values.
For information about handle and value classes, see Comparison of Handle and Value
Classes on page 7-2.

Value-Based Enumeration Classes

A value-based enumeration class has a fixed set of specific values. Modify these values by
changing the values of properties. Doing so expands or changes the fixed set of values for
this enumeration class.
Inherited Property SetAccess Must Be Immutable
Value-based enumeration classes implicitly define the SetAccess attributes of all
properties as immutable. You cannot set the SetAccess attribute to any other value.
However, all superclass properties must explicitly define property SetAccess as
immutable.
Enumeration Members Remain Constant
An instance of a value-based enumeration class is unique until the class is cleared and
reloaded. For example, given this class:
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday

14-34

Mutable Handle vs. Immutable Value Enumeration Members

end
end

MATLAB considers a and b as equivalent:

a = WeekDays.Monday;
b = WeekDays.Monday;
isequal(a,b)
ans =
1
a == b
ans =
1

Enumeration Member Properties Remain Constant

Value-based enumeration classes that define properties are immutable. For example, the
Colors enumeration class associates RGB values with color names.
classdef Colors
properties
R = 0;
G = 0;
B = 0;
end
methods
function c = Colors(r,g,b)
c.R = r; c.G = g; c.B = b;
end
end
enumeration
Red
(1, 0, 0)
Green (0, 1, 0)
Blue (0, 0, 1)
end
end

The constructor assigns the input arguments to R, G, and B properties:

red = Colors.Red;

14-35

14

Enumerations

[red.R,red.G,red.B]
ans =
1

You cannot change a property value:

red.G = 1;
You cannot set the read-only property 'G' of Colors.

Handle-Based Enumeration Classes

Handle-based enumeration classes that define properties are mutable. Derive
enumeration classes from the handle class when you must be able to change property
values on instances of that class.
Note: You cannot derive an enumeration class from matlab.mixin.Copyable because
the number of instances you can create are limited to the ones defined inside the
enumeration block.

An Enumeration Member Remains Constant

Given a handle-based enumeration class with properties, changing the property value of
an instance causes all references to that instance to reflect the changed value.
For example, the HandleColors enumeration class associates RGB values with color
names, the same as the Colors class in the previous example. However, HandleColors
derives from handle:
classdef HandleColors < handle
properties
R = 0;
G = 0;
B = 0;
end
methods
function c = HandleColors(r, g, b)
c.R = r; c.G = g; c.B = b;
end

14-36

Mutable Handle vs. Immutable Value Enumeration Members

end
enumeration
Red
(1, 0, 0)
Green (0, 1, 0)
Blue (0, 0, 1)
end
end

Create an instance of HandleColors.Red and return the value of the R property:

a = HandleColors.Red;
a.R
ans =
1

MATLAB constructs the HandleColors.Red enumeration member, which sets the R

property to 1, the G property to 0, and the B property to 0.
Change the value of the R property to 0.8:
a.R = 0.8;

After setting the value of the R property to 0.8, create another instance, b, of
HandleColors.Red:
b = HandleColors.Red;
b.R
ans =
0.8000

The value of the R property of the newly created instance is also 0.8. A MATLAB session
has only one value for any enumeration member at any given time.
Clearing the workspace variables does not change the current definition of the
enumeration member HandleColors.Red:
clear
a = HandleColors.Red;
a.R
ans =

14-37

14

Enumerations

0.8000

Clear the class to reload the definition of the HandleColors class:

clear classes
a = HandleColors.Red;
a.R
ans =
1

To prevent reassignment of a given property value, set that property's SetAccess

attribute to immutable.
Equality of Handle-Based Enumerations
Assign two variables to a particular enumeration member:
a = HandleColors.Red;
b = HandleColors.Red;

Compare a and b using isequal:

isequal(a,b)
ans =
1

The property values of a and b are the same, so isequal returns true. However, unlike
handle classes that are not enumeration classes, a and b are the same handle because
there is only one enumeration member. Determine handle equality using == (the handle
eq method).
a == b
ans =
1

See the handle eq method for information on how isequal and == differ when used
with handles.
14-38

Mutable Handle vs. Immutable Value Enumeration Members

Represent State with Enumerations

The MachineState class defines two enumeration members to represent the state of a
machine, either running or not running.
classdef MachineState
enumeration
Running
NotRunning
end
end

The Machine class represents a machine with start and stop operations. The
MachineState enumerations are easy to work with because of their eq and char
methods, and they result in code that is easy to read.
classdef Machine < handle
properties (SetAccess = private)
State = MachineState.NotRunning;
end
methods
function start(machine)
if machine.State == MachineState.NotRunning
machine.State = MachineState.Running;
end
disp (machine.State.char)
end
function stop(machine)
if machine.State == MachineState.Running
machine.State = MachineState.NotRunning;
end
disp (machine.State.char)
end
end
end

Create a Machine object and call start and stop methods

m = Machine;
m.start
Running
m.stop

14-39

14

Enumerations

NotRunning

Related Examples

14-40

Enumerations That Encapsulate Data on page 14-41

Enumerations That Encapsulate Data

Enumerations That Encapsulate Data

In this section...
Enumeration Classes with Properties on page 14-41
Store Data in Properties on page 14-41

Enumeration Classes with Properties

Enumeration classes can define properties to store data values. The enumeration
members represent specific values for these properties, which MATLAB assigns in
the class constructor. For information on defining enumeration classes, see Define
Enumeration Classes on page 14-5.

Store Data in Properties

Note: Enumeration classes that subclass built-in numeric or logical classes cannot
define or inherit properties. For more information on this kind of enumeration class, see
Enumerations Derived from Built-In Types on page 14-28 .
Define properties in an enumeration class if you want to associate specific data with
enumeration members, but do not need to inherit arithmetic, ordering, or other
operations that MATLAB defines for specific built-in classes.
Representing Colors
Define an enumeration class to represent the RGB values of the colors in a color set.
The Colors class defines names for the colors, each of which uses the RGB values as
arguments to the class constructor:
classdef Colors
properties
R = 0;
G = 0;
B = 0;
end
methods
function c = Colors(r, g, b)

14-41

14

Enumerations

c.R = r; c.G = g; c.B = b;

end
end
enumeration
Blueish
(18/255,104/255,179/255)
Reddish
(237/255,36/255,38/255)
Greenish (155/255,190/255,61/255)
Purplish (123/255,45/255,116/255)
Yellowish (1,199/255,0)
LightBlue (77/255,190/255,238/255)
end
end

You can asses the property values via the enumeration member:
Colors.Reddish.R
ans =
0.9294

Suppose that you want to create a plot with the new shade of red named Reddish:
a = Colors.Reddish;
[a.R,a.G,a.B]
ans =
0.9294

0.1412

0.1490

Use these values by accessing the enumeration member properties. For example, the
myPlot function accepts a Colors enumeration member as an input argument. The
function accesses the RGB values defining the color from the property values.
function h = myPlot(x,y,LineColor)
h = line('XData',x,'YData',y);
r = LineColor.R;
g = LineColor.G;
b = LineColor.B;
h.Color = [r g b];
end

Create a plot using a reddish color line:

h = myPlot(1:10,1:10,Colors.Reddish);

14-42

Enumerations That Encapsulate Data

The Colors class encapsulates the definitions of a standard set of colors. You can change
the enumeration class definition of the colors and not affect functions that use the
enumerations.
Enumerations Defining Categories
The Cars class defines categories used to inventory automobiles. The Cars class derives
from the CarPainter class, which derives from handle. The abstract CarPainter
class defines a paint method, which modifies the Color property when a car is painted
another color.
The Cars class uses the Colors enumeration members to specify a finite set of available
colors. The exact definition of any given color can change independently of the Cars
class.
classdef Cars < CarPainter
enumeration
Hybrid (2,'Manual',55,Colors.Reddish)
Compact(4,'Manual',32,Colors.Greenish)
MiniVan(6,'Automatic',24,Colors.Blueish)
SUV
(8,'Automatic',12,Colors.Yellowish)
end
properties (SetAccess = private)
Cylinders
Transmission
MPG
Color
end
methods
function obj = Cars(cyl,trans,mpg,colr)
obj.Cylinders = cyl;
obj.Transmission = trans;
obj.MPG = mpg;
obj.Color = colr;
end
function paint(obj,colorobj)
if isa(colorobj,'Colors')
obj.Color = colorobj;
else
[~,cls] = enumeration('Colors');
disp('Not an available color')
disp(cls)
end
end

14-43

14

Enumerations

end
end

The CarPainter class requires its subclasses to define a method called paint:
classdef CarPainter < handle
methods (Abstract)
paint(carobj,colorobj)
end
end

Define an instance of the Cars class:

c1 = Cars.Compact;

The color of this car is Greenish, as defined by the Colors.Greenish enumeration:

c1.Color
ans =
Greenish

Use the paint method to change the car color:

c1.paint(Colors.Reddish)
c1.Color
ans =
Reddish

Related Examples

14-44

Save and Load Enumerations on page 14-45

Restrict Property Values to Enumerations on page 14-17

Save and Load Enumerations

Save and Load Enumerations

In this section...
Basic Knowledge on page 14-45
Built-In and Value-Based Enumeration Classes on page 14-45
Simple and Handle-Based Enumeration Classes on page 14-45
Causes: Load as struct Instead of Object on page 14-46

Basic Knowledge
See the save and load functions and Save and Load Process for Objects on page 13-2
for general information on saving and loading objects.
To see a list of enumeration names defined by a class, use the enumeration function.

Built-In and Value-Based Enumeration Classes

When you save enumerations that derive from built-in classes or that are value-based
classes with properties, MATLAB saves the names of the enumeration members and the
definition of each member.
When loading these enumerations, MATLAB preserves names over underlying values. If
the saved named value is different from the current class definition, MATLAB uses the
value defined in the current class, and then issues a warning.

Simple and Handle-Based Enumeration Classes

When you save simple enumerations that have no properties, superclasses, or values
associated with the member names or enumerations derived from the handle class,
MATLAB saves the names and any underlying values.
When loading these types of enumerations, MATLAB does not check the values
associated with the names in the current class definition. This behavior results from
the fact that simple enumerations have no underlying values and handle-based
enumerations can legally have values that are different than those values defined by the
class.

14-45

14

Enumerations

Causes: Load as struct Instead of Object

If you add a new named value or a new property to a class after saving an enumeration,
MATLAB does not warn during load.
If the changes to the enumeration class definition do not prevent MATLAB from loading
the object (that is, all the named values in the MAT-File are present in the modified class
definition), then MATLAB issues a warning that the class has changed and loads the
enumeration.
In the following cases, MATLAB issues a warning and loads as much of the saved data as
possible as a struct:
MATLAB cannot find the class definition
The class is no longer an enumeration class
MATLAB cannot initialize the class
There is one or more enumeration members in the loaded enumeration that is not in
the class definition
If the class is a value-based enumeration with properties and a property that exists in
the file, is not present in the class definition
struct Fields
The returned struct has these fields:
ValueNames A cell array of strings, one per unique value in the enumeration
array.
Values An array of the same dimension as ValueNames containing the
corresponding values of the enumeration members named in ValueNames. Depending
on the kind of enumeration class, Values can be one of the following:
If the enumeration class derives from a built-in class, the array class is the same
as the built-in class. The values in the array are the underlying values of each
enumeration member.
Otherwise, a struct array representing the property name property values
pairs of each enumeration member. For simple and handle-based enumerations,
the struct array has no fields.
ValueIndices a uint32 array of the same size as the original enumeration.
Each element is an index into the ValueNames and Values arrays. The content of
ValueIndices represents the value of each object in the original enumeration array.
14-46

Save and Load Enumerations

More About

Named Values on page 14-2

14-47

15
Constant Properties

15

Constant Properties

Properties with Constant Values

In this section...
Defining Named Constants on page 15-2
Constant Property Assigned a Handle Object on page 15-4
Constant Property Assigned Any Object on page 15-4
Constant Properties No Support for Get Events on page 15-6

Defining Named Constants

Use constant properties to define constant values that you can access by name. Create
a class with constant properties by declaring the Constant attribute in the property
blocks. Setting the Constant attribute means that, once initialized to the value specified
in the property block, the value cannot be changed.
Assigning Values to Constant Properties
Assign any value to a Constant property, including a MATLAB expression. For
example:
classdef NamedConst
properties (Constant)
R = pi/180;
D = 1/NamedConst.R;
AccCode = '0145968740001110202NPQ';
RN = rand(5);
end
end

MATLAB evaluates the expressions when loading the class. Therefore, the values
MATLAB assigns to RN are the result of a single call to the rand function and do not
change with subsequent references to NamedConst.RN. Calling clear classes causes
MATLAB to reload the class and reinitialize the constant properties.
Referencing Constant Properties
Refer to the constant using the class name and the property name:
ClassName.PropName

15-2

Properties with Constant Values

For example, to use the NamedConst class defined in the previous section, reference the
constant for the degree to radian conversion, R:
radi = 45*NamedConst.R
radi =
0.7854

Constants In Packages
To create a library for constant values that you can access by name, first create a
package folder, then define the various classes to organize the constants. For example, to
implement a set of constants that are useful for making astronomical calculations, define
a AstroConstants class in a package called constants:
+constants/AstroConstants/AstroConstants.m

The class defines a set of Constant properties with values assigned:

classdef AstroConstants
properties (Constant)
C = 2.99792458e8;
G = 6.67259;
Me = 5.976e24;
Re = 6.378e6;
end
end

%
%
%
%

m/s
m/kgs
Earth mass (kg)
Earth radius (m)

To use this set of constants, reference them with a fully qualified class name. For
example, the following function uses some of the constants defined in AstroContants:
function E = energyToOrbit(m,r)
E = constants.AstroConstants.G * constants.AstroConstants.Me * m * ...
(1/constants.AstroConstants.Re-0.5*r);
end

Importing the package into the function eliminates the need to repeat the package name
(see import):
function E = energyToOrbit(m,r)
import constants.*;
E = AstroConstants.G * AstroConstants.Me * m * ...
(1/AstroConstants.Re - 0.5 * r);
end

15-3

15

Constant Properties

Constant Property Assigned a Handle Object

If a class defines a constant property with a value that is a handle object, you can assign
values to the handle object properties. Create a local variable to access the handle object.
For example, the ConstMapClass class defines a constant property. The value of the
constant property is a handle object (a containers.Map object).
classdef ConstMapClass < handle
properties (Constant)
ConstMapProp = containers.Map;
end
end

To assign the current date to the Date key, return the handle from the constant
property, then make the assignment using the local variable on the left side of the
assignment statement:
localMap = ConstMapClass.ConstMapProp
localMap('Date') = datestr(clock);

You cannot use a reference to a constant property on the left side of an assignment
statement. For example, MATLAB interprets the following statement as the creation of a
struct named ConstantMapClass with a field ConstMapProp:
ConstMapClass.ConstMapProp('Date') = datestr(clock);

Constant Property Assigned Any Object

You can assign an instance of the defining class to a constant property. MATLAB creates
the instance assigned to the constant property when loading the class. Use this technique
only when the defining class is a handle class.
The MyProject is an example of such a class:
classdef MyProject < handle
properties (Constant)
ProjectInfo = MyProject;
end
properties
Date
Department
ProjectNumber

15-4

Properties with Constant Values

end
methods (Access = private)
function obj = MyProject
obj.Date = datestr(clock);
obj.Department = 'Engineering';
obj.ProjectNumber = 'P29.367';
end
end
end

Reference property data via the Constant property:

MyProject.ProjectInfo.Date
ans =
18-Apr-2002 09:56:59

Because MyProject is a handle class, you can get the handle to the instance that is
assigned to the constant property:
p = MyProject.ProjectInfo;

Access the data in the MyProject class using this handle:

p.Department
ans =
Engineering

Modify the nonconstant properties of the MyProject class using this handle:
p.Department = 'Quality Assurance';

p is a handle to the instance of MyProject that is assigned to the ProjectInfo

constant property:
MyProject.ProjectInfo.Department
ans =
Quality Assurance

Clearing the class results in the assignment of a new instance of MyProject to the
ProjectInfo property.
15-5

15

Constant Properties

clear MyProject
MyProject.ProjectInfo.Department
ans =
Engineering

You can assign an instance of the defining class as the default value of a property only
when the property is declared as Constant

Constant Properties No Support for Get Events

Constant properties do not support property PreGet or PostGet events. MATLAB
issues a warning during class initialization if you set the GetObservable attribute of a
Constant property to true.

Related Examples

Static Data on page 4-2

More About

15-6

Named Values on page 14-2

16
Information from Class Metadata
Class Metadata on page 16-2
Class Introspection with Metadata on page 16-5
Find Objects with Specific Values on page 16-10
Get Information About Properties on page 16-14
Find Default Values in Property Metadata on page 16-20

16

Information from Class Metadata

Class Metadata
In this section...
What Is Class Metadata? on page 16-2
The meta Package on page 16-3
Metaclass Objects on page 16-3
Metaclass Object Lifecycle on page 16-4

What Is Class Metadata?

Class metadata is information about class definitions that is available from various
metaclasses objects. Use metaclass objects to obtain information without having to create
instances of the class. Metadata enables the programmatic inspection of classes. Each
metaclass has properties, methods, and events that contain information about the class
or class component it describes.
All class components have an associated metaclass, which you access from
the meta.class object. For example, create the meta.class object for the
matlab.mixin.Copyable class:
mc = ?matlab.mixin.Copyable
mc =
class with properties:
Name:
Description:
DetailedDescription:
Hidden:
Sealed:
Abstract:
Enumeration:
ConstructOnLoad:
HandleCompatible:
InferiorClasses:
ContainingPackage:
PropertyList:
MethodList:
EventList:

16-2

'matlab.mixin.Copyable'
'Implement copy method for handle objects in MA...'
''
0
0
1
0
1
1
{0x1 cell}
[1x1 meta.package]
[0x1 meta.property]
[19x1 meta.method]
[1x1 meta.event]

Class Metadata

EnumerationMemberList: [0x1 meta.EnumeratedValue]

SuperclassList: [1x1 meta.class]

The meta Package

The meta package contains metaclasses that describe the definition of classes and class
components. The class name indicates the component described by the metaclass. For
example, each class property has a meta.property associated with it. Attributes defined
for class components correspond to properties in the respective metaclass object.
meta.package Access from meta.class ContainingPackage property.
meta.class Create from class name or class object using metaclass function or ?
operator.
meta.property Access from meta.class PropertyList property.
meta.DynamicProperty Obtain from the addprop method.
meta.method Access from meta.class MethodList property.
meta.event Access from meta.class EventList property.
meta.EnumeratedValue Access from meta.class
EnumerationMemberListList property.

Metaclass Objects
You cannot instantiate metaclasses directly by calling the respective class constructor.
Create metaclass objects from class instances or from the class name.
?ClassName Returns a meta.class object for the named class. Use
meta.class.fromName with class names stored as characters in variables.
meta.class.fromName('ClassName') returns the meta.class object for the
named class (meta.class.fromName is a meta.class method).
metaclass(obj) Returns a metaclass object for the class instance (metaclass)
Create meta.class object from class name using the ? operator:
mc = ?MyClass;

Create meta.class object from class name using the fromName method:
mc = meta.class.fromName('MyClass');

16-3

16

Information from Class Metadata

Create meta.class object from class instance

obj = MyClass;
mc = metaclass(obj);

The metaclass function returns the meta.class object (that is, an object of the
meta.class class). You can obtain other metaclass objects (meta.property,
meta.method, and so on) from the meta.class object.
Note: Metaclass is a term used here to refer to all of the classes in the meta package.
meta.class is a class in the meta package whose instances contain information about
MATLAB classes. Metadata is information about classes contained in metaclasses.

Metaclass Object Lifecycle

When you change a class definition, MATLAB reloads the class definition. If instances of
the class exist, MATLAB updates those objects according to the new definition.
However, MATLAB does not update existing metaclass objects to the new class
definition. If you change a class definition while metaclass objects of that class exist,
MATLAB deletes the metaclass objects and their handles become invalid. You must
create a new metaclass object after updating the class.
For information on how to modify and reload classes, see Automatic Updates for
Modified Classes on page 5-47.

Related Examples

16-4

Class Introspection with Metadata on page 16-5

Find Objects with Specific Values on page 16-10

Get Information About Properties on page 16-14

Find Default Values in Property Metadata on page 16-20

Class Introspection with Metadata

Class Introspection with Metadata

In this section...
Using Class Metadata on page 16-5
Inspect the EmployeeData Class on page 16-5
Metaclass EnumeratedValues Property on page 16-8

Using Class Metadata

Use class metadata to get information about classes and objects programmatically. For
example, you can determine attribute values for class members or get a list of events
defined by the class. For basic information about metadata, see Class Metadata on page
16-2.

Inspect the EmployeeData Class

The EmployeeData class is a handle class with two properties, one of which has private
Access and defines a set access method.
classdef EmployeeData < handle
properties
EmployeeName
end
properties (Access = private)
EmployeeNumber
end
methods
function obj = EmployeeData(name,ss)
if nargin > 0
obj.EmployeeName = name;
obj.EmployeeNumber = ss;
end
end
function set.EmployeeName(obj,name)
if ischar(name)
obj.EmployeeName = name;
else
error('Employee name must be a char vector')
end

16-5

16

Information from Class Metadata

end
end
end

Inspect Class Definition

Using the EmployeeData class, create a meta.class object using the ? operator:
mc = ?EmployeeData;

Determine from what classes EmployeeData derives. The returned value is a

meta.class object for the handle superclass:
a = mc.SuperclassList;
a.Name
ans =
handle

The EmployeeData class has only one superclass. For classes having more than one
direct superclass, a contains a meta.class object for each superclass.
Use an indexed reference to refer to any particular superclass:
a(1).Name

or, directly from mc:

mc.SuperclassList(1).Name
ans =
handle

The SuperclassList property contains only direct superclasses.

Inspect Properties
Find the names of the properties defined by the EmployeeData class. First obtain an
array of meta.properties objects from the meta.class PropertyList property.
mc = ?EmployeeData;
mpArray = mc.PropertyList;

16-6

Class Introspection with Metadata

The length of mpArray indicates there are two meta.property objects, one for each
property defined by the EmployeeData class:
length(mpArray)
ans =
2

Now get a meta.property object from the array:

prop1 = mpArray(1);
prop1.Name
ans =
EmployeeName

The Name property of the meta.property object identifies the class property
represented by that meta.property object.
Query other meta.property object properties to determine the attributes of the
EmployeeName properties.
Find Component with Specific Attribute
You can use indexing techniques to list class components that have specific attribute
values. For example, this code lists the methods in the EmployeeData class that have
private access:
mc = ?EmployeeData;
mc.PropertyList(ismember({mc.PropertyList(:).SetAccess},'private')).Name
ans =
EmployeeNumber

Note that Access is not a property of the meta.property class. You must use
SetAccess and GetAccess, which are properties of the meta.property class.
Find components with attributes that are logical values using a statement like this:
mc = ?handle;
mc.MethodList(ismember([mc.MethodList(:).Hidden],true)).Name
ans =

16-7

16

Information from Class Metadata

empty

Inspect Class Instance

Create an EmployeeData object and determine property access settings:
EdObj = EmployeeData('My Name',1234567);
mcEdObj = metaclass(EdObj);
mpArray = mcEdObj.PropertyList;
EdObj.(mpArray(1).Name) % Dynamic field names work with objects

The value of the EmployeeName property is the text My Name, which was assigned in the
constructor.
ans =
My Name

The value of the EmployeeNumber property is not accessible because the property has
private Access.
EdObj.(mpArray(2).Name)
You cannot get the 'EmployeeNumber' property of EmployeeData.
mpArray(2).GetAccess
ans =
private

Obtain a function handle to the EmployeeName property set access function:

mpArray(1).SetMethod
ans =
@D:\MyDir\@EmployeeData\EmployeeData.m>EmployeeData.set.EmployeeName

Metaclass EnumeratedValues Property

The meta.class EnumeratedValues property contains an array of
meta.EnumeratedValue objects, one for each enumeration member. Use the
meta.EnumeratedValue Name property to obtain the enumeration member names
defined by an enumeration class. For example, given the WeekDays enumeration class:
classdef WeekDays
enumeration
Monday, Tuesday, Wednesday, Thursday, Friday

16-8

Class Introspection with Metadata

end
end

Query enumeration names from the meta.class object:

mc = ?WeekDays;
mc.EnumerationMemberList(2).Name
ans =
Tuesday

Related Examples

Find Objects with Specific Values on page 16-10

16-9

16

Information from Class Metadata

Find Objects with Specific Values

In this section...
Find Handle Objects on page 16-10
Find by Attribute Settings on page 16-11

Find Handle Objects

Use the handle class findobj method to find objects that have properties with specific
values. For example, the following class defines a PhoneBook object to represent a
telephone book entry in a data base. The PhoneBook class subclasses the dynamicprops
class, which derives from handle.
classdef PhoneBook < dynamicprops
properties
Name
Address
Number
end
methods
function obj = PhoneBook(n,a,p)
obj.Name = n;
obj.Address = a;
obj.Number = p;
end
end
end

Here are three of the PhoneBook entries in the database:

PB(1) = PhoneBook('Nancy Vidal','123 Washington Street','5081234567');
PB(2) = PhoneBook('Nancy Vidal','123 Main Street','5081234568');
PB(3) = PhoneBook('Nancy Wong','123 South Street','5081234569');

One of these three PhoneBook objects has a dynamic property:

PB(2).addprop('HighSpeedInternet');
PB(2).HighSpeedInternet = '1M';

Find Property/Value Pairs

Find the object representing employee Nancy Wong and display the name and number by
concatenating the strings:
16-10

Find Objects with Specific Values

NW = findobj(PB,'Name','Nancy Wong');
[NW.Name,' - ',NW.Number]
ans =
Nancy Wong - 5081234569

Find Objects with Specific Property Names

Search for objects with specific property names using the -property option:
H = findobj(PB,'-property','HighSpeedInternet');
H.HighSpeedInternet
ans =
1M

The -property option enables you to omit the value of the property and search for
objects using only the property name.
Using Logical Expressions
Search for specific combinations of property names and values:
H = findobj(PB,'Name','Nancy Vidal','-and','Address','123 Main Street');
H.Number

ans =
5081234568

Find by Attribute Settings

All metaclasses derive from the handle class. You can use the handle findobj method to
find class members that have specific attribute settings.
For example, find the abstract methods in a class definition by searching the
meta.class MethodList for meta.method objects with their Abstract property set to
true:
Use the class name in character format because class is abstract. You cannot create an
object of the class:
mc = meta.class.fromName('MyClass');

16-11

16

Information from Class Metadata

Search the MethodList list of meta.method objects for those methods that have their
Abstract property set to true:
absMethods = findobj(mc.MethodList,'Abstract',true);
methodNames = {absMethods.Name};

The cell array, methodNames, contains the names of the abstract methods in the class.
Find Properties That Have Public Get Access
Find the names of all properties in the containers.Map class that have public
GetAccess:
Get the meta.class object.
Use findobj to search the array of meta.property objects.
Use braces to create a cell array of property names.
mc = ?containers.Map;
mpArray = findobj(mc.PropertyList,'GetAccess','public');
names = {mpArray.Name};

Display the names of all containers.Map properties that have public GetAccess:
celldisp(names)
names{1} =
Count
names{2} =
KeyType
names{3} =
ValueType

Find Static Methods

Determine if any containers.Map class methods are static:
~isempty(findobj([mc.MethodList(:)],'Static',true))
ans =

16-12

Find Objects with Specific Values

findobj returns an array of meta.method objects for the static methods. In this case,
the list of static methods is not empty. Therefore, there are static methods defined by this
class.
Get the names of any static methods from the meta.method array:
staticMethodInfo = findobj([mc.MethodList(:)],'Static',true);
staticMethodInfo(:).Name
ans =
empty

The name of the static method (there is only one in this case) is empty. Here is the
information from the meta.method object for the empty method:
staticMethodInfo
method with properties:
Name:
Description:
DetailedDescription:
Access:
Static:
Abstract:
Sealed:
Hidden:
InputNames:
OutputNames:
DefiningClass:

'empty'
'Returns an empty object array of the given size'
''
'public'
1
0
0
1
{'varargin'}
{'E'}
[1x1 meta.class]

See Also
empty

Related Examples

Get Information About Properties on page 16-14

16-13

16

Information from Class Metadata

Get Information About Properties

In this section...
The meta.property object on page 16-14
How to Find Properties with Specific Attributes on page 16-18

The meta.property object

Use the meta.property class to determine the values of property attributes. The
writable properties of a meta.property object correspond to the attributes of the
associated property. The values of the writable meta.property properties correspond to
the attribute values specified in the class definition.
For example, create a default containers.Map object. Use the handle findprop method
to get the meta.property object for the Count property:
mp = findprop(containers.Map,'Count')
mp =
property with properties:
Name:
Description:
DetailedDescription:
GetAccess:
SetAccess:
Dependent:
Constant:
Abstract:
Transient:
Hidden:
GetObservable:
SetObservable:
AbortSet:
GetMethod:
SetMethod:
DefiningClass:

'Count'
'Number of pairs in the collection'
''
'public'
'private'
1
0
0
1
0
0
0
0
[]
[]
[1x1 meta.class]

The preceding meta.property display shows that the default Map object Count
property:
16-14

Get Information About Properties

Has public GetAccess and private SetAccess

Is Dependent
Is Transient
For a list of property attributes, see Table of Property Attributes on page 8-7.
If the class is not a handle class, get the meta.property objects from the meta.class
object. Use the metaclass function an object or the ? operator with the class name:
mc = ?containers.Map
mc =
class with properties:
Name:
Description:
DetailedDescription:
Hidden:
Sealed:
ConstructOnLoad:
HandleCompatible:
InferiorClasses:
ContainingPackage:
PropertyList:
MethodList:
EventList:
EnumerationMemberList:
SuperclassList:

'containers.Map'
'MATLAB Map Container'
'MATLAB Map Container'
0
0
1
1
{0x1 cell}
[1x1 meta.package]
[4x1 meta.property]
[35x1 meta.method]
[1x1 meta.event]
[0x1 meta.EnumeratedValue]
[1x1 meta.class]

The meta.class object property named PropertyList contains an array of

meta.property objects, one for each property defined by the containers.Map class.
For example, the name of the property associated with the meta.property object in
element 1 is:
mc.PropertyList(1).Name
ans =
Count

The meta.class object contains a meta.property object for hidden properties too.
Compare the result with the properties function, which returns only public properties:
16-15

16

Information from Class Metadata

properties('containers.Map')
Properties for class containers.Map:
Count
KeyType
ValueType

The serialization property is Hidden and has its GetAccess and SetAccess
attributes set to private. Therefore, the properties function does not list it. However,
you can get information about this property from its associated meta.property object
(which is the fourth element in the array of meta.property objects in this case):
mc.PropertyList(4)
ans =
class with properties:
Name:
Description:
DetailedDescription:
GetAccess:
SetAccess:
Dependent:
Constant:
Abstract:
Transient:
Hidden:
GetObservable:
SetObservable:
AbortSet:
GetMethod:
SetMethod:
DefiningClass:

'serialization'
'Serialization property.'
''
'private'
'private'
0
0
0
0
1
0
0
0
[]
[]
[1x1 meta.class]

How to Index Metaclass Objects

Access other metaclass objects directly from the meta.class object properties. For
example, the statement:
mc = ?containers.Map;

returns a meta.class object:

16-16

Get Information About Properties

class(mc)
ans =
meta.class

Referencing the PropertyList meta.class property returns an array with one

meta.property object for each property of the containers.Map class:
class(mc.PropertyList)
ans =
meta.property

Each array element is a single meta.property object:

mc.Properties(1)
ans =
[1x1 meta.property]

The Name property of the meta.property object contains a char vector that is the name
of the property:
class(mc.PropertyList(1).Name)
ans =
char

Apply standard MATLAB indexing to access information in metaclass objects.

For example, the meta.class PropertyList property contains an array of
meta.property objects. The following expression accesses the first meta.property
object in this array and returns the first and last (C and t) letters of the char vector
contained in the meta.property Name property.
mc.PropertyList(1).Name([1 end])
ans =
Ct

16-17

16

Information from Class Metadata

How to Find Properties with Specific Attributes

This example implements a function that finds properties with specific attribute values.
For example, you can:
Find objects that define constant properties (Constant attribute set to true).
Determine what properties are read-only (GetAccess = public, SetAccess =
private).
The findAttrValue function returns a cell array of property names that set the
specified attribute.
The findAttrValue function accesses information from metadata using these
techniques:
If input argument, obj, is a char vector, use the meta.class.fromName static
method to get the meta.class object.
If input argument, obj, is an object, use the metaclass function to get the
meta.class object.
Every property has an associated meta.property object. Obtain these objects from
the meta.class PropertyList property.
Use the handle class findprop method to determine if the requested property
attribute is a valid attribute name. All property attributes are properties of the
meta.property object. The statement, findobj(mp,'PropertyName') determines
whether the meta.property object, mp, has a property called PropertyName.
Reference meta.property object properties using dynamic field names. For
example, if attrName = 'Constant', then MATLAB converts the expression mp.
(attrName) to mp.Constant
The optional third argument enables you to specify the value of attributes whose
values are not logical true or false (such as GetAccess and SetAccess).
function cl_out = findAttrValue(obj,attrName,varargin)
if ischar(obj)
mc = meta.class.fromName(obj);
elseif isobject(obj)
mc = metaclass(obj);
end
ii = 0; numb_props = length(mc.PropertyList);
cl_array = cell(1,numb_props);
for c = 1:numb_props

16-18

Get Information About Properties

mp = mc.PropertyList(c);
if isempty (findprop(mp,attrName))
error('Not a valid attribute name')
end
attrValue = mp.(attrName);
if attrValue
if islogical(attrValue) || strcmp(varargin{1},attrValue)
ii = ii + 1;
cl_array(ii) = {mp.Name};
end
end
end
cl_out = cl_array(1:ii);
end

Find Property Attributes

Suppose you have the following containers.Map object:
mapobj = containers.Map({'rose','bicycle'},{'flower','machine'});

Find properties with private SetAccess:

findAttrValue(mapobj,'SetAccess','private')
ans =
'Count'

'KeyType'

'ValueType'

'serialization'

Find properties with public GetAccess:

findAttrValue(mapobj,'GetAccess','public')
ans =
'Count'

'KeyType'

'ValueType'

Related Examples

Find Default Values in Property Metadata on page 16-20

16-19

16

Information from Class Metadata

Find Default Values in Property Metadata

In this section...
Default Values on page 16-20
meta.property Data on page 16-20

Default Values
Class definitions can specify explicit default values for properties (see Property Default
Values on page 8-14). You can determine if a class defines explicit default values for a
property and what the value of the default is from the propertys meta.property object.

meta.property Data
The meta.class object for a class contains a meta.property object for every property
defined by the class, including properties with private and protected access.
For example. get the meta.class object for MATLAB MException class:
mc = ?MException;

Get an array of meta.property objects from the meta.class object:

mp = mc.PropertyList;

The first element in the mp array is the meta.property object for the type property:
mp(1)
ans =
class with properties:
Name:
Description:
DetailedDescription:
GetAccess:
SetAccess:
Dependent:
Constant:

16-20

'type'
'Type of error reporting'
''
'private'
'private'
0
0

Find Default Values in Property Metadata

Abstract:
Transient:
Hidden:
GetObservable:
SetObservable:
AbortSet:
GetMethod:
SetMethod:
HasDefault:
DefaultValue:
DefiningClass:

0
0
0
1
1
0
[]
[]
1
{}
[1x1 meta.class]

Two meta.property properties provide information on default values:

HasDefault true if class specifies a default value for the property, false if it
does not.
DefaultValue Contains the default value, if the class defines a default value for
the property.
These properties provide a programmatic way to obtain property default values without
reading class definition files. Use these meta.property object properties to obtain
property default values for both built-in classes and classes defined in MATLAB code.
Query Default Value
The procedure for querying a default value involves:
1

Getting the meta.property object for the property whose default value you want to
query.

Testing the logical value of the meta.property HasDefault property to determine

if the property defines a default value. MATLAB returns an error when you query
the DefaultValue property if the class does not define a default value for the
property.

Obtaining the default value from the meta.property DefaultValue property if

the HasDefault value is true.

Use the ? operator, the metaclass function, or the meta.class.fromName static

method (works with char vector variable) to obtain a meta.class object. The
meta.class object PropertyList property contains an array of meta.property
objects. Identify which property corresponds to which meta.property object using the
meta.property Name property.
16-21

16

Information from Class Metadata

For example, this class defines properties with default values:

classdef MyDefs
properties
Material = 'acrylic';
InitialValue = 1.0;
end
end

Follow these steps to obtain the default value defined for the Material property. Include
any error checking that is necessary for your application.
1

Get the meta.class object for the class:

mc = ?MyDefs;

Get an array of meta.property objects from the meta.class PropertyList

property:
mp = mc.PropertyList;

The length of the mp array equals the number of properties. You can use the
meta.property Name property to find the property of interest:
for k = 1:length(mp)
if (strcmp(mp(k).Name,'Material')
...

Before querying the default value of the Material property, test the HasDefault
meta.property to determine if MyClass defines a default property for this
property:
if mp(k).HasDefault
dv = mp(k).DefaultValue;
end
end
end

The DefaultValue property is read only. Changing the default value in the class
definition changes the value of DefaultValue property. You can query the default value
of a property regardless of its access settings.
Abstract and dynamic properties cannot define default values. Therefore, MATLAB
returns an error if you attempt to query the default value of properties with these
attributes. Always test the logical value of the meta.property HasDefault property
before querying the DefaultValue property to avoid generating an error.
16-22

Find Default Values in Property Metadata

Default Values Defined as Expressions

Class definitions can define property default values as MATLAB expressions (see
Evaluation of Expressions in Class Definitions on page 6-9 for more information).
MATLAB evaluates these expressions the first time the default value is needed, such as
the first time you create an instance of the class.
Querying the meta.property DefaultValue property causes MATLAB to evaluate a
default value expression, if it had not yet been evaluated. Therefore, querying a property
default value can return an error or warning if errors or warnings occur when MATLAB
evaluates the expression. See Property With Expression That Errors on page 16-24
for an example.
Property With No Explicit Default Value
MyClass does not explicitly define a default value for the Foo property:
classdef MyFoo
properties
Foo
end
end

The meta.property instance for property Foo has a value of false for HasDefault.
Because the class does not explicitly define a default value for Foo, attempting to access
the DefaultValue property causes an error:
mc = ?MyFoo;
mp = mc.PropertyList(1);
mp.HasDefault
ans =
0
dv = mp.DefaultValue;
No default value has been defined for property Foo

Abstract Property
MyClass defines the Foo property as Abstract:
classdef MyAbst

16-23

16

Information from Class Metadata

properties (Abstract)
Foo
end
end

The meta.property instance for property Foo has a value of false for its HasDefault
property because you cannot define a default value for an Abstract property.
Attempting to access DefaultValue causes an error:
mc = ?MyAbst;
mp = mc.PropertyList(1);
mp.HasDefault
ans =
0
dv = mp.DefaultValue;
Property Foo is abstract and therefore cannot have a default value.

Property With Expression That Errors

MyPropEr defines the Foo property default value as an expression that errors when
evaluated.
classdef MyPropEr
properties
Foo = sin(pie/2);
end
end

The meta.property object for property Foo has a value of true for its HasDefault
property because Foo does have a default value:
sin(pie/2)

However, this expression returns an error (pie is a function that creates a pie graph, not
the value pi).
mc = ?MyPropEr;
mp = mc.PropertyList(1);
mp.HasDefault
ans =

16-24

Find Default Values in Property Metadata

1
dv = mp.DefaultValue;
Error using pie (line 29)
Not enough input arguments.

Querying the default value causes the evaluation of the expression and returns the error.
Property With Explicitly Defined Default Value of Empty ([])
MyEmptyProp assigns a default of [] (empty double) to the Foo property:
classdef MyEmptyProp
properties
Foo = [];
end
end

The meta.property object for property Foo has a value of true for its HasDefault
property. Accessing DefaultValue returns the value []:
mc = ?MyEmptyProp;
mp = mc.PropertyList(1);
mp.HasDefault
ans =
1
dv = mp.DefaultValue;
dv =
[]

Related Examples

Get Information About Properties on page 16-14

16-25

17
Specialize Object Behavior
Methods That Modify Default Behavior on page 17-2
Number of Arguments for subsref and subsasgn on page 17-5
Modify nargout and nargin for Indexing Methods on page 17-8
Concatenation Methods on page 17-10
Object Converters on page 17-11
Object Array Indexing on page 17-14
Code Patterns for subsref and subsasgn Methods on page 17-20
Indexed Reference on page 17-27
Indexed Assignment on page 17-31
end as Object Index on page 17-36
Objects in Index Expressions on page 17-38
Class with Modified Indexing on page 17-40
Operator Overloading on page 17-48

17

Specialize Object Behavior

Methods That Modify Default Behavior

In this section...
How to Customize Class Behavior on page 17-2
Which Methods Control Which Behaviors on page 17-2
Overload Functions and Override Methods on page 17-4

How to Customize Class Behavior

There are functions that MATLAB calls implicitly when you perform certain actions with
objects. For example, a statement like [B(1);A(3)] involves indexed reference and
vertical concatenation.
You can change how user-defined objects behave by defining methods that control specific
behaviors. To change a behavior, implement the appropriate method with the name and
signature of the MATLAB function.

Which Methods Control Which Behaviors

The following table lists the methods to implement for your class and describes the
behaviors that they control.
Class Method to Implement

Description

Concatenating Objects
cat, horzcat, and vertcat

Customize behavior when concatenation objects

See Subclasses of Built-In Types with
Properties on page 12-61

Creating Empty Arrays

empty

Create empty arrays of the specified class. See

Empty Arrays on page 10-8

Displaying Objects
disp
display
17-2

Called when you enter disp(obj) on the

command line

Methods That Modify Default Behavior

Class Method to Implement

Description
Called when statements are not terminated by
semicolons. disp is often used to implement
display methods.
See Overloading the disp Function on page
18-41
See Custom Display Interface on page 18-2

Converting Objects to Other Classes

converters like double and char

Convert an object to a MATLAB built-in class

See The Character Converter on page 19-16
and The Double Converter on page 19-15

Indexing Objects
subsref and subsasgn

Enables you to create nonstandard indexed

reference and indexed assignment
See Object Array Indexing on page 17-14

end

Supports end syntax in indexing expressions

using an object; e.g., A(1:end)
See end as Object Index on page 17-36

numel

Determine the number of elements in an array

See Modify nargout and nargin for Indexing
Methods on page 17-8

size

Determine the dimensions of an array

See Use of size and numel with Classes on page
12-69

subsindex

Support using an object in indexing expressions

See Objects in Index Expressions on page
17-38

Saving and Loading Objects

17-3

17

Specialize Object Behavior

Class Method to Implement

Description

loadobj and saveobj

Customize behavior when loading and saving

objects
See Object Save and Load

Overload Functions and Override Methods

Overloading and overriding are terms that describe techniques for customizing class
behavior. Here is how we use these terms in MATLAB.
Overloading
Overloading means that there is more than one function or method having the same
name within the same scope. MATLAB dispatches to a particular function or method
based on the dominant argument. For example, the timeseries class overloads the
MATLAB plot function. When you call plot with a timeseries object as an input
argument, MATLAB calls the timeseries class method named plot.
Overriding
Overriding means redefining a method inherited from a superclass. MATLAB dispatches
to the most specific version of the method. That is, if the dominant argument is an
instance of the subclass, then MATLAB calls the subclass method.
To control class precedence, use the InferiorClasses attribute.

More About

17-4

Modify nargout and nargin for Indexing Methods on page 17-8

Number of Arguments for subsref and subsasgn

Number of Arguments for subsref and subsasgn

In this section...
How MATLAB Determines Number of Arguments on page 17-5
Syntax for subsref, and subsasgn Methods on page 17-6

How MATLAB Determines Number of Arguments

MATLAB calls subsref or subsasgn to determine the result of executing code that
involves indexed reference or assignment. The number of elements referenced or
assigned by an indexing operation determines the number of arguments MATLAB uses
to call subsref and subsasgn. That is, the indexing code determines the number of
arguments that MATLAB:
Returns from the call to subsref
Passes to the call to subsasgn
Therefore, the indexing code determines the value of nargout for the call to subsref
and the value of nargin for the call to subsasgn.
For example, consider the ValuesArray class.
classdef ValuesArray
properties
Values
end
methods
function obj = ValuesArray(v)
if nargin > 0
obj.Values = v;
end
end
end
end

Create an array of 10 ValuesArray objects.

l = ValuesArray.empty;
for k = 1:10
l(k) = ValuesArray(k);

17-5

17

Specialize Object Behavior

end

This subscripted reference returns a comma-separated list of three elements. For this
statement, the value of nargout in subsref is 3.
l(1:3).Values
ans =
1

ans =
2

ans =
3

The left side of a subscripted assignment statement affects the number of input
arguments that MATLAB uses to call subsasgn. This subscripted assignment assigns
three values to the three elements added to the array. For this assignment, the value
of nargin within subsasgn is 5 (the object, the indexing substructure, and the three
values to assign).
[l(11:13).Values] = l(1:3).Values
l =
1x13 ValuesArray array with properties:
Values

If the number of right-side arguments cannot satisfy the number of left-side arguments,
MATLAB returns an error:
[l(11:13).Values] = l(1).Values
Insufficient number of outputs from right hand side of equal sign to satisfy
assignment.

Syntax for subsref, and subsasgn Methods

17-6

Number of Arguments for subsref and subsasgn

If a class overloads subsref to support either '{}', '.', or both types of indexing and
the operation returns more than one value, overload subsref to return multiple values
using varargout:
function varargout = subsref(A,S)
...
end

If a class overloads subsasgn to support either '{}', '.', or both types of indexing and
the operation assigns more than one value, overload subsasgn to accept multiple values
using varargin:
function A = subsagn(A,S,varargin)
...
end

More About

Modify nargout and nargin for Indexing Methods on page 17-8

17-7

17

Specialize Object Behavior

Modify nargout and nargin for Indexing Methods

In this section...
When to Modify Number of Arguments on page 17-8
How to Modify Number of Arguments on page 17-8

When to Modify Number of Arguments

By default, the number of values referenced by an indexing operation determines how
many output arguments MATLAB uses to call subsref. Similarly, the number of values
to assign in an indexed assignment operation determines how many input arguments
MATLAB uses to call subsasgn.
If your class design requires that indexing operations return or assign
a different number of values than the number defined by the indexing
operation, use numArgumentsFromSubscript to specify the required number.
numArgumentsFromSubscript provides control over nargout for subsref and
nargin for subsasgn.
If your class uses numArgumentsFromSubscript, implement subsref and subsasgn
methods to define the actual values returned or assigned by indexing operations.
Before MATLAB release R2015b, MATLAB produced different results for some
indexing expressions that return or assign to a comma-separated list. Use
numArgumentsFromSubscript to support code that relies on the behavior of previous
releases. Also, now you can overload numArgumentsFromSubscript instead of numel to
achieve specific results without redefining how numel works.

How to Modify Number of Arguments

When a class overloads numArgumentsFromSubscript, MATLAB calls this method
instead of numel to compute the number of arguments expected for subsref nargout
and subsasgn nargin.
If classes do not overload numArgumentsFromSubscript, MATLAB calls numel to
compute the values of nargout or nargin.
MATLAB calls numArgumentsFromSubscript with three input arguments:
17-8

Modify nargout and nargin for Indexing Methods

function n = numArgumentsFromSubscript(obj,s,indexingContext)
...
end

Input Argument

Description

obj

Object whose subsref or subsasgn method is called

Indexing structure that contains the indexing type and indices used
in the operation

indexingContextContext in which the indexing operation occurs: indexed reference

used as a statement, index reference used as a function argument,
and indexed assignment
MATLAB uses the value returned by numArgumentsFromSubscript for indexed
reference and assignment. Determine the context in which the indexing operation
executes by testing the value of indexingContext in your implementation of
numArgumentsFromSubscript. For example, test for any or all the possible indexing
contexts.
function n = numArgumentsFromSubscript(obj,~,indexingContext)
switch indexingContext
case matlab.mixin.util.IndexingContext.Statement
n = ...; % nargout for indexed reference used as statement
case matlab.mixin.util.IndexingContext.Expression
n = ...; % nargout for indexed reference used as function argument
case matlab.mixin.util.IndexingContext.Assignment
n = ...; % nargin for indexed assignment
end
end

For more information and examples, see numArgumentsFromSubscript.

Note: For MATLAB version R2015b and later releases, overload
numArgumentsFromSubscript instead of numel to customize indexing for your class.

More About

Number of Arguments for subsref and subsasgn on page 17-5

Use of size and numel with Classes on page 12-69

17-9

17

Specialize Object Behavior

Concatenation Methods
In this section...
Default Concatenation on page 17-10
Methods to Overload on page 17-10

Default Concatenation
You can concatenate objects into arrays. For example, suppose that you have three
instances of the class MyClass, obj1, obj2, obj3. You can form arrays of these objects
using brackets. Horizontal concatenation calls horzcat:
HorArray = [obj1,obj2,obj3];

HorArray is a 1-by-3 array of class MyClass. You can concatenate the objects along the
vertical dimension, which calls vertcat:
VertArray = [obj1;obj2;obj3]

VertArray is a 3-by-1 array of class MyClass. To concatenate arrays along different

dimensions, use the cat function. For example:
ndArray = cat(3,HorArray,HorArray);

ndArray is a 1-by-3-by-2 array.

Methods to Overload
Overload horzcat, vertcat, and cat to produce specialized behaviors in your class.
Overload both horzcat and vertcat whenever you want to modify object concatenation
because MATLAB uses both functions for any concatenation operation.

Related Examples

17-10

Subclasses of Built-In Types with Properties on page 12-61

Object Converters

Object Converters
In this section...
Why Implement Converters on page 17-11
Converters for Package Classes on page 17-11
Converters and Subscripted Assignment on page 17-12

Why Implement Converters

You can convert an object of one class to an object of another class. A converter method
has the same name as the class it converts to, such as char or double. Think of a
converter method as an overloaded constructor method of another class. The converter
takes an instance of its own class and returns an object of a different class.
Converters enable you to:
Use methods defined for another class
Ensure that expressions involving objects of mixed class types execute properly
Control how instances are interpreted in other contexts
Suppose that you define a polynomial class. If you create a double method for the
polynomial class, you can use it to call other functions that require inputs of type
double.
p = polynomial(...);
dp = double(p);
roots(dp)

p is a polynomial object, double is a method of the polynomial class, and roots is a

standard MATLAB function whose input arguments are the coefficients of a polynomial.

Converters for Package Classes

Classes defined in packages can have names that are a dot-separated list of names. The
last name is a class and preceding names are packages. Name the conversion methods
using the package qualifiers in the method names. For example, a conversion method to
convert objects of MyClass to objects of the PkgName.PkgClass class uses this method
name:
classdef MyClass

17-11

17

Specialize Object Behavior

...
methods
function objPkgClass = PkgName.PkgClass(objMyclass)
...
end
end
end

You cannot define a converter method that uses dots in the name in a separate file.
Define package-class converters in the classdef file.

Converters and Subscripted Assignment

When you make a subscripted assignment statement like:
A(1) = myobj;

MATLAB compares the class of the Right-Side variable to the class of the Left-Side
variable. If the classes are different, MATLAB attempts to convert the Right-Side
variable to the class of the Left-Side variable. To do this conversion, MATLAB first
searches for a method of the Right-Side class that has the same name as the Left-Side
class. Such a method is a converter method, which is similar to a typecast operation in
other languages.
If the Right-Side class does not define a method to convert from the Right-Side class to
the Left-Side class, MATLAB calls the Left-Side class constructor. passing it the RightSide variable.
For example, suppose that you make the following assignments:
A(1) = objA; % Object of class ClassA
A(2) = objB; % Object of class ClassB

MATLAB attempts to call a method of ClassB named ClassA. If no such converter

method exists, MATLAB software calls the ClassA constructor, passing objB as an
argument. If the ClassA constructor cannot accept objB as an argument, then MATLAB
returns an error.
Use cell arrays to store objects of different classes.

Related Examples

17-12

Converter Methods on page 10-18

Object Converters

The Double Converter on page 19-15

17-13

17

Specialize Object Behavior

Object Array Indexing

In this section...
Default Indexed Reference and Assignment on page 17-14
What You Can Modify on page 17-15
When to Modify Indexing Behavior on page 17-16
Built-In subsref and subsasgn Called in Methods on page 17-16
Avoid Overriding Access Attributes on page 17-18

Default Indexed Reference and Assignment

MATLAB classes support object array indexing by default. Many class designs require no
modification to this behavior.
Arrays enable you to reference and assign elements of the array using a subscripted
notation. This notation specifies the indices of specific array elements. For example,
suppose that you create two arrays of numbers (using randi and concatenation).
Create a 3-by-4 array of integers between 1 and 9:
A = randi(9,3,4)
A =
4
4
7

8
2
5

5
6
7

7
3
7

Create a 1-by-3 array of the numbers 3, 6, 9:

B = [3 6 9];

Reference and assign elements of either array using index values in parentheses:
B(2) = A(3,4);
B
B =
3

17-14

Object Array Indexing

When you execute a statement that involves indexed reference:

C = A(3,4);

MATLAB calls the built-in subsref function to determine how to interpret the
statement. Similarly, if you execute a statement that involves indexed assignment:
C(4) = 7;

MATLAB calls the built-in subsasgn function to determine how to interpret the
statement.
The MATLAB default subsref and subsasgn functions also work with user-defined
objects. For example, create an array of objects of the same class:
for k=1:3
objArray(k) = MyClass;
end

Referencing the second element in the object array, objArray, returns the object
constructed when k = 2:
D = objArray(2);
class(D)
ans =
MyClass

You can assign an object to an array of objects of the same class, or an uninitialized
variable:
newArray(3,4) = D;

Arrays of objects behave much like numeric arrays in MATLAB. You do not need to
implement any special methods to provide standard array behavior with your class.
For general information about array indexing, see Matrix Indexing.

What You Can Modify

You can modify your class indexed reference and/or assignment behavior by
implementing class methods called subsref and subsasgn. For syntax description, see
their respective reference pages.
17-15

17

Specialize Object Behavior

Once you add a subsref or subsasgn method to your class, then MATLAB calls only
the class method, not the built-in function. Therefore, your class method must implement
all the indexed reference and assignment operations that you want your class to support.
These operations include:
Dot notation calls to class methods
Dot notation reference and assignment involving properties
Any indexing using parentheses '()'
Any indexing using braces '{}'
Implementing subsref and subsasgn methods gives you complete control over the
interpretation of indexing expressions for objects of your class. Implementing the extent
of behaviors that MATLAB provides by default is nontrivial.

When to Modify Indexing Behavior

Default indexing for object arrays and dot notation for access to properties and methods
enables user-defined objects to behave like built-in classes. For example, suppose that
you define a class with a property called Data that contains an array of numeric data.
This statement:
obj.Data(2,3)

Returns the value contained in the second row, third column of the array. If you have an
array of objects, use an expression like:
objArray(3).Data(2,3)

This statement returns the value contained in the second row, third column of the third
element in the array.
Modify the default indexing behavior when your class design requires behavior that is
different from MATLAB default behavior.

Built-In subsref and subsasgn Called in Methods

MATLAB does not call class-defined subsref or subsasgn methods within the
overloaded methods. Within class methods, MATLAB always calls the built-in subsref
and subsasgn functions. This behavior occurs within the class-defined subsref and
subsasgn methods too.
17-16

Object Array Indexing

For example, within a class method, this dot reference:

obj.Prop

calls the built-in subsref function. To call the class-defined subsref method, use:
subsref(obj,substruct('.','Prop'))

Whenever a method requires the functionality of the class-defined subsref or subsasgn

method, the class must call the overloaded methods as functions. Do not use the
operators, '()', '{}', or '.'.
For example, suppose that you define a class to represent polynomial. This class has
a subsref method that evaluates the polynomial with the value of the independent
variable equal to the subscript. Assume that this statement defines the polynomial with
its coefficients:
p = polynom([1 0 -2 -5]);

The MATLAB expression for the resulting polynomial is:

x^3 - 2*x - 5

This subscripted expression returns the value of the polynomial at x = 3:

p(3)
ans =
16

Suppose that you want to use this feature in another class method. To do so, call the
subsref function directly. The evalEqual method accepts two polynom objects and a
value at which to evaluate the polynomials:
methods
function ToF = evalEqual(p1,p2,x)
% Create arguments for subsref
subs.type = '()';
subs.subs = {x};
% Need to call subsref explicitly
y1 = subsref(p1,subs);
y2 = subsref(p2,subs);
if y1 == y2
ToF = true;
else

17-17

17

Specialize Object Behavior

ToF = false;
end
end
end

This behavior enables you to use standard MATLAB indexing to implement specialized
behaviors. See Class with Modified Indexing on page 17-40 for examples of how to
use both built-in and class-modified indexing.

Avoid Overriding Access Attributes

Because subsref is a class method, it has access to private class members. Avoid
inadvertently giving access to private methods and properties as you handle various
types of reference. Consider this subsref method defined for a class having private
properties, x and y:
classdef MyPlot
properties (Access = private)
x
y
end
properties
Maximum
Minimum
Average
end
methods
function obj = MyPlot(x,y)
obj.x = x;
obj.y = y;
obj.Maximum = max(y);
obj.Minimum = min(y);
obj.Average = mean(y);
end
function B = subsref(A,S)
switch S(1).type
case '.'
switch S(1).subs
case 'plot'
% Reference to A.x and A.y call built-in subsref
B = plot(A.x,A.y);
otherwise
% Enable dot notation for all properties and methods

17-18

Object Array Indexing

B = A.(S.subs);
end
end
end
end
end

This subsref enables the use of dot notation to create a plot using the name 'plot'.
The statement:
obj = MyPlot(1:10,1:10);
h = obj.plot;

calls the plot function and returns the handle to the graphics object.
You do not need to code each method and property name. The otherwise code in the
inner switch block manages any name reference that you do not explicitly specify in
case statements. However, using this technique exposes any private and protected class
members via dot notation. For example, you can reference the private property, x, with
this statement:
obj.x
ans =
1

10

The same issue applies to writing a subsasgn method that enables assignment to
private or protected properties. Your subsref and subsasgn methods might need
to code each specific property and method name explicitly to avoid violating the class
design.

Related Examples

Code Patterns for subsref and subsasgn Methods on page 17-20

Indexed Reference on page 17-27

Indexed Assignment on page 17-31

17-19

17

Specialize Object Behavior

Code Patterns for subsref and subsasgn Methods

In this section...
Customize Indexed Reference and Assignment on page 17-20
Syntax for subsref and subsasgn Methods on page 17-20
Indexing Structure Describes Indexing Expressions on page 17-21
Values of the Indexing Structure on page 17-22
Typical Patterns for Indexing Methods on page 17-22

Customize Indexed Reference and Assignment

User-defined classes have the same indexing behaviors as that of built-in classes. Classes
can customize indexing operations by overloading the functions that MATLAB calls to
evaluate indexing expressions. Overload the subsref and subsasgn functions when you
want to define special behaviors for indexed reference and assignment.
For an overview of object indexing, see Object Array Indexing on page 17-14.

Syntax for subsref and subsasgn Methods

MATLAB calls the subsref and subsasgn methods of your class with these arguments.
Method

Input

Output

b = subsref(obj,s)

obj Object or object

array used in indexing
expression

b Result of indexing
expression

s Indexing structure
obj =
subsasgn(obj,s,b)

obj Object or object

array used in indexing
expression
s Indexing structure
b Value being
assigned

17-20

obj Object or object array

after assignment

Code Patterns for subsref and subsasgn Methods

Modifying Number of Arguments

If your class design requires that indexing operations return or assign a different number
of values than the number defined by the default indexing operation, overload the
numArgumentsFromSubscript function to control nargout for subsref and nargin
for subsasgn. For more information and examples, see numArgumentsFromSubscript.

Indexing Structure Describes Indexing Expressions

The indexing structure contains information that describes the indexing expression.
Class methods use the information in the indexing structure to evaluate the expression
and implement custom behavior.
For example, the CustomIndex class defines a property that you can use in indexing
expressions.
classdef CustomIndex
properties
DataArray
end
end

Create an object and assign a 5-by-5 matrix created by the magic function to the
DataArray property.
a = CustomIndex;
a.DataArray = magic(5);

This subscripted reference expression returns the first row of the 5-by-5 matrix.
a.DataArray(1,:)
ans =
17

24

15

This expression assigns new values to the first row of the array stored in the DataArray
property.
a.DataArray(1,:) = [1 2 3 4 5];

This assignment statement uses:

A '.' type reference
17-21

17

Specialize Object Behavior

A property name following the dot (that is, DataArray)

A range of indices (1,:) within parentheses
The indexing structure contains this information in the type and subs fields.

Values of the Indexing Structure

When executing an indexing expression, MATLAB calls the class subsref or subsasgn
method, if the class overloads these functions. One of the arguments passed to the
method is the indexing structure. The indexing structure has two fields:
type One of the three possible indexing types: '.', '()', '{}'
subs A char vector with the property name or cell array of the indices used in the
expression, including : and end.
If the indexing expression is a compound expression, then MATLAB passes an array of
structures, one struct for each level of indexing. For example, in this expression:
a.DataArray(1,:)

the indexing structure array S has these values:

S(1).type is set to '.', indicating that the first indexing operation is a dot.
s(1).subs is set to the property name, 'DataArray'
The second level of indexing is in the second element of the indexing structure:
S(2).types is set to '()' indicating the second indexing operation is parentheses
indexing
S(2).subs is set to a cell array containing the indices {[1],[:]}

Typical Patterns for Indexing Methods

To overload the subsref and subasgn functions:
Determine the full indexing expression using the types and subs fields of the
indexing structure.
Implement the specialized behaviors for the indexing operations supported by the
class.
Return the appropriate values or modified objects in response to the call by MATLAB.
17-22

Code Patterns for subsref and subsasgn Methods

A switch statement is a convenient way to detect the first level of indexing. There are
three types of indexingdot, parentheses, and braces. Each case block in the switch
statement implements all indexing expressions that begin with that first-level type of
indexing.
The methods must implement all indexing expressions that the class supports. If you
do not customize a particular type of indexing, call the built-in function to handle that
expression.
Use the length of the indexing structure array and indexing type define conditional
statements for compound indexing expressions.
Code Framework for subsref Method
The following framework for the subsref method shows how to use information in
the indexing structure in conditional statements. Your application can involve other
expression not shown here.
function varargout = subsref(obj,s)
switch s(1).type
case '.'
if length(s) == 1
% Implement obj.PropertyName
...
elseif length(s) == 2
% Implement obj.PropertyName(indices)
...
else
varargout = {builtin('subsref',obj,s)};
end
case '()'
if length(s) == 1
% Implement obj(indices)
...
elseif length(s) == 2 && strcmp(s(2).type,'.')
% Implement obj(ind).PropertyName
...
elseif length(s) == 3 && strcmp(s(2).type,'.') && strcmp(s(3).type,'()')
% Implement obj(indices).PropertyName(indices)
...
else
% Use built-in for any other expression
varargout = {builtin('subsref',obj,s)};
end

17-23

17

Specialize Object Behavior

case '{}'
if length(s) == 1
% Implement obj{indices}
...
elseif length(s) == 2 && strcmp(s(2).type,'.')
% Implement obj{indices}.PropertyName
...
else
% Use built-in for any other expression
varargout = {builtin('subsref',obj,s)};
end
otherwise
error('Not a valid indexing expression')
end

Using varargout for the returned value enables the method to work with object arrays.
For example, suppose that you want to support the return of a comma-separated list with
an expression like this:
[x1,...xn] = objArray.PropertyName(Indices)

This expression results in a two-element indexing structure array. The first-level type
is dot ('.') and the second level is parentheses ('()'). Build the varargout cell array
with each value in the array.
case '.'
...
if length(s)==2 && strcmp(s(2).type,'()')
prop = s(1).subs;
% Property name
n = numel(obj);
% Number of elements in array
varargout = cell(1,n); % Preallocate cell array
for k = 1:n
varargout{k} = obj(k).(prop).(s(2).subs);
end
end
...
end

subsasgn Pattern
The following framework for the subsasgn method shows how to use the indexing
structure in conditional statements that implement assignment operations.
function obj = subssasgn(obj,s,varargin)
switch s(1).type

17-24

Code Patterns for subsref and subsasgn Methods

case '.'
if length(s) == 1
% Implement obj.PropertyName = varargin{:};
...
elseif length(s) == 2 && strcmp(s(2).type,'()')
% Implement obj.PropertyName(indices) = varargin{:};
...
else
% Call built-in for any other case
obj = builtin('subsasgn',obj,s,varargin);
end
case '()'
if length(s) == 1
% Implement obj(indices) = varargin{:};
elseif length(s) == 2 && strcmp(s(2).type,'.')
% Implement obj(indices).PropertyName = varargin{:};
...
elseif length(s) == 3 && strcmp(s(2).type,'.') && strcmp(s(3).type,'()')
% Implement obj(indices).PropertyName(indices) = varargin{:};
...
else
% Use built-in for any other expression
obj = {builtin('subsasgn',obj,s,varargin)};
end
case '{}'
if length(s) == 1
% Implement obj{indices} = varargin{:}
...
elseif length(s) == 2 && strcmp(s(2).type,'.')
% Implement obj{indices}.PropertyName = varargin{:}
...
% Use built-in for any other expression
obj = {builtin('subsasgn',obj,s,varargin)};
end
otherwise
error('Not a valid indexing expression')
end
end

Using varargin for the right-side value of the assignment statement enables the
method to work with object arrays. For example, suppose that you want to support the
assignment of a comma-separated list with an expression like this:
C = {'one';'two','three'};

17-25

17

Specialize Object Behavior

[objArray.PropertyName] = C{:}

This expression results in an indexing structure with the dot type ('.') indexing The cell
array C on the right side of the assignment statement produces a comma-separated list.
This code assigns one list item to each property in the object array.
case '.'
if length(s)==1
prop = s(1).subs;
% Property name
n = numel(obj);
% Number of elements in array
for k = 1:n
obj(k).(prop) = varargin{k};
end
end
end

Related Examples

17-26

Class with Modified Indexing on page 17-40

Class to Represent Hardware on page 12-75

Subclasses of Built-In Types with Properties on page 12-61

Indexed Reference

Indexed Reference
In this section...
How Indexed Reference Works on page 17-27
Compound Indexed References on page 17-28
How to Write subsref for Objects on page 17-29

How Indexed Reference Works

Object indexed references are in three forms parentheses, braces, and dot-name:
A(I)
A{I}
A.name

Each of these statements results in a call by MATLAB to the subsref of class A, or a

call to the built-in subsasgn function if the class of A does not implement a subsasgn
method.
MATLAB passes two arguments to subsref and requires subsref to return the result
of the indexed reference:
B = subsref(A,S)

The first argument is the object being referenced, A. The second argument, S, is a
substruct with two fields:
S.type is a char vector containing '()', '{}', or '.' specifying the indexing type
used.
S.subs is a cell array or char vector containing the actual index or name. A colon
used as an index is passed in the cell array as the colon character ':'. Ranges
specified using a colon (e.g., 2:5) are expanded to 2 3 4 5.
For example, the expression:
A(1:4,:)

Causes MATLAB to call subsref(A,S), where S is a 1-by-1 structure with a twoelement cell array. The cell array contains the numbers 1, 2, 3, 4, and the colon character
:.
17-27

17

Specialize Object Behavior

S.type = '()'
S.subs = {1:4,':'}

Returning the contents of each cell of S.subs gives the index values for the first
dimension and a char vector ':' for the second dimension:
S.subs{:}
ans =
1

ans =
:

The default subsref returns all array elements in rows 1 through 4 and all the columns
in the array.
Similarly, this expression:
A{1:4}

Uses a cell array containing the numbers 1, 2, 3, 4.

S.type ='{}'
S.subs = {1:4}

The default subsref returns the contents of all cell array elements in rows 1 through 4
and all the columns in the array.
This expression:
A.Name

Calls subsref(A,S), where the struct S has these values:

S.type = '.'
S.subs = 'Name'

Compound Indexed References

These simple calls are combined for more complicated indexing expressions. In such
cases, length(S) is the number of indexing levels. For example,
17-28

Indexed Reference

A(1,2).PropertyName(1:4)

calls subsref(A,S), where S is a 3-by-1 array of structs with the values:

S(1).type = '()'
S(1).subs = {1,2}

S(2).type = '.'
S(2).subs = 'PropertyName'

S(3).type = '()'
S(3).subs = {1:4}

How to Write subsref for Objects

Your class subsref method interprets the indexing expressions passed in by MATLAB.
The subsref method implements any behavior your class to supports.
For example, use a switch statement to determine the type of indexing used and to
obtain the actual indices. The following three code fragments illustrate how to interpret
the input arguments. In each case, the case expression returns the value (B) that your
subsref function returns.
For a parentheses index:
% Parse A(n)
switch S.type
case '()'
B = A(S.subs{:});
end

For a brace index when A is an object, you can implement indexing using {} as a
special case. For example, suppose that you want A{n} to access a property of A called
CellProperty, and that contains a cell array:
% Parse A{n}
switch S.type
case '{}'
B = A.CellProperty{S.subs{:}};
end

Although braces are used for cell arrays in MATLAB, your subsref method can define
its own meaning for this syntax.
Dot name indexing typically accesses property values. The name can be an arbitrary
char vector for which you take an arbitrary action:
switch S.type
case '.'
switch S.subs

17-29

17

Specialize Object Behavior

case
B
case
B

'name1'
= A.name1;
'name2'
= A.name2;

end
end

If the dot name is a method call, passing arguments requires a second level of indexing.
Use Default Indexing
The method can call the built-in subsref to handle any of the three indexing types that
you do not want to change. For example, call the built-in for {} indexing:
case '{}'
varargout = builtin('subsref',A,s);

Related Examples

17-30

Indexed Assignment on page 17-31

Number of Arguments for subsref and subsasgn on page 17-5

Modify nargout and nargin for Indexing Methods on page 17-8

Indexed Assignment

Indexed Assignment
In this section...
How Indexed Assignment Works on page 17-31
Indexed Assignment to Objects on page 17-33
Compound Indexed Assignments on page 17-33
How to Write subsasgn for Objects on page 17-34

How Indexed Assignment Works

Object indexed assignments are in three forms parentheses, braces, and doc-name:
A(I) = B
A{I} = B
A.name = B

Each of these statements results in a call by MATLAB to the subsasgn method of class
A, or a call to the built-in subsasgn function if the class of A does not implement a
subsasgn method.
MATLAB passes three arguments to subsasgn and requires subsasgn to return the
result of the assignment:
A = subsasgn(A,S,B)

The first argument, A, is the object being assigned the value in the third argument B.
The second argument is the indexing structure, substruct. S has two fields:
S.type is a char vector containing '()', '{}', or '.' specifying the indexing type
used.
S.subs is a cell array or character array containing the actual indices or field name.
A colon used as an index is passed in the cell array as the character ':'. Ranges
specified using a colon (e.g., 2:5) are expanded to 2 3 4 5.
For example, the assignment statement:
A(2,3) = B;

generates a call to subsasgn:

17-31

17

Specialize Object Behavior

A = subsasgn(A,S,B)

S contains:
S.type = '()'
S.subs = {2,3}

The built-in subsasgn:

Determines the class of A. If B is not the same class as A, then MATLAB tries to
construct an object of the same class as A using B as an input argument. If this
attempt fails, MATLAB returns an error.
If A and B are, or can be made, into the same class, then MATLAB assigns the value of
B to the array element at row 2, column 3.
If A does not exist before you execute the assignment statement, then MATLAB
initializes the five array elements that come before A(2,3) with default objects of
class B.
Similarly, this expression
A{2,3} = B

Uses these values for S:

S.type ='{}'
S.subs = {2,3}

The built-in subsasgn:

Assigns B to the cell array element at row 2, column 3.
If A does not exist before you execute the assignment statement, MATLAB initializes
the five cells that come before A(2,3) with []. The result is a 2-by-3 cell array.
This expression:
A.Name = B

Calls A = subsasgn(A,S,B) where the struct S has these values:

S.type = '.'
S.subs = 'Name'

The built-in subsasgn:

17-32

Indexed Assignment

Assigns B to the struct field Name.

If A does not exist before you execute the assignment statement, MATLAB creates a
struct variable, A with field Name and assigns the value of B to this field location.
If struct A exists, but has no field Name, then MATLAB adds the field Name and
assigns the value of B to the new field location.
If struct A exists and has a Name field, then MATLAB assigns the value of B to
Name.
You can redefine all or some of these assignment behaviors by implementing a subsasgn
method for your class.

Indexed Assignment to Objects

If A is an object, this expression:
A.Name = B

Calls A = subsasgn(A,S,B) where, S has these values:

S.type = '.'
S.subs = 'Name'

The default subsasgn:

Attempts to assign B to the Name property.
If the class of A does not have a Name property, MATLAB returns an error.
If the Name property has restricted access (private or protected), MATLAB
determines if the assignment is allowed based on the context in which the assignment
is made.
If the class of A defines a set method for property Name, MATLAB calls the set
method.
MATLAB applies all other property attributes before determining whether to
assigning B to the property Name.

Compound Indexed Assignments

These simple calls are combined for more complicated indexing expressions. In such
cases, length(S) is the number of indexing levels. For example,
17-33

17

Specialize Object Behavior

A(1,2).PropertyName(1:4) = B

calls subsasgn(A,S,B), where S is a 3-by-1 array of structures with the values:

S(1).type = '()'
S(1).subs = {1,2}

S(2).type = '.'
S(2).subs = 'PropertyName'

S(3).type = '()'
S(3).subs = {1:4}

How to Write subsasgn for Objects

The CellProp class defines a property that is a cell array. The subsasgn method
enables you to refer to the property using brace indexing {} without the property name.
For example,
a = CellProp;
a{4} 'four';
a =
CellProp with properties:
CellProperty: {[1]

[2]

'three'

'four'}

classdef CellProp
properties
CellProperty cell = {1,2,'three'};
end
methods
function A = subsasgn(A,S,B)
switch S(1).type
case '()'
A(S(1).subs{:}) = B;
case '{}'
A.CellProperty{S.subs{:}} = B;
case '.'
name = S(1).subs{:};
if strcmp(name,'CellProperty')
A.CellProperty = B;
else
error('Not a valid property name')
end
end
end
function B = subsref(A,S)
switch S.type
case '()'

17-34

Indexed Assignment

B
case
B
case
B
end

= builtin('subsref',A,S);
'{}'
= A.CellProperty{S.subs{:}};
'.'
= builtin('subsref',A,S);

end
end
end

Related Examples

Indexed Reference on page 17-27

Number of Arguments for subsref and subsasgn on page 17-5

Modify nargout and nargin for Indexing Methods on page 17-8

17-35

17

Specialize Object Behavior

end as Object Index

In this section...
Define end Indexing for an Object on page 17-36
The end Method on page 17-37

Define end Indexing for an Object

When you use end in an object indexing expression, such as A(4:end), the end function
returns the index value corresponding to the last element in that dimension.
Classes can overload the end function to implement specialized behavior. If your class
defines an end method, MATLAB calls that method to determine how to interpret the
expression.
The end method has the calling syntax:
ind = end(A,k,n)

The arguments are described as follows:

A is the object
k is the index in the expression using the end syntax
n is the total number of indices in the expression
ind is the index value to use in the expression
For example, consider the 3-by-5 array A. When MATLAB encounters the expression:
A(end-1,:)

MATLAB calls the end method defined for the object A using the arguments:
ind = end(A,1,2)

These arguments mean that the end statement occurs in the first index and there are
two indices. The end class method returns the index value for the last element of the first
dimension (from which 1 is subtracted in this case). The original expression is evaluated
as:
A(3-1,:)

17-36

end as Object Index

If your class implements an end method, ensure that it returns a value appropriate for
the class.

The end Method

The end method for the MyDataClass example (see Class with Modified Indexing
on page 17-40) operates on the contents of the Data property. The objective of this
method is to return a value that can replace end in any indexing expression, such as:
obj(4:end)
obj.Data(2,3:end)

This end method determines a positive integer value for end. The method returns the
value so that MATLAB can use it in the indexing expression.
function ind = end(obj,k,n)
szd = size(obj.Data);
if k < n
ind = szd(k);
else
ind = prod(szd(k:end));
end
end

Related Examples

Class with Modified Indexing on page 17-40

Objects in Index Expressions on page 17-38

17-37

17

Specialize Object Behavior

Objects in Index Expressions

In this section...
Objects Indexes on page 17-38
Ways to Implement Objects as Indices on page 17-38
subsindex Implementation on page 17-38

Objects Indexes
MATLAB can use objects as indices in indexed expressions. The rules of array indexing
apply indices must be positive integers. Therefore, MATLAB must be able to derive a
value from the object that is a positive integer for use in the indexed expression.
Indexed expressions like X(A), where A is an object, cause MATLAB to call the
subsindex function. However, if an indexing expression results in a call to an
overloaded subsref or subsasgn method defined by the class of X, then MATLAB does
not call subsindex.

Ways to Implement Objects as Indices

There are several ways to implement indexing of one object by another object, X(A):
Define a subsindex method in the class of A that converts A to an integer. MATLAB
calls A's subsindex method to perform indexing operations when the class of X does
not overload subsref or subsasgn.
If the class of X overloads subsref or subsasgn, these methods can call the
subsindex method of A explicitly. The class of A must implement a subsindex
method that returns an appropriate value.
If the class of X overloads subsref or subsasgn, these methods can contain code that
determines an integer index value. In this case, the class of A does not implement a
subsindex method.

subsindex Implementation
subsindex must return the value of the object as a zero-based integer index value in the
range 0 to prod(size(X))-1.
17-38

Objects in Index Expressions

Suppose that you want to use object A to index into object B. B can be a single object or an
array, depending on the class designs.
C = B(A);

Here are two examples of subsindex methods. The first assumes you can convert class A
to a uint8. The second assumes class A stores an index value in a property.
The subsindex method implemented by class A can convert the object to numeric
format to be used as an index:
function ind = subsindex(obj)
ind = uint8(obj);
end

The class of obj implements a uint8 method to provide the conversion from the
object to an integer value.
Class A implements subsindex to return a numeric value that is stored in a
property:
function ind = subsindex(obj)
ind = obj.ElementIndex;
end

Note: subsindex values are 0-based, not 1-based.

See Also

numArgumentsFromSubscript | subsasgn | subsref

Related Examples

end as Object Index on page 17-36

More About

Modify nargout and nargin for Indexing Methods on page 17-8

17-39

17

Specialize Object Behavior

Class with Modified Indexing

In this section...
How to Modify Class Indexing on page 17-40
Class Description on page 17-40
Specialize Subscripted Reference subsref on page 17-42
Specialize Subscripted Assignment subsasgn on page 17-43
Implement Addition for Object Data double and plus on page 17-44
MyDataClass.m on page 17-45

How to Modify Class Indexing

This example defines a class that modifies the default indexing behavior by
implementing subsref and subsasgn methods. The class also implements type
conversion and addition by implementing a double converter method and a plus
method.
The objective of the class design is to:
Enable you to treat an object of the class as a numeric array
Be able to contain nonnumeric and numeric data in an object of the class

Class Description
The class has three properties:
Data numeric test data
Description description of test data
Date date test was conducted
Assume that you have the following random data (randi):
d = randi(9,3,4)
d =

17-40

Class with Modified Indexing

8
9
2

9
6
1

3
5
9

9
2
9

Create an instance of the class:

obj = MyDataClass(d,'Test001')
obj =
MyDataClass with properties:
Data: [3x4 double]
Description: 'Test001'
Date: [2012 1 7 9 32 34.5190]

The constructor arguments pass the values for the Data and Description properties.
The clock function assigns the value to the Date property from within the constructor.
This approach captures the time and date information when each instance is created.
Here is the preliminary code listing without the subsref, subsasgn double, and plus
methods.
classdef MyDataClass
properties
Data
Description
end
properties (SetAccess = private)
Date
end
methods
function obj = MyDataClass(data,desc)
if nargin > 0
obj.Data = data;
end
if nargin > 1
obj.Description = desc;
end
obj.Date = clock;
end
end
end

17-41

17

Specialize Object Behavior

Specialize Subscripted Reference subsref

Implement a subsref method to support both the default and a specialized type of
indexing.
The default indexed reference behavior for scalar objects:
obj.Data(2,3)
ans =
5

And to add the functionality to index into the Data property with an expression like
this statement:
obj(2,3)

If you redefine '()' indexing to support access to the Data property, you cannot create
arrays of MyDataClass objects and use '()' indexing to access individual objects. You
can reference only scalar objects.
To achieve the design goals, the subsref method must handle all indexing types. The
subsref method:
Calls the builtin subsref function for '.' indexing
Returns an error for '{}' indexing
Defines its own version of '()' indexing.
The result: obj(i) is equivalent to obj.Data(i).
function sref = subsref(obj,s)
% obj(i) is equivalent to obj.Data(i)
switch s(1).type
case '.'
sref = builtin('subsref',obj,s);
case '()'
if length(s) < 2
sref = builtin('subsref',obj.Data,s);
return
else
sref = builtin('subsref',obj,s);
end
case '{}'
error('MYDataClass:subsref',...

17-42

Class with Modified Indexing

'Not a supported subscripted reference')

end
end

Specialize Subscripted Assignment subsasgn

To support the equivalent of the indexed reference behavior with indexed assignment,
implement a subsasgn method.
Support the default indexed assignment:
obj.Data(2,3) = 9;

Add the functionality to assign values to the Data property with an expression like
this statement:
obj(2,3) = 9;

Like the subsref method, the subsasgn method:

Calls the builtin subsasgn function for '.' indexing
Returns an error for '{}' indexing
Defines its own version of '()' indexing.
The substruct function redefines the index type and index subscripts structure that
MATLAB passes to subsref and subsasgn.
function obj = subsasgn(obj,s,val)
if isempty(s) && isa(val,'MyDataClass')
obj = MyDataClass(val.Data,val.Description);
end
switch s(1).type
case '.'
obj = builtin('subsasgn',obj,s,val);
case '()'
if length(s)<2
if isa(val,'MyDataClass')
error('MyDataClass:subsasgn',...
'Object must be scalar')
elseif isa(val,'double')
% Redefine the struct s to make the call: obj.Data(i)
snew = substruct('.','Data','()',s(1).subs(:));
obj = subsasgn(obj,snew,val);
end

17-43

17

Specialize Object Behavior

end
case '{}'
error('MyDataClass:subsasgn',...
'Not a supported subscripted assignment')
end
end

Implement Addition for Object Data double and plus

First, implement a double method that converts an object to an array of doubles. By
implementing a double converter method, it is possible to add a MyDataClass object to
another class of object. However, the other class must implement a double method that
also returns an array of doubles. For more information on type conversion, see Object
Converters on page 17-11.
Allow direct addition of the Data property values by implementing a plus method.
Implementing a plus method enables the use of the + operator for addition of
MyDataClass objects.
Because the plus method implements addition by adding double arrays, MATLAB:
Apply the rules of addition when adding MyDataClass objects
Returns errors for any condition that can cause errors in default numeric addition.
For example, dimension mismatch.
The plus method uses the double method to convert the object to numeric values before
performing the addition:
function a = double(obj)
a = obj.Data;
end
function c = plus(obj,b)
c = double(obj) + double(b);
end

For example, the plus method enables you to add a scalar number to the object Data
array.
Here are the values of the Data, displayed using indexed reference:
obj(:,:)
ans =

17-44

Class with Modified Indexing

8
9
2

9
6
1

3
9
9

9
2
9

Add 7 to the array contained in the Data property:

obj + 7
ans =
15
16
9

16
13
8

10
16
16

16
9
16

MyDataClass.m
This definition for MyDataClass includes the end indexing method discussed in end as
Object Index on page 17-36.
classdef MyDataClass
% Example for "A Class with Modified Indexing"
properties
Data
Description
end
properties (SetAccess = private)
Date
end
methods
function obj = MyDataClass(data,desc)
% Support 0-2 args
if nargin > 0
obj.Data = data;
end
if nargin > 1
obj.Description = desc;
end
obj.Date = clock;
end
function sref = subsref(obj,s)
% obj(i) is equivalent to obj.Data(i)
switch s(1).type
case '.'

17-45

17

Specialize Object Behavior

sref = builtin('subsref',obj,s);
case '()'
if length(s)<2
sref = builtin('subsref',obj.Data,s);
return
else
sref = builtin('subsref',obj,s);
end
case '{}'
error('MyDataClass:subsref',...
'Not a supported subscripted reference')
end
end
function obj = subsasgn(obj,s,val)
if isempty(s) && isa(val,'MyDataClass')
obj = MyDataClass(val.Data,val.Description);
end
switch s(1).type
case '.'
obj = builtin('subsasgn',obj,s,val);
case '()'
%
if length(s)<2
if isa(val,'MyDataClass')
error('MyDataClass:subsasgn',...
'Object must be scalar')
elseif isa(val,'double')
snew = substruct('.','Data','()',s(1).subs(:));
obj = subsasgn(obj,snew,val);
end
end
case '{}'
error('MyDataClass:subsasgn',...
'Not a supported subscripted assignment')
end
end
function a = double(obj)
a = obj.Data;
end
function c = plus(obj,b)
c = double(obj) + double(b);

17-46

Class with Modified Indexing

end
function ind = end(obj,k,n)
szd = size(obj.Data);
if k < n
ind = szd(k);
else
ind = prod(szd(k:end));
end
end
end
end

Related Examples

end as Object Index on page 17-36

Number of Arguments for subsref and subsasgn on page 17-5

17-47

17

Specialize Object Behavior

Operator Overloading
In this section...
Why Overload Operators on page 17-48
How to Define Operators on page 17-48
Sample Implementation Addable Objects on page 17-49
MATLAB Operators and Associated Functions on page 17-51

Why Overload Operators

By implementing operators that are appropriate for your class, you can better integrate
objects of your class into the MATLAB language. For example, objects that contain
numeric data can define arithmetic operations like +, *, - so that you can use these
objects in arithmetic expressions. By implementing relational operators, you can use
objects in conditional statements, like switch and if statements.

How to Define Operators

You can implement MATLAB operators to work with objects of your class. To implement
operators, define the associated class methods.
Each operator has an associated function (e.g., the + operator has an associated
plus.m function). You can implement any operator by creating a class method with
the appropriate name. This method can perform whatever steps are appropriate for the
operation being implemented.
For a list of operators and associated function names, see MATLAB Operators and
Associated Functions on page 17-51.
Object Precedence in Operations
User-defined classes have a higher precedence than built-in classes. For example,
suppose q is an object of class double and p is a user-defined class. Both of these
expressions generate a call to the plus method in the user-define class, if it exists:
q + p
p + q

17-48

Operator Overloading

Whether this method can add objects of class double and the user-defined class depends
on how you implement the method.
When p and q are objects of different classes, MATLAB applies the rules of precedence to
determine which method to use.
Object Precedence in Method Invocation on page 9-44 provides information on how
MATLAB determines which method to call.
Operator Precedence
Overloaded operators retain the original MATLAB precedence for the operator. For
information on operator precedence, see Operator Precedence.

Sample Implementation Addable Objects

The Adder class implements addition for objects of this class by defining a plus method.
Adder defines addition of objects as the addition of the NumericData property values.
The plus method constructs and returns an Adder object whose NumericData property
value is the result of the addition.
The Adder class also implements the less than operator (<) by defining a lt method.
The lt method returns a logical value after comparing the values in each object
NumericData property.
classdef Adder
properties
NumericData
end
methods
function obj = Adder(val)
obj.NumericData = val;
end
function r = plus(obj1,obj2)
a = double(obj1);
b = double(obj2);
r = Adder(a + b);
end
function d = double(obj)
d = obj.NumericData;
end
function tf = lt(obj1,obj2)

17-49

17

Specialize Object Behavior

if obj1.NumericData < obj2.NumericData

tf = true;
else
tf = false;
end
end
end
end

Using a double converter enables you to add numeric values to Adder objects as well as
other objects of the class.
a = Adder(1:10)
a =
Adder with properties:
NumericData: [1 2 3 4 5 6 7 8 9 10]

Add two objects:

a + a
ans =
Adder with properties:
NumericData: [2 4 6 8 10 12 14 16 18 20]

Add an object with any value that can be cast to double:

b = uint8(255) + a
b =
Adder with properties:
NumericData: [256 257 258 259 260 261 262 263 264 265]

Compare objects a and b using the < operator:

a < b
ans =

17-50

Operator Overloading

Ensure that your class provides any error checking required to implement your class
design.

MATLAB Operators and Associated Functions

The following table lists the function names for MATLAB operators. Implementing
operators to work with arrays (scalar expansion, vectorized arithmetic operations, and so
on), can also require modifying indexing and concatenation. Use the links in this table to
find specific information on each function.
Operation

Method to Define

Description

a + b

plus(a,b)

Binary addition

a - b

minus(a,b)

Binary subtraction

-a

uminus(a)

Unary minus

+a

uplus(a)

Unary plus

a.*b

times(a,b)

Element-wise multiplication

a*b

mtimes(a,b)

Matrix multiplication

a./b

rdivide(a,b)

Right element-wise division

a.\b

ldivide(a,b)

Left element-wise division

a/b

mrdivide(a,b)

Matrix right division

a\b

mldivide(a,b)

Matrix left division

a.^b

power(a,b)

Element-wise power

a^b

mpower(a,b)

Matrix power

a < b

lt(a,b)

Less than

a > b

gt(a,b)

Greater than

a <= b

le(a,b)

Less than or equal to

a >= b

ge(a,b)

Greater than or equal to

a ~= b

ne(a,b)

Not equal to

a == b

eq(a,b)

Equality

a & b

and(a,b)

Logical AND

a | b

or(a,b)

Logical OR
17-51

17

Specialize Object Behavior

Operation

Method to Define

Description

~a

not(a)

Logical NOT

a:d:b

colon(a,d,b)

Colon operator

a:b

colon(a,b)

a'

ctranspose(a)

Complex conjugate transpose

a.'

transpose(a)

Matrix transpose

[a b]

horzcat(a,b,...)

Horizontal concatenation

[a; b]

vertcat(a,b,...)

Vertical concatenation

a(s1,s2,...sn)

subsref(a,s)

Subscripted reference

a(s1,...,sn) = b

subsasgn(a,s,b)

Subscripted assignment

b(a)

subsindex(a)

Subscript index

Related Examples

17-52

Define Arithmetic Operators on page 19-21

Methods That Modify Default Behavior on page 17-2

18
Customizing Object Display
Custom Display Interface on page 18-2
How CustomDisplay Works on page 18-7
Role of size Function in Custom Displays on page 18-10
Customize Display for Heterogeneous Arrays on page 18-12
Class with Default Object Display on page 18-14
Choose a Technique for Display Customization on page 18-19
Customize Property Display on page 18-23
Customize Header, Property List, and Footer on page 18-26
Customize Display of Scalar Objects on page 18-32
Customize Display of Object Arrays on page 18-36
Overloading the disp Function on page 18-41

18

Customizing Object Display

Custom Display Interface

In this section...
Default Object Display on page 18-2
CustomDisplay Class on page 18-3
Methods for Customizing Object Display on page 18-3

Default Object Display

MATLAB adds default methods named disp and display to all MATLAB classes that
do not implement their own methods with those names. These methods are not visible,
but create the default simple display.
The default simple display consists of the following parts:
A header showing the class name, and the dimensions for nonscalar arrays.
A list of all nonhidden public properties, shown in the order of definition in the class.
The actual display depends on whether the object is scalar or nonscalar. Also, there are
special displays for a scalar handle to a deleted object and empty object arrays. Objects in
all of these states are displayed differently if the objects have no properties.
The details function creates the default detailed display. The detailed display adds
these items to the simple display:
Use of fully qualified class names
Link to handle class, if the object is a handle
Links to methods, events, and superclasses functions executed on the object.
See Class with Default Object Display on page 18-14 for an example of how
MATLAB displays objects.
Properties Displayed by Default
MATLAB displays object properties that have public get access and are not hidden (see
Property Attributes on page 8-7). Inherited abstract properties are excluded from
display. When the object being displayed is scalar, any dynamic properties attached to
the object are also included.
18-2

Custom Display Interface

CustomDisplay Class
The matlab.mixin.CustomDisplay class provides an interface that you can use to
customize object display for your class. To use this interface, derive your class from
CustomDisplay:
classdef MyClass < matlab.mixin.CustomDisplay

The CustomDisplay class is HandleCompatible, so you can use it in combination with

both value and handle superclasses.
Note: You cannot use matlab.mixin.CustomDisplay to derive a custom display for
enumeration classes.
disp, display, and details
The CustomDisplay interface does not allow you to override disp, display, and
details. Instead, override any combination of the customization methods defined for
this purpose.

Methods for Customizing Object Display

There are two groups of methods that you use to customize object display for your class:
Part builder methods build the strings used for the standard display. Override any of
these methods to change the respective parts of the display.
State handler methods are called for objects in specific states, like scalar, nonscalar,
and so on. Override any of these methods to handle objects in a specific state.
All of these methods have protected access and must be defined as protected in your
subclass of CustomDisplay (that is, Access = protected).
Parts of an Object Display
There are three parts that makeup the standard object display header, property list,
and footer
For example, here is the standard object display for a containers.Map object:
18-3

18

Customizing Object Display

The default object display does not include a footer. The detailed display provides more
information:

Part Builder Methods

Each part of the object display has an associated method that assembles the respective
part of the display.
Method

Purpose

Default

getHeader

Create the text used for the header.

Returns the char vectors,

[class(obj), ' with
properties:'] linking the class
name to a help popup

getPropertyGroups
Define how and what properties
display, including order, values, and
grouping.
18-4

Returns an array of PropertyGroup

objects, which determines how to
display the properties

Custom Display Interface

Method

Purpose

Default

getFooter

Create the text used for the footer.

There are two footers:

Simple display Returns an
empty char vector
Detailed display Returns linked
calls to methods, events, and
superclasses for this class

Object States That Affect Display

There are four object states that affect how MATLAB displays objects:
Valid scalar object
Nonscalar object array
Empty object array
Scalar handle to a deleted object
State Handler Methods
Each object state has an associated method that MATLAB calls whenever displaying
objects that are in that particular state.
State Handler Method

Called for Object in This State

displayScalarObject

(isa(obj,'handle') && isvalid(obj))

&& prod(size(obj)) == 1

displayNonScalarObject

prod(size(obj)) > 1

displayEmptyObject

prod(size(obj)) == 0

displayScalarHandleToDeletedObject

isa(obj,'handle') && isscalar(obj) &&

~isvalid(obj)

Utility Methods
The CustomDisplay class provides utility methods that return strings that are used
in various parts of the different display options. These static methods return text that
simplifies the creation of customized object displays.
If the computer display does not support hypertext linking, the strings are returned
without the links.
18-5

18

Customizing Object Display

Method

Inputs

Outputs

convertDimensionsToString

Valid object array

Object dimensions converted to

a char vector; determined by
calling size(obj)

displayPropertyGroups

PropertyGroup array

Displays the titles and property

groups defined

getClassNameForHeader

Object

Simple class name linked to the

objects documentation

getDeletedHandleText

None

Text 'handle to deleted'

linked to the documentation on
deleted handles

getDetailedFooter

Object

Text containing phrase

'Methods, Events,
Superclasses', with each
link executing the respective
command on the input object

getDetailedHeader

Object

Text containing linked class

name, link to handle page
(if handle class) and 'with
properties:'

getHandleText

None

Text 'handle' linked to a

section of the documentation
that describes handle objects

getSimpleHeader

Object

Text containing linked class

name and the phrase 'with
properties:'

Related Examples

18-6

How CustomDisplay Works on page 18-7

How CustomDisplay Works

How CustomDisplay Works

In this section...
Steps to Display an Object on page 18-7
Methods Called for a Given Object State on page 18-8

Steps to Display an Object

When displaying an object, MATLAB determines the state of the object and calls the
appropriate method for that state (see Object States That Affect Display on page 18-5).
For example, suppose obj is a valid scalar object of a class derived from
CustomDisplay. If you type obj at the command line without terminating the
statement with a semicolon:
>> obj

The following sequence results in the display of obj:

1

MATLAB determines the class of obj and calls the disp method to display the
object.

disp calls size to determine if obj is scalar or nonscalar

When obj is a scalar handle object, disp calls isvalid to determine if obj is the
handle of a deleted object. Deleted handles in nonscalar arrays do not affect the
display.

disp calls the state handler method for an object of the state of obj. In this case,
obj is a valid scalar that results in a call to:
displayScalarObject(obj)

displayScalarObject calls the display part-builder methods to provide the

respective header, property list, and footer.
...
header = getHeader(obj);
disp(header)
...
groups = getPropertyGroups(obj)
displayPropertyGroups(obj,groups)
...
footer = getFooter

18-7

18

Customizing Object Display

disp(footer)

MATLAB follows a similar sequence for nonscalar object arrays and empty object arrays.
In the case of scalar handles to deleted objects, disp calls the
displayScalarHandleToDeletedObject method, which displays the default text for
handles to deleted objects without calling any part-builder methods.

Methods Called for a Given Object State

The following diagram illustrates the methods called to display an object that derives
from CustomDisplay. The disp method calls the state handler method that is
appropriate for the state of the object or object array being displayed.
Only an instance of a handle class can be in a state of scalar handle to a deleted object.

18-8

How CustomDisplay Works

Related Examples

Class with Default Object Display on page 18-14

18-9

18

Customizing Object Display

Role of size Function in Custom Displays

In this section...
How size Is Used on page 18-10
Precautions When Overloading size on page 18-10

How size Is Used

In the process of building the custom display, CustomDisplay methods call the size
function at several points:
disp calls size to determine which state handler method to invoke.
The default getHeader method calls size to determine whether to display a scalar
or nonscalar header.
The default displayPropertyGroups method calls size to determine if it should
look up property values when the property group is a cell array of property names. By
default, only scalar objects display the values of properties.

Precautions When Overloading size

If your class overloads the size function, then MATLAB calls the overloading version.
You must ensure that the implementation of size is consistent with the way you want to
display objects of the class.
An unusual or improper implementation of size can result in undesirable display
behavior. For example, suppose a class overloads size reports an object as scalar when
it is not. In this class, a property list consisting of a cell array of strings results in the
property values of the first object of the array being displayed. This behavior can give the
impression that all objects in the array have the same property values.
However, reporting an object as scalar when in fact the object is empty results in the
object displaying as an empty object array. The default methods of the CustomDisplay
interface always determine if the input is an empty array before attempting to access
property values.
As you override CustomDisplay methods to implement your custom object display,
consider how an overloading size method can affect the result.
18-10

Role of size Function in Custom Displays

Related Examples

Methods That Modify Default Behavior on page 17-2

18-11

18

Customizing Object Display

Customize Display for Heterogeneous Arrays

You can call only sealed methods on nonscalar heterogeneous arrays. If you want to
customize classes that are part of a heterogeneous hierarchy, you must override and
declare as Sealed all the methods that are part of the CustomDisplay interface.
The versions of disp and display that are inherited from matlab.mixin.CustomDisplay
are sealed. However, these methods call all of the part builder (Part Builder Methods
on page 18-4) and state handler methods (State Handler Methods on page 18-5).
To use the CustomDisplay interface, the root class of the heterogeneous hierarchy can
declare these methods as Sealed and Access = protected.
If you do not need to override a particular method, then call the superclass method, as
shown in the following code.
For example, the following code shows modifications to the getPropertyGroups and
displayScalarObject methods, while using the superclass implementation of all
others.
classdef RootClass < matlab.mixin.CustomDisplay & matlab.mixin.Heterogeneous
%...
methods (Sealed, Access = protected)
function header = getHeader(obj)
header = getHeader@matlab.mixin.CustomDisplay(obj);
end
function groups = getPropertyGroups(obj)
% Override of this method
% ...
end
function footer = getFooter(obj)
footer = getFooter@matlab.mixin.CustomDisplay(obj);
end
function displayNonScalarObject(obj)
displayNonScalarObject@matlab.mixin.CustomDisplay(obj);
end
function displayScalarObject(obj)
% Override of this method
% ...
end
function displayEmptyObject(obj)
displayEmptyObject@matlab.mixin.CustomDisplay(obj);
end

18-12

Customize Display for Heterogeneous Arrays

function displayScalarHandleToDeletedObject(obj)
displayScalarHandleToDeletedObject@matlab.mixin.CustomDisplay(obj);
end
end
end

You do not need to declare the inherited static methods as Sealed.

Related Examples

Heterogeneous Arrays on page 10-21

18-13

18

Customizing Object Display

Class with Default Object Display

In this section...
The EmployeeInfo Class on page 18-14
Default Display Scalar on page 18-15
Default Display Nonscalar on page 18-15
Default Display Empty Object Array on page 18-16
Default Display Handle to Deleted Object on page 18-17
Default Display Detailed Display on page 18-17

The EmployeeInfo Class

The EmployeeInfo class defines a number of properties to store information about
company employees. This simple class serves as the example class used in display
customization sample classes.
EmployeeInfo derives from the matlab.mixin.CustomDisplay class to enable
customization of the object display.
EmployeeInfo is also a handle class. Therefore instances of this class can be in the state
referred to as a handle to a deleted object. This state does not occur with value classes
(classes not derived from handle).
classdef EmployeeInfo < handle & matlab.mixin.CustomDisplay
properties
Name
JobTitle
Department
Salary
Password
end
methods
function obj = EmployeeInfo
obj.Name
= input('Name: ');
obj.JobTitle
= input('Job Title: ');
obj.Department = input('Department: ');
obj.Salary
= input('Salary: ');
obj.Password
= input('Password: ');
end

18-14

Class with Default Object Display

end
end

The matlab.mixin.CustomDisplay is handle compatible. Therefore, superclasses can

be either handle or value classes.

Default Display Scalar

Here is the creation and display of a scalar EmployeeInfo object. By default, MATLAB
displays properties and their values for scalar objects.
Provide inputs for the constructor:
>>Emp123 = EmployeeInfo;
Name: 'Bill Tork'
Job Title: 'Software Engineer'
Department: 'Product Development'
Salary: 1000
Password: 'bill123'

Display the object:

>>Emp123
Emp123 =
EmployeeInfo with properties:
Name:
JobTitle:
Department:
Salary:
Password:

'Bill Tork'
'Software Engineer'
'Product Development'
1000
'bill123'

Testing for Scalar Objects

To test for scalar objects, use isscalar.

Default Display Nonscalar

The default display for an array of objects does not show property values. For example,
concatenating two EmployeeInfo objects generates this display:
18-15

18

Customizing Object Display

>>[Emp123,Emp124]
ans
1x2 EmployeeInfo array with properties:
Name
JobTitle
Department
Salary
Password

Testing for Nonscalar Objects

To test for nonscalar objects, use a negated call to isscalar .

Default Display Empty Object Array

An empty object array has at least one dimension equal to zero.
>> Empt = EmployeeInfo.empty(0,5)
Empt =
0x5 EmployeeInfo array with properties:
Name
JobTitle
Department
Salary
Password

Testing for Empty Object Arrays

Use isempty to test for empty object arrays. An empty object array is not scalar because
its dimensions can never be 1by-1.
>> emt = EmployeeInfo.empty
emt =
0x0 EmployeeInfo array with properties:
Name
JobTitle

18-16

Class with Default Object Display

Department
Salary
Password
>> isscalar(emt)
ans =
0

Default Display Handle to Deleted Object

When a handle object is deleted, the handle variable can remain in the workspace.
>> delete(Emp123)
>> Emp123
Emp123 =
handle to deleted EmployeeInfo

Testing for Handles to Deleted Objects

To test for a handle to a deleted object, use isvalid.
Note: isvalid is a handle class method. Calling isvalid on a value class object causes
an error.

Default Display Detailed Display

The details method does not support customization and always returns the standard
detailed display:
details(Emp123)
EmployeeInfo handle with properties:
Name:
JobTitle:
Department:
Salary:
Password:

'Bill Tork'
'Software Engineer'
'Product Development'
1000
'bill123'

Methods, Events, Superclasses

18-17

18

Customizing Object Display

Related Examples

18-18

Custom Display Interface on page 18-2

Choose a Technique for Display Customization

Choose a Technique for Display Customization

In this section...
Ways to Implement a Custom Display on page 18-19
Sample Approaches Using the Interface on page 18-20

Ways to Implement a Custom Display

The way you customize object display using the matlab.mixin.CustomDisplay class
depends on:
What parts of the display you want to customize
What object states you want to use the custom display
If you are making small changes to the default layout, then override the relevant part
builder methods (Part Builder Methods on page 18-4). For example, suppose you want
to:
Change the order or value of properties, display a subset of properties, or create
property groups
Modify the header text
Add a footer
If you are defining a nonstandard display for a particular object state (scalar, for
example), then the best approach is to override the appropriate state handler method
(State Handler Methods on page 18-5).
In some cases, a combination of method overrides might be the best approach. For
example, your implementation of displayScalarObject might
Use some of the utility methods (Utility Methods on page 18-5) to build your own
display strings using parts from the default display
Call a part builder method to get the default text for that particular part of the
display
Implement a completely different display for scalar objects.
Once you override any CustomDisplay method, MATLAB calls your override in all cases
where the superclass method would have been called. For example, if you override the
18-19

18

Customizing Object Display

getHeader method, your override must handle all cases where a state handler method
calls getHeader. (See Methods Called for a Given Object State on page 18-8)

Sample Approaches Using the Interface

Here are some simple cases that show what methods to use for the particular customized
display.
Change the Display of Scalar Objects
Use a nonstandard layout for scalar object display that is fully defined in the
displayScalarObject method:
classdef MyClass < matlab.mixin.CustomDisplay
...
methods (Access = protected)
function displayScalarObject(obj)
% Implement the custom display for scalar obj
end
end
end

Custom Property List with Standard Layout

Use standard display layout, but create a custom property list for scalar and nonscalar
display:
classdef MyClass < matlab.mixin.CustomDisplay
...
methods(Access = protected)
function groups = getPropertyGroups(obj)
% Return PropertyGroup instances
end
end
end

Custom Property List for Scalar Only

Use standard display layout, but create a custom property list for scalar only. Call the
superclass getPropertyGroups for the nonscalar case.
classdef MyClass < matlab.mixin.CustomDisplay
properties

18-20

Choose a Technique for Display Customization

Prop1
Prop2
Prop3
end
methods(Access = protected)
function groups = getPropertyGroups(obj)
if isscalar(obj)
% Scalar case: change order
propList = {'Prop2','Prop1','Prop3'};
groups = matlab.mixin.util.PropertyGroup(propList)
else
% Nonscalar case: call superclass method
groups = getPropertyGroups@matlab.mixin.CustomDisplay(obj);
end
end
end
end

Custom Property List with Modified Values

Change the values displayed for some properties in the scalar case by creating property/
value pairs in a struct. This getPropertyGroups method displays only Prop1 and
Prop2, and displays the value of Prop2 as Prop1 divided by Prop3.
classdef MyClass < matlab.mixin.CustomDisplay
properties
Prop1
Prop2
Prop3
end
methods(Access = protected)
function groups = getPropertyGroups(obj)
if isscalar(obj)
% Specify the values to be displayed for properties
propList = struct('Prop1',obj.Prop1,...
'Prop2',obj.Prop1/obj.Prop3);
groups = matlab.mixin.util.PropertyGroup(propList)
else
% Nonscalar case: call superclass method
groups = getPropertyGroups@matlab.mixin.CustomDisplay(obj);
end
end
end
end

Complete Class Definitions

For complete class implementations, see these sections:
Customize Property Display on page 18-23
Customize Header, Property List, and Footer on page 18-26
18-21

18

Customizing Object Display

Customize Display of Scalar Objects on page 18-32

Customize Display of Object Arrays on page 18-36

18-22

Customize Property Display

Customize Property Display

In this section...
Objective on page 18-23
Change the Property Order on page 18-23
Change the Values Displayed for Properties on page 18-24

Objective
Change the order and number of properties displayed for an object of your class.

Change the Property Order

Suppose your class definition contains the following property definition:
properties
Name
JobTitle
Department
Salary
Password
end

In the default scalar object display, MATLAB displays all the public properties along
with their values. However, you want to display only Department, JobTitle, and Name,
in that order. You can do this by deriving from CustomDisplay and overriding the
getPropertyGroups method.
Your override
Defines method Access as protected to match the definition in the
CustomDisplay superclass
Creates a cell array of property names in the desired order
Returns a PropertyGroup object constructed from the property list cell array
methods (Access = protected)
function propgrp = getPropertyGroups(~)
proplist = {'Department','JobTitle','Name'};
propgrp = matlab.mixin.util.PropertyGroup(proplist);
end

18-23

18

Customizing Object Display

end

When you create a PropertyGroup object using a cell array of property names,
MATLAB automatically
Adds the property values for a scalar object display
Uses the property names without values for a nonscalar object display (including
empty object arrays)
The getPropertyGroups method is not called to create the display for a scalar handle
to a deleted object.

Change the Values Displayed for Properties

Given the same class properties used in the previous section, you can change the value
displayed for properties by building the property list as a struct and specifying values
for property names. This override of the getPropertyGroups method uses the default
property display for nonscalar objects by calling the superclass getPropertyGroups
method. For scalar objects, the override:
Changes the value displayed for the Password property to a '*' character for each
character in the password.
Displays the text 'Not Available' for the Salary property.
methods (Access = protected)
function propgrp = getPropertyGroups(obj)
if ~isscalar(obj)
propgrp = getPropertyGroups@matlab.mixin.CustomDisplay(obj);
else
pd(1:length(obj.Password)) = '*';
propList = struct('Department',obj.Department,...
'JobTitle',obj.JobTitle,...
'Name',obj.Name,...
'Salary','Not available',...
'Password',pd);
propgrp = matlab.mixin.util.PropertyGroup(propList);
end
end
end

The object display looks like this:

EmployeeInfo with properties:
Department: 'Product Development'

18-24

Customize Property Display

JobTitle:
Name:
Salary:
Password:

'Software Engineer'
'Bill Tork'
'Not available'
'*******'

Full Class Listing

classdef EmployeeInfo < handle & matlab.mixin.CustomDisplay
properties
Name
JobTitle
Department
Salary
Password
end
methods
function obj = EmployeeInfo
obj.Name
= input('Name: ');
obj.JobTitle
= input('Job Title: ');
obj.Department = input('Department: ');
obj.Salary
= input('Salary: ');
obj.Password
= input('Password: ');
end
end
methods (Access = protected)
function propgrp = getPropertyGroups(obj)
if ~isscalar(obj)
propgrp = getPropertyGroups@matlab.mixin.CustomDisplay(obj);
else
pd(1:length(obj.Password)) = '*';
propList = struct('Department',obj.Department,...
'JobTitle',obj.JobTitle,...
'Name',obj.Name,...
'Salary','Not available',...
'Password',pd);
propgrp = matlab.mixin.util.PropertyGroup(propList);
end
end
end

Related Examples

Choose a Technique for Display Customization on page 18-19

18-25

18

Customizing Object Display

Customize Header, Property List, and Footer

In this section...
Objective on page 18-26
Design of Custom Display on page 18-26
getHeader Method Override on page 18-28
getPropertyGroups Override on page 18-29
getFooter Override on page 18-29

Objective
Customize each of the three parts of the display header, property groups, and footer.

Design of Custom Display

Note: This example uses the EmployeeInfo class described in the Class with Default
Object Display on page 18-14 section.
For the header:
Use default header for nonscalar object arrays.
Build header text with linked class name and department name (from Department
property)
For properties:
Nonscalar object arrays display a subset of property names in a different order than
the default.
Scalar objects create two property groups that have titles (Public Info and
Personal Info).
For the footer:
Add a footer to the display, only when the object is a valid scalar that displays
property values.
18-26

Customize Header, Property List, and Footer

Here is the customized display of an object of the EmployeeInfo class.

Emp123 =
EmployeeInfo Dept: Product Development
Public Info
Name: 'Bill Tork'
JobTitle: 'Software Engineer'
Personal Info
Salary: 1000
Password: 'bill123'
Company Private

Here is the custom display of an array of EmployeeInfo objects:

[Emp123,Emp124]
ans =
1x2 EmployeeInfo array with properties:
Department
Name
JobTitle

Here is the display of an empty object array:

>> EmployeeInfo.empty(0,5)
ans =
0x5 EmployeeInfo array with properties:
Department
Name
JobTitle

Here is the display of a handle to a delete object (EmployeeInfo is a handle class):

>> delete(Emp123)
>> Emp123

18-27

18

Customizing Object Display

Emp123 =
handle to deleted EmployeeInfo

Implementation
The EmployeeInfo class overrides three matlab.mixin.CustomDisplay methods to
implement the display shown:
getHeader
getPropertyGroups
getFooter
Each method must produce the desired results with each of the following inputs:
Scalar object
Nonscalar object array
Empty object array

getHeader Method Override

MATLAB calls getHeader to get the header text. The EmployeeInfo class overrides
this method to implement the custom header for scalar display. Here is how it works:
Nonscalar (including empty object) arrays call the superclass getHeader, which
returns the default header.
Scalar handles to deleted objects do not result in a call to getHeader.
Scalar inputs build a custom header using the getClassNameForHeader static method
to return linked class name text, and the value of the Department property.
Here is the EmployeeInfo override of the getHeader method. The required protected
access is inherited from the superclass.
methods (Access = protected)
function header = getHeader(obj)
if ~isscalar(obj)
header = getHeader@matlab.mixin.CustomDisplay(obj);
else
className = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);
newHeader = [className,' Dept: ',obj.Department];
header = sprintf('%s\n',newHeader);
end
end

18-28

Customize Header, Property List, and Footer

end

getPropertyGroups Override
MATLAB calls getPropertyGroups to get the PropertyGroup objects, which control
how properties are displayed. This method override defines two different property lists
depending on the objects state:
For nonscalar inputs, including empty arrays and arrays containing handles to
deleted objects, create a property list as a cell array to reorder properties.
By default, MATLAB does not display property values for nonscalar inputs.
For scalar inputs, create two property groups with titles. The scalar code branch
lists properties in a different order than the nonscalar case and includes Salary and
Password properties. MATLAB automatically assigns property values.
Scalar handles to deleted objects do not result in a call to getPropertyGroups.
Both branches return a matlab.mixin.util.PropertyGroup object, which determines how
to displays the object properties.
Here is the EmployeeInfo override of the getPropertyGroups method. The protected
access is inherited from the superclass.
methods (Access = protected)
function propgrp = getPropertyGroups(obj)
if ~isscalar(obj)
propList = {'Department','Name','JobTitle'};
propgrp = matlab.mixin.util.PropertyGroup(propList);
else
gTitle1 = 'Public Info';
gTitle2 = 'Personal Info';
propList1 = {'Name','JobTitle'};
propList2 = {'Salary','Password'};
propgrp(1) = matlab.mixin.util.PropertyGroup(propList1,gTitle1);
propgrp(2) = matlab.mixin.util.PropertyGroup(propList2,gTitle2);
end
end
end

getFooter Override
MATLAB calls getFooter to get the footer text. The EmployeeInfo getFooter
method defines a footer for the display, which is included only when the input is a valid
scalar object. In all other cases, getFooter returns an empty char vector.
18-29

18

Customizing Object Display

Scalar handles to deleted objects do not result in a call to getFooter.

methods (Access = protected)
function footer = getFooter(obj)
if isscalar(obj)
footer = sprintf('%s\n','Company Private');
else
footer = '';
end
end
end

Complete Class Listing

classdef EmployeeInfo < handle & matlab.mixin.CustomDisplay
properties
Name
JobTitle
Department
Salary
Password
end
methods
function obj = EmployeeInfo
obj.Name
= input('Name: ');
obj.JobTitle
= input('Job Title: ');
obj.Department = input('Department: ');
obj.Salary
= input('Salary: ');
obj.Password
= input('Password: ');
end
end
methods (Access = protected)
function header = getHeader(obj)
if ~isscalar(obj)
header = getHeader@matlab.mixin.CustomDisplay(obj);
else
className = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);
newHeader = [className,' Dept: ',obj.Department];
header = sprintf('%s\n',newHeader);
end
end
function propgrp = getPropertyGroups(obj)
if ~isscalar(obj)
propList = {'Department','Name','JobTitle'};
propgrp = matlab.mixin.util.PropertyGroup(propList);
else
gTitle1 = 'Public Info';
gTitle2 = 'Personal Info';
propList1 = {'Name','JobTitle'};
propList2 = {'Salary','Password'};
propgrp(1) = matlab.mixin.util.PropertyGroup(propList1,gTitle1);

18-30

Customize Header, Property List, and Footer

propgrp(2) = matlab.mixin.util.PropertyGroup(propList2,gTitle2);
end
end
function footer = getFooter(obj)
if isscalar(obj)
footer = sprintf('%s\n','Company Private');
else
footer = '';
end
end
end
end

Related Examples

Choose a Technique for Display Customization on page 18-19

18-31

18

Customizing Object Display

Customize Display of Scalar Objects

In this section...
Objective on page 18-32
Design Of Custom Display on page 18-32
displayScalarObject Method Override on page 18-33
getPropertyGroups Override on page 18-34

Objective
Customize the display of scalar objects.

Design Of Custom Display

Note: This example uses the EmployeeInfo class described in the Class with Default
Object Display on page 18-14 section.
The objective of this customized display is to:
Modify the header to include the department name obtained from the Department
property
Group properties into two categories titled Public Info and Personal Info.
Modify which properties are displayed
Modify the values displayed for Personal Info category
Use the default displayed for nonscalar objects, including empty arrays, and scalar
deleted handles
For example, here is the customized display of an object of the EmployeeInfo class.
Emp123 =
EmployeeInfo Dept: Product Development
Public Info
Name: 'Bill Tork'
JobTitle: 'Software Engineer'

18-32

Customize Display of Scalar Objects

Personal Info
Salary: 'Level: 10'
Password: '*******'

Implementation
The EmployeeInfo class overrides two matlab.mixin.CustomDisplay methods to
implement the display shown:
displayScalarObject Called to display valid scalar objects
getPropertyGroups Builds the property groups for display

displayScalarObject Method Override

MATLAB calls displayScalarObject to display scalar objects. The EmployeeInfo
class overrides this method to implement the scalar display. Once overridden, this
method must control all aspects of scalar object display, including creating the header,
property groups, and footer, if used.
This implementation:
Builds a custom header using the getClassNameForHeader static method to
return linked class name text and the value of the Department property to get the
department name.
Uses sprintf to add a new line to the header text
Displays the header with the built-in disp function.
Calls the getPropertyGroups override to define the property groups (see following
section).
Displays the property groups using the displayPropertyGroups static method.
Here is the EmployeeInfo override of the displayScalarObject method. The
required protected access is inherited from the superclass.
methods (Access = protected)
function displayScalarObject(obj)
className = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);
scalarHeader = [className,' Dept: ',obj.Department];
header = sprintf('%s\n',scalarHeader);
disp(header)
propgroup = getPropertyGroups(obj);
matlab.mixin.CustomDisplay.displayPropertyGroups(obj,propgroup)
end

18-33

18

Customizing Object Display

end

getPropertyGroups Override
MATLAB calls getPropertyGroups when displaying scalar or nonscalar objects.
However, MATLAB does not call this method when displaying a scalar handle to a
deleted object.
The EmployeeInfo class overrides this method to implement the property groups for
scalar object display.
This implementation calls the superclass getPropertyGroups method if the input is
not scalar. If the input is scalar, this method:
Defines two titles for the two groups
Creates a cell array of property names that are included in the first group. MATLAB
adds the property values for the display
Creates a struct array of property names with associated property values for the
second group. Using a struct instead of a cell array enables you to replace the values
that are displayed for the Salary and Password properties without changing the
personal information stored in the object properties.
Constructs two matlab.mixin.util.PropertyGroup objects, which are used by the
displayScalarObject method.
Here is the EmployeeInfo override of the getPropertyGroups method. The required
protected access is inherited from the superclass.
methods (Access = protected)
function propgrp = getPropertyGroups(obj)
if ~isscalar(obj)
propgrp = getPropertyGroups@matlab.mixin.CustomDisplay(obj);
else
gTitle1 = 'Public Info';
gTitle2 = 'Personal Info';
propList1 = {'Name','JobTitle'};
pd(1:length(obj.Password)) = '*';
level = round(obj.Salary/100);
propList2 = struct('Salary',...
['Level: ',num2str(level)],...
'Password',pd);
propgrp(1) = matlab.mixin.util.PropertyGroup(propList1,gTitle1);
propgrp(2) = matlab.mixin.util.PropertyGroup(propList2,gTitle2);
end
end
end

18-34

Customize Display of Scalar Objects

Complete Class Listing

classdef EmployeeInfo4 < handle & matlab.mixin.CustomDisplay
properties
Name
JobTitle
Department
Salary
Password
end
methods
function obj = EmployeeInfo4
obj.Name
= input('Name: ');
obj.JobTitle
= input('Job Title: ');
obj.Department = input('Department: ');
obj.Salary
= input('Salary: ');
obj.Password
= input('Password: ');
end
end
methods (Access = protected)
function displayScalarObject(obj)
className = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);
scalarHeader = [className,' Dept: ',obj.Department];
header = sprintf('%s\n',scalarHeader);
disp(header)
propgroup = getPropertyGroups(obj);
matlab.mixin.CustomDisplay.displayPropertyGroups(obj,propgroup)
end
function propgrp = getPropertyGroups(obj)
if ~isscalar(obj)
propgrp = getPropertyGroups@matlab.mixin.CustomDisplay(obj);
else
% property groups for scalars
gTitle1 = 'Public Info';
gTitle2 = 'Personal Info';
propList1 = {'Name','JobTitle'};
pd(1:length(obj.Password)) = '*';
level = round(obj.Salary/100);
propList2 = struct('Salary',...
['Level: ',num2str(level)],...
'Password',pd);
propgrp(1) = matlab.mixin.util.PropertyGroup(propList1,gTitle1);
propgrp(2) = matlab.mixin.util.PropertyGroup(propList2,gTitle2);
end
end
end
end

Related Examples

Choose a Technique for Display Customization on page 18-19

18-35

18

Customizing Object Display

Customize Display of Object Arrays

In this section...
Objective on page 18-36
Design of Custom Display on page 18-36
The displayNonScalarObject Override on page 18-37
The displayEmptyObject Override on page 18-38

Objective
Customize the display of nonscalar objects, including empty object arrays.

Design of Custom Display

Note: This example uses the EmployeeInfo class described in the Class with Default
Object Display on page 18-14 section.
The objective of this customized display is to:
Construct a custom header using some elements of the default header
Display a subset of property-specific information for each object in the array.
List handles to deleted objects in the array using a char vector with links to
documentation for handle objects and the class.
Display empty objects with a slight modification to the default header
Here is the customized display of an array of three EmployeeInfo objects
1x3 EmployeeInfo array with members:
1. Employee:
Name: 'Bill Tork'
Department: 'Product Development'
2. Employee:
Name: 'Alice Blackwell'
Department: 'QE'

18-36

Customize Display of Object Arrays

3. Employee:
Name: 'Nancy Green'
Department: 'Documentation'

Deleted object handles in the array indicate their state:

1x3 EmployeeInfo members:
1. Employee:
Name: 'Bill Tork'
Department: 'Product Development'
2. handle to deleted EmployeeInfo
3. Employee:
Name: 'Nancy Green'
Department: 'Documentation'

To achieve the desired result, the EmployeeInfo class overrides the following methods
of the matlab.mixin.CustomDisplay class:
displayNonScalarObject Called to display nonempty object arrays
displayEmptyObject Called to display empty object arrays

The displayNonScalarObject Override

MATLAB calls the displayNonScalarObject method to display object arrays. The
override of this method in the EmployeeInfo class:
Builds header text using convertDimensionsToString to obtain the array size and
getClassNameForHeader to get the class name with a link to the help for that class.
Displays the modified header text.
Loops through the elements in the array, building two different subheaders
depending on the individual object state. In the loop, this method:
Detects handles to deleted objects (using the isvalid handle class method). Uses
getDeletedHandleText and getClassNameForHeader to build text for array
elements that are handles to deleted objects.
Builds a custom subheader for valid object elements in the array
Creates a PropertyGroup object containing the Name and Department properties for
valid objects
18-37

18

Customizing Object Display

Uses the displayPropertyGroups static method to generate the property display for
valid objects.
Here is the implementation of displayNonScalarObjects:
methods (Access = protected)
function displayNonScalarObject(objAry)
dimStr = matlab.mixin.CustomDisplay.convertDimensionsToString(objAry);
cName = matlab.mixin.CustomDisplay.getClassNameForHeader(objAry);
headerStr = [dimStr,' ',cName,' members:'];
header = sprintf('%s\n',headerStr);
disp(header)
for ix = 1:length(objAry)
o = objAry(ix);
if ~isvalid(o)
str1 = matlab.mixin.CustomDisplay.getDeletedHandleText;
str2 = matlab.mixin.CustomDisplay.getClassNameForHeader(o);
headerInv = [str1,' ',str2];
tmpStr = [num2str(ix),'. ',headerInv];
numStr = sprintf('%s\n',tmpStr);
disp(numStr)
else
numStr = [num2str(ix),'. Employee:'];
disp(numStr)
propList = struct('Name',o.Name,...
'Department',o.Department);
propgrp = matlab.mixin.util.PropertyGroup(propList);
matlab.mixin.CustomDisplay.displayPropertyGroups(o,propgrp);
end
end
end
end

The displayEmptyObject Override

MATLAB calls the displayEmptyObject method to display empty object arrays. The
implementation of this method in the EmployeeInfo class builds a custom header for
empty objects following these steps:
Gets the array dimensions in character format using the
convertDimensionsToString static method.
Gets text with the class name linked to the helpPopup function using the
getClassNameForHeader static method.
Builds and displays the custom text for empty arrays.
methods (Access = protected)
function displayEmptyObject(obj)
dimstr = matlab.mixin.CustomDisplay.convertDimensionsToString(obj);
className = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);

18-38

Customize Display of Object Arrays

emptyHeader = [dimstr,' ',className,' with no employee information'];

header = sprintf('%s\n',emptyHeader);
disp(header)
end
end

For example, an empty EmployeeInfo object displays like this:

Empt = EmployeeInfo.empty(0,5)
Empt =
0x5 EmployeeInfo with no employee information

Complete Class Listing

classdef EmployeeInfo < handle & matlab.mixin.CustomDisplay
properties
Name
JobTitle
Department
Salary
Password
end
methods
function obj = EmployeeInfo
obj.Name
= input('Name: ');
obj.JobTitle
= input('Job Title: ');
obj.Department = input('Department: ');
obj.Salary
= input('Salary: ');
obj.Password
= input('Password: ');
end
end
methods (Access = protected)
function displayNonScalarObject(objAry)
dimStr = matlab.mixin.CustomDisplay.convertDimensionsToString(objAry);
cName = matlab.mixin.CustomDisplay.getClassNameForHeader(objAry);
headerStr = [dimStr,' ',cName,' members:'];
header = sprintf('%s\n',headerStr);
disp(header)
for ix = 1:length(objAry)
o = objAry(ix);
if ~isvalid(o)
str1 = matlab.mixin.CustomDisplay.getDeletedHandleText;
str2 = matlab.mixin.CustomDisplay.getClassNameForHeader(o);
headerInv = [str1,' ',str2];
tmpStr = [num2str(ix),'. ',headerInv];
numStr = sprintf('%s\n',tmpStr);
disp(numStr)
else
numStr = [num2str(ix),'. Employee'];
disp(numStr)
propList = struct('Name',o.Name,...
'Department',o.Department);

18-39

18

Customizing Object Display

propgrp = matlab.mixin.util.PropertyGroup(propList);
matlab.mixin.CustomDisplay.displayPropertyGroups(o,propgrp);
end
end
end
function displayEmptyObject(obj)
dimstr = matlab.mixin.CustomDisplay.convertDimensionsToString(obj);
className = matlab.mixin.CustomDisplay.getClassNameForHeader(obj);
emptyHeader = [dimstr,' ',className,' with no employee information'];
header = sprintf('%s\n',emptyHeader);
disp(header)
end
end
end

Related Examples

18-40

Choose a Technique for Display Customization on page 18-19

Overloading the disp Function

Overloading the disp Function

In this section...
Display Methods on page 18-41
Overloaded disp on page 18-41
Relationship Between disp and display on page 18-41

Display Methods
Subclassing matlab.mixin.CustomDisplay is the best approach to customizing object
display. However, if you do not derive your class from matlab.mixin.CustomDisplay,
overload the disp function to change how MATLAB displays objects of your class.
MATLAB calls the display function whenever an object is referred to in a statement
that is not terminated by a semicolon. For example, the following statement creates the
variable a. MATLAB calls display, which displays the value of a in the command line.
a = 5
a =
5

display then calls disp.

Overloaded disp
The built-in display function prints the name of the variable that is being displayed, if
an assignment is made, or otherwise uses ans as the variable name. Then display calls
disp to handle the actual display of the values.
If the variable that is being displayed is an object of a class that overloads disp, then
MATLAB always calls the overloaded method. MATLAB calls display with two
arguments and passes the variable name as the second argument.

Relationship Between disp and display

MATLAB invokes the built-in display function when:
18-41

18

Customizing Object Display

MATLAB executes a statement that returns a value and is not terminated with a
semicolon.
There is no left-side variable, then MATLAB prints ans = followed by the value.
Code explicitly invokes the display function.
When invoked display:
If the input argument is an existing variable, display prints the variable name and
equal sign, followed by the value.
If the input is the result of an expression, display does not print ans =.
MATLAB invokes the built-in disp function when:
The built-in display function calls disp.
Code explicitly invokes disp.
For empty built-in types (numeric types, char, struct, and cell) the display function
displays:
[] for numeric types
"0x0 struct array with no fields." for empty structs.
"Empty cell array: 0-by-1" for empty cell arrays.
'' for empty char arrays
disp differs from display in these ways:
disp does not print the variable name or ans.
disp prints nothing for built-in types (numeric types, char, struct, and cell) when
the value is empty.

Related Examples

18-42

Custom Display Interface on page 18-2

Overload disp for DocPolynom on page 19-17

19
Implementing a Class for Polynomials

19

Implementing a Class for Polynomials

Class Design for Polynomials

In this section...
Object Requirements on page 19-2
DocPolynom Class Members on page 19-2
DocPolynom Class Synopsis on page 19-4
The DocPolynom Constructor on page 19-13
Remove Irrelevant Coefficients on page 19-14
Convert DocPolynom Objects to Other Types on page 19-15
Overload disp for DocPolynom on page 19-17
Display Evaluated Expression on page 19-18
Redefine Indexed Reference on page 19-19
Define Arithmetic Operators on page 19-21

Object Requirements
This example implements a class to represent polynomials in the MATLAB language.
The design requirements are:
Value class behaviora polynomial object should behave like MATLAB numeric
variables when copied and passed to functions.
Specialized display and indexing
Objects can be scalar only. The specialization of display and indexing functionality
preclude normal array behavior.
Arithmetic operations
Double converter simplifying the use of polynomial object with existing MATLAB
functions that accept numeric inputs.

DocPolynom Class Members

The class definition specifies a property for data storage and defines a folder
(@DocPolynom) that contains the class definition.
The following table summarizes the properties defined for the DocPolynom class.
19-2

Class Design for Polynomials

DocPolynom Class Properties

Name

Class

Default

Description

coef

double

[]

Vector of polynomial coefficients [highest

order ... lowest order]

The following table summarizes the methods for the DocPolynom class.
DocPolynom Class Methods
Name

Description

DocPolynom

Class constructor

double

Converts a DocPolynom object to a double (i.e., returns its

coefficients in a vector)

char

Creates a formatted display of the DocPolynom object as powers

of x and is used by the disp method

disp

Determines how MATLAB displays a DocPolynom objects on the

command line

subsref

Enables you to specify a value for the independent variable as a

subscript, access the coef property with dot notation, and call
methods with dot notation.

plus

Implements addition of DocPolynom objects

minus

Implements subtraction of DocPolynom objects

mtimes

Implements multiplication of DocPolynom objects

Using the DocPolynom Class

The following examples illustrate basic use of the DocPolynom class.
Create DocPolynom objects to represent the following polynomials. Note that
the argument to the constructor function contains the polynomial coefficients
and

p1 = DocPolynom([1 0 -2 -5])
p1 =
x^3 - 2*x - 5
p2 = DocPolynom([2 0 3 2 -7])

19-3

19

Implementing a Class for Polynomials

p2 =
2*x^4 + 3*x^2 + 2*x - 7

Find the roots of the polynomial by passing the coefficients to the roots function.
roots(p1.coef)
ans =
2.0946 + 0.0000i
-1.0473 + 1.1359i
-1.0473 - 1.1359i

Add the two polynomials p1 and p2.

MATLAB calls the plus method defined for the DocPolynom class when you add two
DocPolynom objects.
p1 + p2
ans =
2*x^4 + x^3 + 3*x^2 - 12

DocPolynom Class Synopsis

Example Code
classdef DocPolynom

properties
coef
end
methods

function obj = DocPolynom(c)

if nargin > 0
if isa(c,'DocPolynom')
obj.coef = c.coef;
else
obj.coef = c(:).';
end
end
end

19-4

Discussion
Value class that implements a
data type for polynomials.
Vector of polynomial coefficients
[highest order ... lowest order]
For general information
about methods, see Ordinary
Methods on page 9-7
Class constructor creates objects
using:
Coefficient vector of existing
object
Coefficient vector passed as
argument

Class Design for Polynomials

Example Code

function obj = set.coef(obj,val)

if ~isa(val,'double')
error('Coefficients must be doubles')
end
ind = find(val(:).'~=0);
if ~isempty(ind);
obj.coef = val(ind(1):end);
else
obj.coef = val;
end
end

function c = double(obj)
c = obj.coef;
end

Discussion
See The DocPolynom
Constructor on page 19-13
Set method for coef property:
Allows coefficients only of
type double
Removes leading zeros from
the coefficient vector.
See Remove Irrelevant
Coefficients on page 19-14
Convert DocPolynom object
to double by returning the
coefficients.
See Convert DocPolynom
Objects to Other Types on page
19-15

19-5

19

Implementing a Class for Polynomials

Example Code
function str = char(obj)
if all(obj.coef == 0)
s = '0';
str = s;
return
else
d = length(obj.coef)-1;
s = cell(1,d);
ind = 1;
for a = obj.coef;
if a ~= 0;
if ind ~= 1
if a > 0
s(ind) = {' + '};
ind = ind + 1;
else
s(ind) = {' - '};
a = -a;
ind = ind + 1;
end
end
if a ~= 1 || d == 0
if a == -1
s(ind) = {'-'};
ind = ind + 1;
else
s(ind) = {num2str(a)};
ind = ind + 1;
if d > 0
s(ind) = {'*'};
ind = ind + 1;
end
end
end
if d >= 2
s(ind) = {['x^' int2str(d)]};
ind = ind + 1;
elseif d == 1
s(ind) = {'x'};
ind = ind + 1;
end
end

19-6

Discussion
Convert DocPolynom object
to char that represents the
expression:
y = f(x)
See Convert DocPolynom
Objects to Other Types on page
19-15

Class Design for Polynomials

Example Code

Discussion

d = d - 1;
end
end
str = [s{:}];
end
function disp(obj)
c = char(obj);
if iscell(c)
disp(['
' c{:}])
else
disp(c)
end
end
function dispPoly(obj,x)
p = char(obj);
e = @(x)eval(p);
y = zeros(length(x));
disp(['y = ',p])
for k = 1:length(x)
y(k) = e(x(k));
disp([' ',num2str(y(k)),...
' = f(x = ',...
num2str(x(k)),')'])
end

Overload disp function. Display

objects as output of char
method.
For information about this
code, see Overload disp for
DocPolynom on page 19-17
Return evaluated expression
with formatted output.
Uses output of char method to
evaluate polynomial at specified
values of independent variable.
For information about this
code, see Display Evaluated
Expression on page 19-18

19-7

19

Implementing a Class for Polynomials

Example Code

Discussion

function b = subsref(a,s)
Redefine indexed reference for
switch s(1).type
DocPolynom objects.
case '()'
ind = s.subs{:};
For information about this
b = polyval(a.coef,ind);
code, see Redefine Indexed
case '.'
Reference on page 19-19
switch s(1).subs
case 'coef'
b = a.coef;
case 'disp'
disp(a)
otherwise
if length(s)>1
b = a.(s(1).subs)(s(2).subs{:});
else
b = a.(s.subs);
end
end
otherwise
error('Specify value for x as obj(x)')
end
end

19-8

Class Design for Polynomials

Example Code

Discussion

function r = plus(obj1,obj2)
Define three arithmetic
obj1 = DocPolynom(obj1);
operators:
obj2 = DocPolynom(obj2);
k = length(obj2.coef) - length(obj1.coef);
Polynomial addition
zp = zeros(1,k);
Polynomial subtraction
zm = zeros(1,-k);
r = DocPolynom([zp,obj1.coef] + [zm,obj2.coef]);
Polynomial multiplication
end

For information about this

function r = minus(obj1,obj2)
code, see Define Arithmetic
obj1 = DocPolynom(obj1);
Operators on page 19-21
obj2 = DocPolynom(obj2);
k = length(obj2.coef) - length(obj1.coef);
For general information
zp = zeros(1,k);
about defining operators, see
zm = zeros(1,-k);
Operator Overloading on page
r = DocPolynom([zp,obj1.coef] - [zm,obj2.coef]);
17-48
end
function r = mtimes(obj1,obj2)
obj1 = DocPolynom(obj1);
obj2 = DocPolynom(obj2);
r = DocPolynom(conv(obj1.coef,obj2.coef));
end
end
end
end

end statements for methods

and for classdef.

Expand for Class Code

classdef DocPolynom
% Documentation example
% A value class that implements a data type for polynomials
% See Implementing a Class for Polynomials in the
% MATLAB documentation for more information.
properties
coef
end
% Class methods
methods
function obj = DocPolynom(c)

19-9

19

Implementing a Class for Polynomials

if nargin > 0
if isa(c,'DocPolynom')
obj.coef = c.coef;
else
obj.coef = c(:).';
end
end
end % DocPolynom
function obj = set.coef(obj,val)
if ~isa(val,'double')
error('Coefficients must be doubles')
end
% Remove leading zeros
ind = find(val(:).'~=0);
if ~isempty(ind);
obj.coef = val(ind(1):end);
else
obj.coef = val;
end
end % set.coef
function c = double(obj)
c = obj.coef;
end % double
function str = char(obj)
% Created a formated display of the polynom
% as powers of x
if all(obj.coef == 0)
s = '0';
str = s;
return
else
d = length(obj.coef)-1;
s = cell(1,d);
ind = 1;
for a = obj.coef;
if a ~= 0;
if ind ~= 1
if a > 0
s(ind) = {' + '};
ind = ind + 1;
else
s(ind) = {' - '};

19-10

Class Design for Polynomials

a = -a; %#ok<FXSET>
ind = ind + 1;
end
end
if a ~= 1 || d == 0
if a == -1
s(ind) = {'-'};
ind = ind + 1;
else
s(ind) = {num2str(a)};
ind = ind + 1;
if d > 0
s(ind) = {'*'};
ind = ind + 1;
end
end
end
if d >= 2
s(ind) = {['x^' int2str(d)]};
ind = ind + 1;
elseif d == 1
s(ind) = {'x'};
ind = ind + 1;
end
end
d = d - 1;
end
end
str = [s{:}];
end % char
function disp(obj)
% DISP Display object in MATLAB syntax
c = char(obj);
if iscell(c)
disp(['
' c{:}])
else
disp(c)
end
end % disp
function dispPoly(obj,x)
% evaluate obj at x
p = char(obj);

19-11

19

Implementing a Class for Polynomials

e = @(x)eval(p);
y = zeros(length(x));
disp(['y = ',p])
for k = 1:length(x)
y(k) = e(x(k));
disp([' ',num2str(y(k)),...
' = f(x = ',...
num2str(x(k)),')'])
end
end
function b = subsref(a,s)
% SUBSREF Implementing the following syntax:
% obj([1 ...])
% obj.coef
% obj.disp
% out = obj.method(args)
% out = obj.method
switch s(1).type
case '()'
ind = s.subs{:};
b = polyval(a.coef,ind);
case '.'
switch s(1).subs
case 'coef'
b = a.coef;
case 'disp'
disp(a)
otherwise
if length(s)>1
b = a.(s(1).subs)(s(2).subs{:});
else
b = a.(s.subs);
end
end
otherwise
error('Specify value for x as obj(x)')
end
end % subsref
function r = plus(obj1,obj2)
% PLUS Implement obj1 + obj2 for DocPolynom
obj1 = DocPolynom(obj1);
obj2 = DocPolynom(obj2);

19-12

Class Design for Polynomials

k = length(obj2.coef) - length(obj1.coef);
zp = zeros(1,k);
zm = zeros(1,-k);
r = DocPolynom([zp,obj1.coef] + [zm,obj2.coef]);
end % plus
function r = minus(obj1,obj2)
% MINUS Implement obj1 - obj2 for DocPolynoms.
obj1 = DocPolynom(obj1);
obj2 = DocPolynom(obj2);
k = length(obj2.coef) - length(obj1.coef);
zp = zeros(1,k);
zm = zeros(1,-k);
r = DocPolynom([zp,obj1.coef] - [zm,obj2.coef]);
end % minus
function r = mtimes(obj1,obj2)
% MTIMES
Implement obj1 * obj2 for DocPolynoms.
obj1 = DocPolynom(obj1);
obj2 = DocPolynom(obj2);
r = DocPolynom(conv(obj1.coef,obj2.coef));
end % mtimes
end % methods
end % classdef

The DocPolynom Constructor

The following function is the DocPolynom class constructor, which is in the file
@DocPolynom/DocPolynom.m:
methods
function obj = DocPolynom(c)
if isa(c,'DocPolynom')
obj.coef = c.coef;
else
obj.coef = c(:).';
end
end
end

Constructor Calling Syntax

It is possible to all the DocPolynom constructor with two different arguments:
19-13

19

Implementing a Class for Polynomials

Input argument is a DocPolynom object If you call the constructor function with
an input argument that is already a DocPolynom object, the constructor returns a
new DocPolynom object with the same coefficients as the input argument. The isa
function checks for this input.
Input argument is a coefficient vector If the input argument is not a DocPolynom
object, the constructor attempts to reshape the values into a vector and assign them to
the coef property.
The coef property set method restricts property values to doubles. See Remove
Irrelevant Coefficients on page 19-14 for a description of the property set method.
An example use of the DocPolynom constructor is the statement:
p = DocPolynom([1 0 -2 -5])
p =
x^3 - 2*x -5

This statement creates an instance of the DocPolynom class with the specified
coefficients. Note the display of the object shows the equivalent polynomial using
MATLAB language syntax. The DocPolynom class implements this display using the
disp and char class methods.

Remove Irrelevant Coefficients

MATLAB software represents polynomials as row vectors containing coefficients ordered
by descending powers. Zeros in the coefficient vector represent terms that drop out of the
polynomial. Leading zeros, therefore, can be ignored when forming the polynomial.
Some DocPolynom class methods use the length of the coefficient vector to determine
the degree of the polynomial. It is useful, therefore, to remove leading zeros from the
coefficient vector so that its length represents the true value.
The DocPolynom class stores the coefficient vector in a property that uses a set method
to remove leading zeros from the specified coefficients before setting the property value.
methods
function obj = set.coef(obj,val)
if ~isa(val,'double')
error('Coefficients must be doubles')
end
ind = find(val(:).'~=0);

19-14

Class Design for Polynomials

if ~isempty(ind);
obj.coef = val(ind(1):end);
else
obj.coef = val;
end
end
end

Convert DocPolynom Objects to Other Types

The DocPolynom class defines two methods to convert DocPolynom objects to other
classes:
double Converts to the double numeric type so functions can perform
mathematical operations on the coefficients.
char Converts to characters used to format output for display in the command
window
The Double Converter
The double converter method for the DocPolynom class simply returns the coefficient
vector:
methods
function c = double(obj)
c = obj.coef;
end
end

For the DocPolynom object p:

p = DocPolynom([1 0 -2 -5]);

the statement:
c = double(p)

returns:
c=
1

-2

-5

which is of class double:

19-15

19

Implementing a Class for Polynomials

class(c)
ans =
double

The Character Converter

The char method produces a char vector that represents the polynomial displayed as
powers of x. The char vector returned is a syntactically correct MATLAB expression.
The char method uses a cell array to collect the char vector components that make up
the displayed polynomial.
The disp method uses the char method to format the DocPolynom object for display.
The evalPoly method uses char to create the MATLAB expression to evaluate.
Users of DocPolynom objects are not likely to call the char or disp methods directly,
but these methods enable the DocPolynom class to behave like other data classes in
MATLAB.
Here is the char method.
methods
function str = char(obj)
if all(obj.coef == 0)
s = '0';
str = s;
return
else
d = length(obj.coef)-1;
s = cell(1,d);
ind = 1;
for a = obj.coef;
if a ~= 0;
if ind ~= 1
if a > 0
s(ind) = {' + '};
ind = ind + 1;
else
s(ind) = {' - '};
a = -a;
ind = ind + 1;
end
end
if a ~= 1 || d == 0
if a == -1
s(ind) = {'-'};
ind = ind + 1;
else
s(ind) = {num2str(a)};
ind = ind + 1;

19-16

Class Design for Polynomials

if d > 0
s(ind) = {'*'};
ind = ind + 1;
end
end
end
if d >= 2
s(ind) = {['x^' int2str(d)]};
ind = ind + 1;
elseif d == 1
s(ind) = {'x'};
ind = ind + 1;
end
end
d = d - 1;
end
end
str = [s{:}];
end
end

Overload disp for DocPolynom

To provide a more useful display of DocPolynom objects, this class overloads disp in the
class definition.
This disp method relies on the char method to produce a text representation of the
polynomial, which it then displays on the screen.
The char method returns a cell array or the character '0' if the coefficients are all zero.
methods
function disp(obj)
c = char(obj);
if iscell(c)
disp(['
' c{:}])
else
disp(c)
end
end
end

When MATLAB Calls the disp Method

The statement:
p = DocPolynom([1 0 -2 -5])

19-17

19

Implementing a Class for Polynomials

creates a DocPolynom object. Because the statement is not terminated with a semicolon,
the resulting output is displayed on the command line:
p =
x^3 - 2*x - 5

Display Evaluated Expression

The char converter method forms a MATLAB expression for the polynomial represented
by a DocPolynom object. The dispPoly method evaluates the expression returned by
the char method with a specified value for x.
methods
function dispPoly(obj,x)
p = char(obj);
e = @(x)eval(p);
y = zeros(length(x));
disp(['y = ',p])
for k = 1:length(x)
y(k) = e(x(k));
disp([' ',num2str(y(k)),...
' = f(x = ',...
num2str(x(k)),')'])
end
end
end

Create a DocPolynom object p:

p = DocPolynom([1 0 -2 -5])
p =
x^3 - 2*x - 5

Evaluate the polynomial at x equal to three values, [3 5 9]:

dispPoly(p,[3 5 9])
y = x^3 - 2*x - 5
16 = f(x = 3)
110 = f(x = 5)
706 = f(x = 9)

19-18

Class Design for Polynomials

Redefine Indexed Reference

The DocPolynom class redefines indexed reference to better serve the use of objects
representing polynomials. In the DocPolynom class, a subscripted reference to an object
causes an evaluation of the polynomial with the value of the independent variable equal
to the subscript.
For example, given the following polynomial:

Create a DocPolynom object p:

p = DocPolynom([1 0 -2 -5])
p =
x^3 - 2*x - 5

The following subscripted expression evaluates the value of the polynomial at x = 3 and
at x = 4, and returns the resulting values:
p([3 4])
ans =
16

51

Indexed Reference Design Objectives

Redefine the default subscripted reference behavior by implementing a subsref method.
If a class defines a subsref method, MATLAB calls this method for objects of this class
whenever a subscripted reference occurs. The subsref method must define all the
indexed reference behaviors, not just a specific case that you want to change.
The DocPolynom subsref method implements the following behaviors:
p(x = [a1...an]) Evaluate polynomial at x = a.
p.coef Access coef property value
p.disp Display the polynomial as a MATLAB expression without assigning an
output.
obj = p.method(args) Use dot notation to call methods arguments and return
a modified object.
19-19

19

Implementing a Class for Polynomials

obj = p.method Use dot notation to call methods without arguments and return
a modified object.
subsref Implementation Details
The subsref method overloads the subsref function.
For example, consider a call to the polyval function:
p = DocPolynom([1 0 -2 -5])
p =
x^3 - 2*x - 5
polyval(p.coef,[3 5 7])
ans =
16
110
324

The polyval function requires the:

Polynomial coefficients
Values of the independent variable at which to evaluate the polynomial
The polyval function returns the value of f(x) at these values. subsref calls polyval
through the statements:
case '()'
ind = s.subs{:};
b = polyval(a.coef,ind);

When implementing subsref to support method calling with arguments using dot
notation, both the type and subs structure fields contain multiple elements.
The subsref method implements all subscripted reference explicitly, as show in the
following code listing.
methods
function b = subsref(a,s)
switch s(1).type
case '()'
ind = s.subs{:};
b = polyval(a.coef,ind);
case '.'
switch s(1).subs
case 'coef'
b = a.coef;

19-20

Class Design for Polynomials

case 'disp'
disp(a)
otherwise
if length(s)>1
b = a.(s(1).subs)(s(2).subs{:});
else
b = a.(s.subs);
end
end
otherwise
error('Specify value for x as obj(x)')
end
end
end

Define Arithmetic Operators

Several arithmetic operations are meaningful on polynomials. The DocPolynom class
implements these methods:
Method and Syntax

Operator Implemented

plus(a,b)

Addition

minus(a,b)

Subtraction

mtimes(a,b)

Matrix multiplication

When overloading arithmetic operators, consider the data types you must support.
The plus, minus, andmtimes methods are defined for the DocPolynom class to
handle addition, subtraction, and multiplication on DocPolynom DocPolynom and
DocPolynom double combinations of operands.
Define + Operator
If either p or q is a DocPolynom object, this expression:
p + q

Generates a call to a function @DocPolynom/plus, unless the other object is of higher

precedence.
The following method overloads the plus (+) operator for the DocPolynom class:
methods

19-21

19

Implementing a Class for Polynomials

function r = plus(obj1,obj2)
obj1 = DocPolynom(obj1);
obj2 = DocPolynom(obj2);
k = length(obj2.coef) - length(obj1.coef);
zp = zeros(1,k);
zm = zeros(1,-k);
r = DocPolynom([zp,obj1.coef] + [zm,obj2.coef]);
end
end

Here is how the function works:

Ensure that both input arguments are DocPolynom objects so that expressions such
as
p + 1

that involve both a DocPolynom and a double, work correctly.

Access the two coefficient vectors and, if necessary, pad one of them with zeros to
make both the same length. The actual addition is simply the vector sum of the two
coefficient vectors.
Call the DocPolynom constructor to create a properly typed object that is the result of
adding the polynomials.
Define - Operator
Implement the minus operator (-) using the same approach as the plus (+) operator.
The minus method computes p - q. The dominant argument must be a DocPolynom
object.
methods
function r = minus(obj1,obj2)
obj1 = DocPolynom(obj1);
obj2 = DocPolynom(obj2);
k = length(obj2.coef) - length(obj1.coef);
zp = zeros(1,k);
zm = zeros(1,-k);
r = DocPolynom([zp,obj1.coef] - [zm,obj2.coef]);
end
end

Define the * Operator

Implement the mtimes method to compute the product p*q. The mtimes method
implements matrix multiplication since the multiplication of two polynomials is the
convolution (conv) of their coefficient vectors:
19-22

Class Design for Polynomials

methods
function r = mtimes(obj1,obj2)
obj1 = DocPolynom(obj1);
obj2 = DocPolynom(obj2);
r = DocPolynom(conv(obj1.coef,obj2.coef));
end
end

Using the Arithmetic Operators

Given the DocPolynom object:
p = DocPolynom([1 0 -2 -5]);

The following two arithmetic operations call the DocPolynom plus and mtimes
methods:
q = p+1;
r = p*q;

to produce
q =
x^3 - 2*x - 4
r =
x^6 - 4*x^4 - 9*x^3 + 4*x^2 + 18*x + 20

19-23

20
Designing Related Classes
A Simple Class Hierarchy on page 20-2
Containing Assets in a Portfolio on page 20-20

20

Designing Related Classes

A Simple Class Hierarchy

In this section...
Shared and Specialized Properties on page 20-2
Designing a Class for Financial Assets on page 20-3
DocAsset Class Definition on page 20-4
Summary of the DocAsset Class on page 20-4
The DocAsset Constructor Method on page 20-5
The DocAsset Display Method on page 20-6
Designing a Class for Stock Assets on page 20-7
DocStock Class Definition on page 20-7
Summary of the DocStock Class on page 20-7
Designing a Class for Bond Assets on page 20-10
DocBond Class Definition on page 20-10
Summary of the DocBond Class on page 20-10
Designing a Class for Savings Assets on page 20-14
DocSavings Class Definition on page 20-14
Summary of the DocSavings Class on page 20-14
DocAsset Class Code Listing on page 20-17
DocStock Class Code Listing on page 20-17
DocBond Class Code Listing on page 20-18
DocSavings Class Code Listing on page 20-19

Shared and Specialized Properties

As an example of how subclasses are specializations of more general classes, consider
an asset class that can be used to represent any item that has monetary value. Some
examples of assets are stocks, bonds, and savings accounts. This example implements
four classes DocAsset, and the subclasses DocStock, DocBond, DocSavings.
The DocAsset class holds the data that is common to all of the specialized asset
subclasses in class properties. The subclasses inherit the super class properties in
addition to defining their own properties. The subclasses are all kinds of assets.
20-2

A Simple Class Hierarchy

The following diagram shows the properties defined for the classes of assets.
DocAsset
Properties
Description
Date
Type
CurrentValue

DocStocks
(is a DocAsset)

DocBonds
(is a DocAsset)

DocSavings
(is a DocAsset)

Inherited Props
Description
Date
Type
CurrentValue

Inherited Props
Description
Date
Type
CurrentValue

Inherited Props
Description
Date
Type
CurrentValue

DocStocks Props
NumShares
SharePrice

DocBonds Props
FaceValue
Yield
CurrentBondYield

DocSavings Props
InterestRate

The DocStock, DocBond, and DocSavings classes inherit properties from the DocAsset
class. In this example, the DocAsset class provides storage for data common to all
subclasses and shares methods with these subclasses.

Designing a Class for Financial Assets

This class provides storage and access for information common to all asset children.
It is not intended to be instantiated directly, so it does not require an extensive set of
methods. The class contains the following methods:
Constructor
20-3

20

Designing Related Classes

A local setter function for one property

DocAsset Class Definition

For a full code listing for the DocAsset class, see DocAsset Class Code Listing on page
20-17
To use the class, create a folder named @DocAsset and save the class code as
DocAsset.m in this folder. The parent folder of @DocAsset must be on the MATLAB
path.

Summary of the DocAsset Class

The class is defined in one file, DocAsset.m, which you must place in an @ folder of the
same name. The parent folder of the @DocAsset folder must be on the MATLAB path.
See the addpath function for more information.
The following table summarizes the properties defined for the DocAsset class.
DocAsset Class Properties
Name

Class

Default

Description

Description

char

''

Description of asset

CurrentValue

double

Current value of asset

Date

char

date

Date when record is created (set

by date function)

Type

char

'savings'

Type of asset (stock, bond,

savings)

The following table summarizes the methods for the DocAsset class.
DocAsset Class Methods

20-4

Name

Description

DocAsset

Class constructor

disp

Displays information about this object

set.Type

Set function for Type. Property tests for correct value when
property is set.

A Simple Class Hierarchy

The DocAsset Constructor Method

This class has four properties that store data common to all of the asset subclasses. All
except Date are passed to the constructor by a subclass constructor. Date is a private
property and is set by a call to the date function.
Description A char vector that describes the particular asset (e.g., stock name,
savings bank name, bond issuer, and so on).
Date The date the object was created. This property's set access is private so that
only the constructor assigns the value using the date command when creating the
object.
Type The type of asset (e.g., savings, bond, stock). A local set function provides
error checking whenever an object is created.
CurrentValue The current value of the asset.
Property Definition Block
The following code block shows how the properties are defined. Note the set function
defined for the Type property. It restricts the property's values to one of three strings:
bond, stock, or savings.
properties
Description = '';
CurrentValue = 0;
end
properties(SetAccess = private)
Date % Set value in constructor
Type = 'savings'; % Provide a default value
end

Constructor Method Code

The DocAsset class is not derived from another class, so you do not need to call a
superclass constructor. MATLAB constructs an object when you assign values to the
specified output argument (a in the following code):
function a = DocAsset(description,type,current_value)
% DocAsset constructor
if nargin > 0
a.Description = description;
a.Date = date;
a.Type = type;

20-5

20

Designing Related Classes

a.CurrentValue = current_value;
end
end % DocAsset

Set Function for Type Property

In this class design, there are only three types of assetsbonds, stocks, and savings.
Therefore, the possible values for the Type property are restricted to one of three possible
stings by defining a set function as follows:
function obj = set.Type(obj,type)
if ~(strcmpi(type,'bond') || strcmpi(type,'stock') || strcmpi(type,'savings'))
error('Type must be either bond, stock, or savings')
end
obj.Type = type;
end %Type set function

The MATLAB runtime calls this function whenever an attempt is made to set the Type
property, even from within the class constructor function or by assigning an initial value.
Therefore, the following statement in the class definition would produce an error:
properties
Type = 'cash';
end

The only exception is the set.Type function itself, where the statement:
obj.Type = type;

does not result in a recursive call to set.Type.

The DocAsset Display Method

The asset disp method is designed to be called from child-class disp methods. Its
purpose is to display the data it stores for the child object. The method simply formats
the data for display in a way that is consistent with the formatting of the child's disp
method:
function disp(a)
% Display a DocAsset object
fprintf('Description: %s\nDate: %s\nType: %s\nCurrentValue:%9.2f\n',...
a.Description,a.Date,a.Type,a.CurrentValue);
end % disp

The DocAsset subclass display methods can now call this method to display the data
stored in the parent class. This approach isolates the subclass disp methods from
changes to the DocAsset class.
20-6

A Simple Class Hierarchy

Designing a Class for Stock Assets

Stocks are one type of asset. A class designed to store and manipulate information about
stock holdings needs to contain the following information about the stock:
The number of shares
The price per share
In addition, the base class (DocAsset) maintains general information including a
description of the particular asset, the date the record was created, the type of asset, and
its current value.

DocStock Class Definition

For a full code listing for the DocStock class, see DocStock Class Code Listing on page
20-17
To use the class, create a folder named @DocStock and save the class code as
DocStock.m in this folder. The parent folder of @DocStock must be on the MATLAB
path.

Summary of the DocStock Class

This class is defined in one file, DocStock.m, which you must place in an @ folder of the
same name. The parent folder of the @DocStock folder must be on the MATLAB path.
See the addpath function for more information.
DocStock is a subclass of the DocAsset class.
The following table summarizes the properties defined for the DocStock class.
DocStock Class Properties
Name

Class

Default

Description

NumShares

double

Number of shares of a particular

stock

SharePrice

double

Current value of asset

Properties Inherited from the DocAsset Class

Description

char

''

Description of asset
20-7

20

Designing Related Classes

Name

Class

Default

Description

CurrentValue

double

Current value of asset

Date

char

date

Date when record is created (set by

date function)

Type

char

''

Type of asset (stock, bond, savings)

The following table summarizes the methods for the DocStock class.
DocStock Class Methods
Name

Description

DocStock

Class constructor

disp

Displays information about the object

Specifying the Base Class

The < symbol specifies the DocAsset class as the base class for the DocStock class in
the classdef line:
classdef DocStock < DocAsset

Property Definition Block

The following code shows how the properties are defined:
properties
NumShares = 0;
SharePrice = 0;
end

Using the DocStock Class

Suppose you want to create a record of a stock asset for 200 shares of a company called
Xdotcom with a share price of $23.47.
Call the DocStock constructor function with the following arguments:
Stock name or description
Number of shares
Share price
20-8

A Simple Class Hierarchy

For example, the following statement:

XdotcomStock = DocStock('Xdotcom',200,23.47);

creates a DocStock object, XdotcomStock, that contains information about a stock asset
in Xdotcom Corp. The asset consists of 200 shares that have a per share value of $23.47.
The DocStock Constructor Method
The constructor first creates an instance of a DocAsset object since the DocStock class
is derived from the DocAsset class (see The DocAsset Constructor Method on page
20-5). The constructor returns the DocStock object after setting value for its two
properties:
function s = DocStock(description,num_shares,share_price)
if nargin ~= 3 % Support no argument constructor syntax
description = '';
num_shares = 0;
share_price = 0;
end
s = s@DocAsset(description,'stock',share_price*num_shares);
s.NumShares = num_shares;
s.SharePrice = share_price;
end % DocStock

The DocStock disp Method

When you issue the statement (without terminating with a semicolon):
XdotcomStock = DocStock('Xdotcom',100,25)

the MATLAB runtime looks for a method in the @DocStock folder called disp. The disp
method for the DocStock class produces this output:
Description: Xdotcom
Date: 17-Nov-1998
Type: stock
Current Value: $2500.00
Number of shares: 100
Share price: $25.00

The following function is the DocStock disp method. When this function returns from
the call to the DocAsset disp method, it uses fprintf to display the Numshares and
SharePrice property values on the screen:
20-9

20

Designing Related Classes

function disp(s)
disp@DocAsset(s)
fprintf('Number of shares: %g\nShare price: %3.2f\n',...
s.NumShares,s.SharePrice);
end % disp

Designing a Class for Bond Assets

The DocBond class is similar to the DocStock class in that it is derived from the
DocAsset class to represent a specific type of asset.

DocBond Class Definition

For a full code listing for the DocBond class, see DocBond Class Code Listing on page
20-18
To use the class, create a folder named @DocBond and save the class code as DocBond.m
in this folder. The parent folder of @DocBond must be on the MATLAB path.

Summary of the DocBond Class

This class is defined in one file, DocBond.m, which you must place in an @ folder of the
same name. The parent folder of the @DocBond folder must on the MATLAB path.
DocStock is a subclass of the DocAsset class.
The following table summarize the properties defined for the DocBond class
DocBond Class Properties
Name

Class

Default

Description

FaceValue

double

Face value of the bond

SharePrice

double

Current value of asset

Properties Inherited from the DocAsset Class

20-10

Description

char

''

Description of asset

CurrentValue

double

Current value of asset

Date

char

date

Date when record is created (set by

date function)

A Simple Class Hierarchy

Name

Class

Default

Description

Type

char

''

Type of asset (stock, bond, savings)

The following table summarizes the methods for the DocStock class.
DocBond Class Methods
Name

Description

DocBond

Class constructor

disp

Displays information about this object and calls the

DocAsset disp method

calc_value

Utility function to calculate the bond's current value

Specifying the Base Class

The < symbol specifies the DocAsset class as the base class for the DocBond class in the
classdef line:
classdef DocBond < DocAsset

Property Definition Block

The following code block shows how the properties are defined:
properties
FaceValue = 0;
Yield = 0;
CurrentBondYield = 0;
end

Using the DocBond Class

Suppose you want to create a record of an asset that consists of an xyzbond with a face
value of $100 and a current yield of 4.3%. The current yield for the equivalent bonds
today is 6.2%, which means that the market value of this particular bond is less than its
face value.
Call the DocBond constructor function with the following arguments:
Bond name or description
20-11

20

Designing Related Classes

Bond's face value

Bond's interest rate or yield
Current interest rate being paid by equivalent bonds (used to calculate the current
value of the asset)
For example, this statement:
b = DocBond('xyzbond',100,4.3,6.2);

creates a DocBond object, b, that contains information about a bond asset xyzbond with
a face value of $100, a yield of 4.3%, and also contains information about the current
yield of such bonds (6.2% in this case) that is used to calculate the current value.
Note The calculations performed in this example are intended only to illustrate the use
of MATLAB classes and do not represent a way to determine the actual value of any
monetary investment.
The DocBond Constructor Method
The DocBond constructor method requires four arguments. It also supports the no
argument syntax by defining default values for the missing input arguments:
function b = DocBond(description,face_value,yield,current_yield)
if nargin ~= 4
description = '';
face_value = 0;
yield = 0;
current_yield = 0;
end
market_value = DocBond.calc_value(face_value,yield,current_yield);
b = b@DocAsset(description,'bond',market_value);
b.FaceValue = face_value;
b.Yield = yield;
b.CurrentBondYield = current_yield;
end % DocBond

The calc_value Method

The DocBond class determines the market value of bond assets using a simple formula
that scales the face value by the ratio of the bond's interest yield to the current yield for
equivalent bonds.
20-12

A Simple Class Hierarchy

Calculation of the asset's market value requires that the yields be nonzero, and should be
positive just to make sense. While the calc_value method issues no errors for bad yield
values, it does ensure bad values are not used in the calculation of market value.
The asset's market value is passed to the DocAsset base-class constructor when it is
called within the DocBond constructor. calc_value has its Static attribute set to
true because it does not accept a DocBond object as an input argument. The output of
calc_value is used by the base-class (DocAsset) constructor:
methods (Static)
function market_value = calc_value(face_value,yield,current_yield)
if current_yield <= 0 || yield <= 0
market_value = face_value;
else
market_value = face_value*yield/current_yield;
end
end % calc_value
end % methods

The DocBond disp Method

When you issue this statement (without terminating it with a semicolon):
b = DocBond('xyzbond',100,4.3,6.2)

the MATLAB runtime looks for a method in the @DocBond folder called disp. The disp
method for the DocBond class produces this output:
Description: xyzbond
Date: 17-Nov-1998
Type: bond
Current Value: $69.35
Face value of bonds: $100
Yield: 4.30%

The following function is the DocBond disp method. When this function returns from
the call to the DocAsset disp method, it uses fprintf to display the FaceValue,
Yield, and CurrentValue property values on the screen:
function disp(b)
disp@DocAsset(b) % Call DocAsset disp method
fprintf('Face value of bonds: $%g\nYield: %3.2f%%\n',...
b.FaceValue,b.Yield);
end % disp

20-13

20

Designing Related Classes

Designing a Class for Savings Assets

The DocSavings class is similar to the DocStock and DocBond class in that it is
derived from the DocAsset class to represent a specific type of asset.

DocSavings Class Definition

For a full code listing for the DocSavings class, see DocSavings Class Code Listing on
page 20-19
To use the class, create a folder named @DocSavings and save the class code as
DocSavings.m in this folder. The parent folder of @DocSavings must be on the
MATLAB path.

Summary of the DocSavings Class

This class is defined in one file, DocSavings.m, which you must place in an @ folder
of the same name. The parent folder of the @DocSavings folder must on the MATLAB
path. See the addpath function for more information.
The following table summarizes the properties defined for the DocSavings class.
DocSavings Class Properties
Name

Class

Default

Description

InterestRate

double

''

Current interest rate

paid on the savings
account

Properties Inherited from the DocAsset Class

20-14

Description

char

''

Description of asset

CurrentValue

double

Current value of
asset

Date

char

date

Date when record is

created (set by date
function)

Type

char

''

The type of asset

(stock, bond, savings)

A Simple Class Hierarchy

The following table summarizes the methods for the DocSavings class.
DocSavings Class Methods
Name

Description

DocSavings

Class constructor

disp

Displays information about this object and calls the

DocAsset disp method

Specifying the Base Class

The < symbol specifies the DocAsset class as the base class for the DocBond class in the
classdef line:
classdef DocSavings < DocAsset

Property Definition Block

The following code shows how the property is defined:
properties
InterestRate = 0;
end

Using the DocSavings Class

Suppose you want to create a record of an asset that consists of a savings account with a
current balance of $1000 and an interest rate of 2.9%.
Call the DocSavings constructor function with the following arguments:
Bank account description
Account balance
Interest rate paid on savings account
For example, this statement:
sv = DocSavings('MyBank',1000,2.9);

creates a DocSavings object, sv, that contains information about an account in MyBank
with a balance of $1000 and an interest rate of 2.9%.
20-15

20

Designing Related Classes

The DocSavings Constructor Method

The savings account interest rate is saved in the DocSavings class InterestRate
property. The asset description and the current value (account balance) are saved in the
inherited DocAsset object properties.
The constructor calls the base class constructor (DocAsset.m) to create an instance
of the object. It then assigns a value to the InterestRate property. The constructor
supports the no argument syntax by providing default values for the missing arguments.
function s = DocSavings(description,balance,interest_rate)
if nargin ~= 3
description = '';
balance = 0;
interest_rate = 0;
end
s = s@DocAsset(description,'savings',balance);
s.InterestRate = interest_rate;
end % DocSavings

The DocSavings disp Method

When you issue this statement (without terminating it with a semicolon):
sv = DocSavings('MyBank',1000,2.9)

the MATLAB runtime looks for a method in the @DocSavings folder called disp. The
disp method for the DocSavings class produces this output:
Description: MyBank
Date: 17-Nov-1998
Type: savings
Current Value: $1000.00
Interest Rate: 2.90%

The following function is the DocSaving disp method. When this function returns from
the call to the DocAsset disp method, it uses fprintf to display the Numshares and
SharePrice property values on the screen:
function disp(b)
disp@DocAsset(b) % Call DocAsset disp method
fprintf('%s%3.2f%%\n','Interest Rate: ',s.InterestRate);
end % disp

20-16

A Simple Class Hierarchy

DocAsset Class Code Listing

classdef DocAsset
% file: @DocAsset/DocAsset.m
properties
Description = '';
CurrentValue = 0;
end
properties (SetAccess = private)
Date
Type = 'savings';
end
% Class methods
methods
function a = DocAsset(description,type,current_value)
% DocAsset Constructor function
if nargin > 0
a.Description = description;
a.Date = date;
a.Type = type;
a.CurrentValue = current_value;
end
end % DocAsset
function disp(a)
% Display a DocAsset object
fprintf('Description: %s\nDate: %s\nType: %s\nCurrent Value: $%4.2f\n',...
a.Description,a.Date,a.Type,a.CurrentValue);
end % disp
function obj = set.Type(obj,type)
if ~(strcmpi(type,'bond') || strcmpi(type,'stock') || strcmpi(type,'savings'))
error('Type must be either bond, stock, or savings')
end
obj.Type = type;
end % Set.Type
end
end % classdef

DocStock Class Code Listing

classdef DocStock < DocAsset
properties
NumShares = 0;
SharePrice = 0;
end
methods
function s = DocStock(description, num_shares, share_price)
if nargin ~= 3

20-17

20

Designing Related Classes

description = '';
num_shares = 0;
share_price = 0;
end
s = s@DocAsset(description, 'stock', share_price*num_shares);
s.NumShares = num_shares;
s.SharePrice = share_price;
end
function disp(s)
disp@DocAsset(s)
fprintf('Number of shares: %g\nShare price: $%2.2f\n',...
s.NumShares,s.SharePrice);
end
end
end

DocBond Class Code Listing

classdef DocBond < DocAsset
properties
FaceValue = 0;
Yield = 0;
CurrentBondYield = 0;
end
methods
function b = DocBond(description,face_value,yield,current_yield)
if nargin ~= 4
description = '';
face_value = 0;
yield = 0;
current_yield = 0;
end
market_value = DocBond.calc_value(face_value,yield,current_yield);
b = b@DocAsset(description,'bond',market_value);
b.FaceValue = face_value;
b.Yield = yield;
b.CurrentBondYield = current_yield;
end
function disp(b)
disp@DocAsset(b)
fprintf('Face value of bonds: $%g\nYield: %3.2f%%\n',...
b.FaceValue,b.Yield);
end
end
methods (Static = true)
function market_value = calc_value(face_value,yield,current_yield)
if current_yield <= 0 || yield <= 0
market_value = face_value;

20-18

A Simple Class Hierarchy

else
market_value = face_value*yield/current_yield;
end
end
end
end

DocSavings Class Code Listing

classdef DocSavings < DocAsset
properties
InterestRate = 0;
end
methods
function s = DocSavings(description,balance,interest_rate)
if nargin ~= 3
description = '';
balance = 0;
interest_rate = 0;
end
s = s@DocAsset(description,'savings',balance);
s.InterestRate = interest_rate;
end
function disp(s)
disp@DocAsset(s)
fprintf('%s%3.2f%%\n','Interest Rate: ',s.InterestRate);
end
end
end

20-19

20

Designing Related Classes

Containing Assets in a Portfolio

In this section...
Kinds of Containment on page 20-20
Designing the DocPortfolio Class on page 20-20
Displaying the Class Files on page 20-21
Summary of the DocPortfolio Class on page 20-21
The DocPortfolio Constructor Method on page 20-23
The DocPortfolio disp Method on page 20-24
The DocPortfolio pie3 Method on page 20-24
Visualizing a Portfolio on page 20-25
DocPortfolio Class Code Listing on page 20-26

Kinds of Containment
Aggregation is the containment of objects by other objects. The basic relationship is that
each contained object "is a part of" the container object. Composition is a more strict form
of aggregation in which the contained objects are parts of the containing object and are
not associated with any other objects. Portfolio objects form a composition with asset
objects because the asset objects are value classes, which are copied when the constructor
method creates the DocPortfolio object.
For example, consider a financial portfolio class as a container for a set of assets (stocks,
bonds, savings, and so on). It can group, analyze, and return useful information about
the individual assets. The contained objects are not accessible directly, but only via the
portfolio class methods.
A Simple Class Hierarchy on page 20-2 provides information about the assets collected
by this portfolio class.

Designing the DocPortfolio Class

The DocPortfolio class is designed to contain the various assets owned by an
individual client and to provide information about the status of his or her investment
portfolio. This example implements a somewhat over-simplified portfolio class that:
Contains an individual's assets
20-20

Containing Assets in a Portfolio

Displays information about the portfolio contents

Displays a 3-D pie chart showing the relative mix of asset types in the portfolio

Displaying the Class Files

For a full code listing for the DocAsset class, see DocPortfolio Class Code Listing on
page 20-26
To use the class, create a folder named @DocPortfolio and save the class code as
DocPortfolio.m in this folder. The parent folder of @DocPortfolio must be on the
MATLAB path.

Summary of the DocPortfolio Class

This class is defined in one file, DocPortfolio.m, which you must place in an @ folder
of the same name. The parent folder of the @DocPortfolio folder must on the MATLAB
path. See the addpath function for more information.
The following table summarizes the properties defined for the DocPortfolio class.
DocPortfolio Class Properties
Name

Class

Default

Description

Name

char

''

Name of client owning the portfolio

IndAssets

cell

{}

A cell array containing individual

asset objects

TotalValue

double

Value of all assets (calculated in the

constructor method)

The following table summarizes the methods for the DocPortfolio class.
DocBond Class Methods
Name

Description

DocPortfolio

Class constructor

disp

Displays information about this object and calls the

DocAsset disp method

pie3

Overloaded version of pie3 function designed to take a

single portfolio object as an argument
20-21

20

Designing Related Classes

Property Definition Block

The following code block shows how the properties are defined:
properties
Name = '';
end
properties (SetAccess = private)
IndAssets = {};
TotalValue = 0;
end

How Class Properties Are Used

Name Stores the name of the client as a char vector. The client's name is passed to
the constructor as an input argument.
IndAsset A cell array that stores asset objects (i.e., DocStock, DocBond,
and DocSavings objects). These asset objects are passed to the DocPortfolio
constructor as input arguments and assigned to the property from within the
constructor function.
IndAsset The structure of this property is known only to DocPortfolio class
member functions so the property's SetAccess attribute is set to private.
TotalValue Stores the total value of the client's assets. The class constructor
determines the value of each asset by querying the asset's CurrentValue property
and summing the result. Access to the TotalValue property is restricted to
DocPortfolio class member functions by setting the property's SetAccess
attribute to private.
Using the DocPortfolio Class
The DocPortfolio class is designed to provide information about the financial assets
owned by a client. There are three possible types of assets that a client can own: stocks,
bonds, and savings accounts.
The first step is to create an asset object to represent each type of asset owned by the
client:
XYZStock = DocStock('XYZ Stocks',200,12.34);
USTBonds = DocBond('U.S. Treasury Bonds',1600,3.2,2.8);
SaveAccount = DocSavings('MyBank Acc # 123',2000,6);
VictoriaSelna = DocPortfolio('Victoria Selna',...

20-22

Containing Assets in a Portfolio

XYZStock,...
SaveAccount,...
USTBonds)

The DocPortfolio object displays the following information:

VictoriaSelna =
Assets for Client: Victoria Selna
Description: XYZ Stocks
Date: 11-Mar-2008
Type: stock
Current Value: $2468.00
Number of shares: 200
Share price: $12.34
Description: MyBank Acc # 123
Date: 11-Mar-2008
Type: savings
Current Value: $2000.00
Interest Rate: 6.00%
Description: U.S. Treasury Bonds
Date: 11-Mar-2008
Type: bond
Current Value: $1828.57
Face value of bonds: $1600
Yield: 3.20%
Total Value: $6296.57

The DocPortfolio pie3 Method on page 20-24 provides a graphical display of the
portfolio.

The DocPortfolio Constructor Method

The DocPortfolio constructor method takes as input arguments a client's name and
a variable length list of asset objects (DocStock, DocBond, and DocSavings objects in
this example).
The IndAssets property is a cell array used to store all asset objects. From these
objects, the constructor determines the total value of the client's assets. This value is
stored in the TotalValue property:
function p = DocPortfolio(name,varargin)

20-23

20

Designing Related Classes

if nargin > 0
p.Name = name;
for k = 1:length(varargin)
p.IndAssets{k} = varargin(k);
asset_value = p.IndAssets{k}{1}.CurrentValue;
p.TotalValue = p.TotalValue + asset_value;
end
end
end % DocPortfolio

The DocPortfolio disp Method

The portfolio disp method lists the contents of each contained object by calling the
object's disp method. It then lists the client name and total asset value:
function disp(p)
fprintf('\nAssets for Client: %s\n',p.Name);
for k = 1:length(p.IndAssets)
disp(p.IndAssets{k}{1}) % Dispatch to corresponding disp
end
fprintf('\nTotal Value: $%0.2f\n',p.TotalValue);
end % disp

The DocPortfolio pie3 Method

The DocPortfolio class overloads the MATLAB pie3 function to accept a portfolio
object and display a 3-D pie chart illustrating the relative asset mix of the client's
portfolio. MATLAB calls the @DocPortfolio/pie3.m version of pie3 whenever the
input argument is a single portfolio object:
function pie3(p)
% Step 1: Get the current value of each asset
stock_amt = 0; bond_amt = 0; savings_amt = 0;
for k = 1:length(p.IndAssets)
if isa(p.IndAssets{k},'DocStock')
stock_amt = stock_amt + p.IndAssets{k}.CurrentValue;
elseif isa(p.IndAssets{k},'DocBond')
bond_amt = bond_amt + p.IndAssets{k}.CurrentValue;
elseif isa(p.IndAssets{k},'DocSavings')
savings_amt = savings_amt + p.IndAssets{k}.CurrentValue;
end % if
end % for
% Step 2: Create labels and data for the pie graph
k = 1;
if stock_amt ~= 0

20-24

Containing Assets in a Portfolio

label(k) = {'Stocks'};
pie_vector(k) = stock_amt;
k = k + 1;
end % if
if bond_amt ~= 0
label(k) = {'Bonds'};
pie_vector(k) = bond_amt;
k = k + 1;
end % if
if savings_amt ~= 0
label(k) = {'Savings'};
pie_vector(k) = savings_amt;
end % if
% Step 3: Call pie3, adjust fonts and colors
pie3(pie_vector,label);set(gcf,'Renderer','zbuffer')
set(findobj(gca,'Type','Text'),...
'FontSize',14,'FontWeight','bold')
colormap prism
stg(1) = {['Portfolio Composition for ',p.Name]};
stg(2) = {['Total Value of Assets: $',num2str(p.TotalValue,'%0.2f')]};
title(stg,'FontSize',10)
end % pie3

There are three parts in the overloaded pie3 method.

Step 1 Get the CurrentValue property of each contained asset object and
determine the total value in each category.
Step 2 Create the pie chart labels and build a vector of graph data, depending on
which objects are present in the portfolio.
Step 3 Call the MATLAB pie3 function, make some font and colormap
adjustments, and add a title.

Visualizing a Portfolio
You can use a DocPortfolio object to present an individual's financial portfolio. For
example, given the following assets:
XYZStock = DocStock('XYZ Stocks',200,12.34);
USTBonds = DocBond('U.S. Treasury Bonds',1600,3.2,2.8);
SaveAccount = DocSavings('MyBank Acc # 123',2000,6);
VictoriaSelna = DocPortfolio('Victoria Selna',...
XYZStock,...
SaveAccount,...
USTBonds);

you can use the class's pie3 method to display the relative mix of assets as a pie chart.
20-25

20

Designing Related Classes

pie3(VictoriaSelna)

DocPortfolio Class Code Listing

classdef DocPortfolio
properties
Name = '';
end
properties (SetAccess = private)
IndAssets = {};
TotalValue = 0;
end
methods
function p = DocPortfolio(name,varargin)
if nargin > 0
p.Name = name;
for k = 1:length(varargin) % Store objects in a cell array
p.IndAssets{k} = varargin(k);
asset_value = p.IndAssets{k}{1}.CurrentValue;
p.TotalValue = p.TotalValue + asset_value;
end

20-26

Containing Assets in a Portfolio

end
end
function disp(p)
fprintf('\nAssets for Client: %s\n',p.Name);
for k = 1:length(p.IndAssets)
disp(p.IndAssets{k}{1})
end
fprintf('\nTotal Value: $%0.2f\n',p.TotalValue);
end
function pie3(p)
stock_amt = 0; bond_amt = 0; savings_amt = 0;
for k=1:length(p.IndAssets)
if isa(p.IndAssets{k}{1},'DocStock')
stock_amt = stock_amt + p.IndAssets{k}{1}.CurrentValue;
elseif isa(p.IndAssets{k}{1},'DocBond')
bond_amt = bond_amt + p.IndAssets{k}{1}.CurrentValue;
elseif isa(p.IndAssets{k}{1},'DocSavings')
savings_amt = savings_amt + p.IndAssets{k}{1}.CurrentValue;
end
end
i = 1;
if stock_amt ~= 0
label(i) = {'Stocks'};
pie_vector(i) = stock_amt;
i = i +1;
end
if bond_amt ~= 0
label(i) = {'Bonds'};
pie_vector(i) = bond_amt;
i = i +1;
end
if savings_amt ~= 0
label(i) = {'Savings'};
pie_vector(i) = savings_amt;
end
pie3(pie_vector,label)
set(findobj(gca,'Type','Text'),'FontSize',14,'FontWeight','bold')
set(gcf,'Renderer','zbuffer')
colormap prism
stg(1) = {['Portfolio Composition for ',p.Name]};
stg(2) = {['Total Value of Assets: $',num2str(p.TotalValue,'%0.2f')]};
title(stg,'FontSize',10)
end
end
end

20-27