|
| def | _clean_class_name (self, instantiator.InstantiatedClass instantiated_class) |
| |
| def | _format_class_name (self, instantiator.InstantiatedClass instantiated_class, str separator='') |
| |
| def | _format_global_function (self, Union[parser.GlobalFunction, Any] function, str separator='') |
| |
| def | _format_return_type (self, parser.function.ReturnType return_type, bool include_namespace=False, str separator="::") |
| |
| def | _format_static_method (self, parser.StaticMethod static_method, str separator='') |
| |
| def | _format_type_name (self, parser.Typename type_name, str separator='::', bool include_namespace=True, bool is_constructor=False, bool is_method=False) |
| |
Mixin to provide formatting utilities.
Definition at line 89 of file mixins.py.
◆ _clean_class_name()
| def gtwrap.matlab_wrapper.mixins.FormatMixin._clean_class_name |
( |
|
self, |
|
|
instantiator.InstantiatedClass |
instantiated_class |
|
) |
| |
|
private |
Reformatted the C++ class name to fit Matlab defined naming
standards
Definition at line 97 of file mixins.py.
◆ _format_class_name()
| def gtwrap.matlab_wrapper.mixins.FormatMixin._format_class_name |
( |
|
self, |
|
|
instantiator.InstantiatedClass |
instantiated_class, |
|
|
str |
separator = '' |
|
) |
| |
|
private |
Format a template_instantiator.InstantiatedClass name.
Definition at line 197 of file mixins.py.
◆ _format_global_function()
| def gtwrap.matlab_wrapper.mixins.FormatMixin._format_global_function |
( |
|
self, |
|
|
Union[parser.GlobalFunction, Any] |
function, |
|
|
str |
separator = '' |
|
) |
| |
|
private |
Example:
gtsamPoint3.staticFunction
Definition at line 229 of file mixins.py.
◆ _format_return_type()
| def gtwrap.matlab_wrapper.mixins.FormatMixin._format_return_type |
( |
|
self, |
|
|
parser.function.ReturnType |
return_type, |
|
|
bool |
include_namespace = False, |
|
|
str |
separator = "::" |
|
) |
| |
|
private |
Format return_type.
Args:
return_type: an interface_parser.ReturnType to reformat
include_namespace: whether to include namespaces when reformatting
Definition at line 167 of file mixins.py.
◆ _format_static_method()
| def gtwrap.matlab_wrapper.mixins.FormatMixin._format_static_method |
( |
|
self, |
|
|
parser.StaticMethod |
static_method, |
|
|
str |
separator = '' |
|
) |
| |
|
private |
Example:
gtsam.Point3.staticFunction()
Definition at line 215 of file mixins.py.
◆ _format_type_name()
| def gtwrap.matlab_wrapper.mixins.FormatMixin._format_type_name |
( |
|
self, |
|
|
parser.Typename |
type_name, |
|
|
str |
separator = '::', |
|
|
bool |
include_namespace = True, |
|
|
bool |
is_constructor = False, |
|
|
bool |
is_method = False |
|
) |
| |
|
private |
Args:
type_name: an interface_parser.Typename to reformat
separator: the statement to add between namespaces and typename
include_namespace: whether to include namespaces when reformatting
is_constructor: if the typename will be in a constructor
is_method: if the typename will be in a method
Raises:
constructor and method cannot both be true
Definition at line 107 of file mixins.py.
The documentation for this class was generated from the following file:
