Handle Class Reference

This is the base class for generating subclass of MATLAB handle superclass whose annoying methods are forcefully hidden from the user view.
More...

Inheritance diagram for Handle:

Collaboration diagram for Handle:

Public Member Functions
function	doc (in self)
	Open the documentation of the class of the parent object on MATLAB display. More...
function	help (in self)
	Print help about the class of the parent object on MATLAB display. More...
function	hash2comp (in self, in hash)
function	setKeyVal (in self, in field, in subfield, in key, in val)
function	newprop (in self, in prop, in val)

Detailed Description

This is the base class for generating subclass of MATLAB handle superclass whose annoying methods are forcefully hidden from the user view.

Possible calling interfaces ⛓

Handle = pm.matlab.Handle()

Example usage ⛓

cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
addpath('../../../'); % Add the ParaMonte library root directory to the search path.
 
pm.matlab.show()
pm.matlab.show('h = pm.matlab.Handle();')
                h = pm.matlab.Handle();
 
pm.matlab.show()
pm.matlab.show('h.help();')
                h.help();

Example output ⛓

 
h = pm.matlab.Handle();
 
h.help();
 >  \brief
 >  This is the base class for generating
 >  subclass of MATLAB ``handle`` superclass whose annoying
 >  methods are forcefully hidden from the user view.<br>
 >
 >  \interface{Handle}
 >  \code{.m}
 >
 >      Handle = pm.matlab.Handle()
 >
 >  \endcode
 >
 >  \example{Handle}
 >  \include{lineno} example/matlab/Handle/main.m
 >  \output{Handle}
 >  \include{lineno} example/matlab/Handle/main.out.m
 >
 >  \final{Handle}
 >
 >  \author
 >  \JoshuaOsborne, May 21 2024, 11:31 PM, University of Texas at Arlington<br>
 >  \FatemehBagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.<br>
 >  \AmirShahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin<br>
 
    Documentation for pm.matlab.Handle
       doc pm.matlab.Handle
 
 

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 11:31 PM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

Definition at line 24 of file Handle.m.

Member Function Documentation

doc()

function Handle::doc

(

in

self

)

Open the documentation of the class of the parent object on MATLAB display.

This is a dynamic method of the class pm.matlab.Handle.

Parameters

[in,out]

self

: The implicitly-passed input argument representing the parent object of the method.

Possible calling interfaces ⛓

h = pm.matlab.Handle();
h.doc();

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 11:34 PM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

hash2comp()

function Handle::hash2comp	(	in	self,
		in	hash
	)

help()

function Handle::help

(

in

self

)

Print help about the class of the parent object on MATLAB display.

This is a dynamic method of the class pm.matlab.Handle.

Possible calling interfaces ⛓

self.help()

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Joshua Alexander Osborne, May 21 2024, 11:36 PM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin

newprop()

function Handle::newprop	(	in	self,
		in	prop,
		in	val
	)

setKeyVal()

function Handle::setKeyVal	(	in	self,
		in	field,
		in	subfield,
		in	key,
		in	val
	)

---

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

• src/matlab/main/+pm/+matlab/Handle.m