matlab.alias.AliasFileManager class

Пакет: matlab.alias

Создайте и управляйте определениями псевдонима класса

Описание

matlab.alias.AliasFileManager класс позволяет вам создать и управлять определениями псевдонима класса. Определения псевдонима сопоставляют новое имя класса с одним или несколькими старыми названиями. Используйте эту функциональность, чтобы изменить название существующего класса при поддержании совместимости с кодом и MAT-файлами, которые используют более старые имена класса.

Рекомендуемый процесс для создания псевдонимов должен записать функцию, чтобы создать экземпляр AliasFileManager. Для получения дополнительной информации и примеры, смотрите Псевдонимы Класса Создания и Управления.

matlab.alias.AliasFileManager классом является handle класс.

Атрибуты класса

Sealed
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

пример

fileMgr = matlab.alias.AliasFileManager создает AliasFileManager по умолчанию экземпляр.

fileMgr = matlab.alias.AliasFileManager(location) создает AliasFileManager экземпляр и загрузки alias файл в заданном location. location путь к родительской папке resources папка, содержащая файл определения псевдонима. Используя этот синтаксис обеспечивает удобный способ просмотреть все заданные псевдонимы класса в location.

Входные параметры

развернуть все

Путь к папке, содержащей существующий класс, искажает файл в виде строкового скаляра. Путь должен указать на родительскую папку resources папка, содержащая файл определения псевдонима. Если никакой alias файл существует в том местоположении, MATLAB® ошибки.

location может быть весь или частичный путь. Полные пути не рекомендуются для кода, который упакован для использования другими, потому что пути к установке могут варьироваться.

Свойства

развернуть все

Определения псевдонима класса в виде массива AliasDefinition объекты. Свойство содержит текущее имя класса и все активные старые псевдонимы для всех классов в данной папке.

Атрибуты:

Transient
true

Методы

развернуть все

Примеры

свернуть все

В этом примере показано, как использовать функцию, чтобы создать файл псевдонима класса.

Этот пример переименовывает класс FirstName к SecondName. Чтобы выполнить это, файл определения псевдонима создается, который идентифицирует SecondName как новое имя класса и FirstName как старый псевдоним.

Файл класса с новым именем, SecondName.m, находится в папке под названием Work. Функция createAliasFile находится также в Work.

Work folder with createAliasFIle and SecondName files

createAliasFile функция запущена от Work папка. Функция создает fileMgr, экземпляр класса AliasFileManager. addAlias метод добавляет новые и старые названия класса к fileMgr. Наконец, writeAlias метод записывает файл определения псевдонима в resources папка. Метод создает папку, если это уже не существует.

function createAliasFile
    fileMgr = matlab.alias.AliasFileManager;
    addAlias(fileMgr,NewName="SecondName",OldNames="FirstName");
    writeAliasFile(fileMgr);
end

Измените текущую рабочую директорию в Work папка и вызов createAliasFile.

createAliasFile

Функция создает resources папка и alias файл определения в нем.

resources folder added, containing alias definition file

MATLAB теперь распознает и имена классов, и созданное использование экземпляров любого имени задано как экземпляры SecondName.

old = FirstName
new = SecondName
old = 

  SecondName with no properties.


new = 

  SecondName with no properties.

Советы

  • Функциональный рабочий процесс, продемонстрированный в примере, имеет преимущество автоматической очистки экземпляра AliasFileManager.

  • Осуждение старых псевдонимов класса не рекомендуется. Удаление старых псевдонимов рискует проблемами совместимости для пользователей вашего кода. Чтобы получить доступ к существующему файлу определения псевдонима, используйте fileMgr = matlab.alias.AliasFileManagerместоположение ) конструктор и считал его свойство Aliases.

Введенный в R2021b