handle Class Reference

Matlab's base handle class (documentation generation substitute) More...

Public Attributes
	addlistener
	Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...
	notify
	Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects.
	delete
	Handle object destructor method that is called when the object's lifecycle ends.
	disp
	Handle object disp method which is called by the display method. See the MATLAB disp function.
	display
	Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function.
	findobj
	Finds objects matching the specified conditions from the input array of handle objects.
	findprop
	Returns a meta.property objects associated with the specified property name.
	fields
	Returns a cell array of string containing the names of public properties.
	fieldnames
	Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function.
	isvalid
	Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass.
	eq
	Relational functions example. See details for more information. More...
	transpose
	Transposes the elements of the handle object array.
	permute
	Rearranges the dimensions of the handle object array. See the MATLAB permute function.
	reshape
	hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function.
	sort
	ort the handle objects in any array in ascending or descending order. More...

Detailed Description

As doxygen does not know the class "handle" from itself, many classes do not get rendered within the documentation and the correct root class is not even displayed. This workaround guarantees a correct (also graphical) representation of the class hierarchy.

Note here that by having the type handle it could also mean to have a vector or matrix of handles.

Definition at line 91 of file class_substitutes.c.

Member Data Documentation

handle.addlistener

See Also

notify

Definition at line 106 of file class_substitutes.c.

handle.eq

Other possible relational operators:

-ne -lt -le -gt -ge

Relational functions return a logical array of the same size as the pair of input handle object arrays. Comparisons use a number associated with each handle. You can assume that the same two handles will compare as equal and the repeated comparison of any two handles will yield the same result in the same MATLAB session. Different handles are always not-equal. The order of handles is purely arbitrary, but consistent.

Definition at line 167 of file class_substitutes.c.

handle.sort

The order of handles is purely arbitrary, but reproducible in a given MATLAB session. See the MATLAB sort function.

Definition at line 189 of file class_substitutes.c.

---

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

• tools/config/class_substitutes.c