clibgen.ClassDefinition Class
Namespace: clibgen
Definition for MATLAB class corresponding to C++ class
Description
The clibgen.ClassDefinition
class contains the MATLAB® definition for a class defined in the C++ header.
The clibgen.ClassDefinition
class is a handle
class.
Creation
MATLAB constructs a ClassDefinition
object when MATLAB calls addClass
on a
clibgen.LibraryDefinition
object.
Properties
Description
— Help text
string | character vector
Help text for the end user describing the class, specified as a string or a character vector. The default text is:
MATLABName Representation of C++ class CPPName.
The publisher can modify the value of the Description
property
in the library definition file.
Example: clib.cppSample.TestClass
Representation of C++ class
TestClass
.
Attributes:
GetAccess | public |
SetAccess | public |
DetailedDescription
— Help text from C++ header file
string | character vector | empty string
Help text from C++ header file for the end user describing details about the class,
specified as a string or a character vector. If the C++ comment does not contain
detailed information, then DetailedDescription
does not appear in
the definition file.
The publisher can modify the value of the DetailedDescription
property in the library definition file. If DetailedDescription
is
not empty, then the MATLAB
doc
command displays this sentence before displaying the value of
DetailedDescription
.
This content is from the external library documentation.
Attributes:
GetAccess | public |
SetAccess | public |
MATLABName
— C++ class name in MATLAB
string | character vector
C++ class name in MATLAB, specified as a string or a character vector. MATLAB creates MATLABName
from the InterfaceName and CPPName
properties.
clib.DefiningLibrary.InterfaceName.CPPName
Example: clib.cppSample.TestClass
Attributes:
GetAccess | public |
SetAccess | private |
CPPName
— C++ class name
string | character vector
C++ class name, specified as a string or a character vector. MATLAB creates CPPName
from the class
name in the header file.
Example: TestClass
Attributes:
GetAccess | public |
SetAccess | private |
Methods
— Class methods
clibgen.MethodDefinition
Class methods, specified as one or more clibgen.MethodDefinition
objects.
Attributes:
GetAccess | public |
SetAccess | private |
Constructors
— Class constructors
clibgen.ConstructorDefinition
Class constructors, specified as one or more clibgen.ConstructorDefinition
objects.
Attributes:
GetAccess | public |
SetAccess | private |
Properties
— Class properties
clibgen.PropertyDefinition
Class properties, specified as one or more clibgen.PropertyDefinition
objects.
Attributes:
GetAccess | public |
SetAccess | private |
DefiningLibrary
— Library defining class
clibgen.LibraryDefinition
Library defining the class, specified as a clibgen.LibraryDefinition
object.
Attributes:
GetAccess | public |
SetAccess | private |
Methods
Public Methods
addConstructor | Add constructor to C++ class definition |
addMethod | Add method to C++ class definition |
addProperty | Add property to C++ class definition |
Version History
Introduced in R2019a
See Also
Comando MATLAB
Hai fatto clic su un collegamento che corrisponde a questo comando MATLAB:
Esegui il comando inserendolo nella finestra di comando MATLAB. I browser web non supportano i comandi MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)