clibgen.ConstructorDefinition Class

R2026b

Namespace: clibgen

(Not recommended) Definition for MATLAB function corresponding to C++ class constructor

The recommended way to generate a constructor definition for a C++ library is to use a clibgen.api.ConstructorDefinition object. For more information on updating your code, see Version History.

Description

The clibgen.ConstructorDefinition class contains the MATLAB^® definition for a constructor defined in the header of a C++ class.

The clibgen.ConstructorDefinition class is a handle class.

Creation

MATLAB constructs a ConstructorDefinition object when MATLAB calls addConstructor on a clibgen.ClassDefinition object.

Properties

Description — Help text

string | character vector

Help text for the end user describing the constructor, specified as a string or a character vector. The default text is:

DefiningClass.MATLABName.DefiningClass.CPPName    Constructor of C++ class DefiningClass.CPPName.

The publisher can modify the value of the Description property in the library definition file.

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 constructor, 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

CPPSignature — C++ constructor signature

string | character vector

C++ constructor signature, specified as a string or a character vector. MATLAB creates CPPSignature from the class definition in the header file.

Attributes:

GetAccess	public
SetAccess	private

DefiningClass — Class containing constructor

clibgen.ClassDefinition

Class containing the constructor, specified as a clibgen.ClassDefinition object.

Attributes:

GetAccess	public
SetAccess	private

MATLABSignature — Constructor signature in MATLAB

string | character vector

Constructor signature in MATLAB, specified as a string or a character vector. MATLAB creates this signature.

Attributes:

GetAccess	public
SetAccess	private
Dependent	true

Valid — Definition complete indicator

false (default) | true

Indicate if constructor definition is complete, specified as true or false.

Attributes:

GetAccess	public
SetAccess	private

Methods

Public Methods

defineArgument	(Not recommended) Add input argument definition for C++ constructor
validate	(Not recommended) Validate C++ constructor definition

Version History

Introduced in R2019a

R2026b: Not recommended

There are no plans to remove clibgen.ConstructorDefinition. However, creating a clibgen.api.ConstructorDefinition object in the clibgen.api namespace is recommended instead.