1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Properties (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Properties (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Properties (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="classdef-Classes.html" rel="up" title="classdef Classes">
<link href="Methods.html" rel="next" title="Methods">
<link href="Creating-a-classdef-Class.html" rel="prev" title="Creating a classdef Class">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsection-level-extent" id="Properties">
<div class="nav-panel">
<p>
Next: <a href="Methods.html" accesskey="n" rel="next">Methods</a>, Previous: <a href="Creating-a-classdef-Class.html" accesskey="p" rel="prev">Creating a <code class="code">classdef</code> Class</a>, Up: <a href="classdef-Classes.html" accesskey="u" rel="up"><code class="code">classdef</code> Classes</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Properties-3"><span>34.6.2 Properties<a class="copiable-link" href="#Properties-3"> ¶</a></span></h4>
<p>All class properties must be defined within <code class="code">properties</code> blocks. The
definition of a default value for a property is optional and can be omitted.
The default initial value for each class property is <code class="code">[]</code>.
</p>
<p>A <code class="code">properties</code> block can have additional attributes to specify access
rights or to define constants:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">classdef some_class
properties (Access = <var class="var">mode</var>)
<var class="var">prop1</var>
endproperties
properties (SetAccess = <var class="var">mode</var>, GetAccess = <var class="var">mode</var>)
<var class="var">prop2</var>
endproperties
properties (Constant = true)
<var class="var">prop3</var> = pi ()
endproperties
properties
<var class="var">prop4</var> = 1337
endproperties
endclassdef
</pre></div></div>
<p>where <var class="var">mode</var> can be one of:
</p>
<dl class="table">
<dt><code class="code">public</code></dt>
<dd><p>The properties can be accessed from everywhere.
</p>
</dd>
<dt><code class="code">private</code></dt>
<dd><p>The properties can only be accessed from class methods. Subclasses of that
class cannot access them.
</p>
</dd>
<dt><code class="code">protected</code></dt>
<dd><p>The properties can only be accessed from class methods and from subclasses
of that class.
</p></dd>
</dl>
<p>When creating an object of <code class="code">some_class</code>, <var class="var">prop1</var> has the default
value <code class="code">[]</code> and reading from and writing to <var class="var">prop1</var> is defined by
a single <var class="var">mode</var>. For <var class="var">prop2</var> the read and write access can be set
differently. Finally, <var class="var">prop3</var> is a constant property which can only be
initialized once within the <code class="code">properties</code> block.
</p>
<p>By default, in the example <var class="var">prop4</var>, properties are not constant and have
public read and write access.
</p>
<a class="anchor" id="XREFproperties"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-properties"><span><strong class="def-name">properties</strong> <code class="def-code-arguments">(<var class="var">obj</var>)</code><a class="copiable-link" href="#index-properties"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-properties-1"><span><strong class="def-name">properties</strong> <code class="def-code-arguments">(<var class="var">class_name</var>)</code><a class="copiable-link" href="#index-properties-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-properties-2"><span><code class="def-type"><var class="var">proplist</var> =</code> <strong class="def-name">properties</strong> <code class="def-code-arguments">(…)</code><a class="copiable-link" href="#index-properties-2"> ¶</a></span></dt>
<dd><p>Display or return the public properties for the classdef object <var class="var">obj</var> or
the named class <var class="var">class_name</var>.
</p>
<p>If an output value is requested, return the list of property names in a cell
array.
</p>
<p>Programming Note: Property names are returned if the <code class="code">GetAccess</code> attribute
is public and if the <code class="code">Hidden</code> attribute is false.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="Creating-a-Class.html#XREFmethods">methods</a>.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Methods.html">Methods</a>, Previous: <a href="Creating-a-classdef-Class.html">Creating a <code class="code">classdef</code> Class</a>, Up: <a href="classdef-Classes.html"><code class="code">classdef</code> Classes</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
