Main Content

matlab::data::MATLABFieldIdentifier

R2026b

C++ class used to identify field names in MATLAB struct array

Description

Namespace:

matlab::data

Include:

MATLABFieldIdentifier.hpp

Constructors

Default Constructor

MATLABFieldIdentifier()

Description

Construct an empty MATLABFieldIdentifier.

Throws

None

Constructor

MATLABFieldIdentifier(std::string str)

Description

Construct a MATLABFieldIdentifier from std::string.

Parameters

std::string str

String that contains the field name.

Destructor

~MATLABFieldIdentifier()

Description

Destroy a MATLABFieldIdentifier.

Throws

None

Copy Constructors

MATLABFieldIdentifier(const MATLABFieldIdentifier& rhs)

Description

Creates a shared data copy of a MATLABFieldIdentifier object.

Parameters

const MATLABFieldIdentifier& rhs

Value to copy.

Throws

None

Copy Assignment Operators

MATLABFieldIdentifier& operator=(MATLABFieldIdentifier const& rhs)

Description

Assigns a shared data copy to a MATLABFieldIdentifier object.

Parameters

MATLABFieldIdentifier const& rhs

Value to move.

Returns

MATLABFieldIdentifier&

Updated instance.

Throws

None

Move Constructors

MATLABFieldIdentifier(MATLABFieldIdentifier&& rhs)

Description

Moves contents a MATLABFieldIdentifier object to a new instance.

Parameters

MATLABFieldIdentifier&& rhs

Value to move.

Throws

None

Move Assignment Operators

MATLABFieldIdentifier& operator=(MATLABFieldIdentifier&& rhs)

Parameters

MATLABFieldIdentifier&& rhs

Value to move.

Returns

MATLABFieldIdentifier&

Updated instance.

Throws

None

Destructor

~MATLABFieldIdentifier()

Description

Destroy a MATLABFieldIdentifier.

Other Operators

operator std::string

operator std::string() const

Returns

std::string

Representation of the MATLABFieldIdentifier object.

Throws

None

Free Functions

operator==

bool operator==(const MATLABFieldIdentifier& rhs) const

Description

Check if two MATLABFieldIdentifier objects are identical.

Parameters

const MATLABFieldIdentifier& rhs

Value to be compared.

Returns

bool

Returns true if the objects are identical. Otherwise, returns false.

Throws

None

Version History

Introduced in R2017b