properties

Class property names

Syntax

properties(ClassName)

properties(obj)

p = properties(___)

Description

properties(ClassName) displays the names of non-hidden properties with public GetAccess for the MATLAB^® class, including inherited properties.

properties(obj) displays the names of non-hidden properties with public GetAccess for the object or object array. When obj is scalar, properties also returns dynamic properties. When obj is an array, properties returns the properties of the class of the array.

p = properties(___) returns the property names in a cell array of character vectors.

Examples

List Properties Using Class Name

List the properties of a class using the class name.

properties memmapfile

Properties for class memmapfile:

    Filename
    Writable
    Offset
    Format
    Repeat
    Data

List Properties of Object

List the public properties of an MException object.

me = MException('Msg:ID','MsgText');
p = properties(me)

p = 5×1 cell
    {'identifier'}
    {'message'   }
    {'cause'     }
    {'stack'     }
    {'Correction'}

Input Arguments

ClassName — Name of the class

character vector | string scalar

Name of the class whose properties you want to query, specified as a character vector or string scalar.

obj — MATLAB object

object

Object of the class whose properties you want to query, specified as an object or array of objects.

Output Arguments

p — Property names

cell array

Property names returned as a cell array of character vector.

More About

Properties Keyword

The word properties is also a MATLAB class-definition keyword. See classdef for more information on class definition keywords.

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

• The function call properties(obj) is supported for code generation only if obj is an instance of a MATLAB class defined in a .m file.

• The order in which the code generated for the function properties returns the properties of an object might be different from MATLAB execution.

GPU Code Generation

Generate CUDA® code for NVIDIA® GPUs using GPU Coder™.

Refer to the usage notes and limitations in the C/C++ Code Generation section. The same usage notes and limitations apply to GPU code generation.

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

The properties function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Distributed Arrays

Partition large arrays across the combined memory of your cluster using Parallel Computing Toolbox™.

The properties function fully supports distributed arrays. For more information, see Run MATLAB Functions with Distributed Arrays (Parallel Computing Toolbox).

Version History

Introduced in R2008a