compiler.build.excelClientForProductionServer

Создайте дополнение Microsoft Excel для MATLAB Production Server

Описание

пример

Внимание

Эта функция только поддерживается на Windows® операционные системы.

compiler.build.excelClientForProductionServer(Results) создает Excel® дополнение для MATLAB® Production Server™ с помощью compiler.build.Results объект Results созданный из compiler.build.productionServerArchive функция. Прежде, чем создать дополнения Excel, установите поддерживаемый компилятор.

пример

compiler.build.excelClientForProductionServer(FunctionFiles,ServerArchive) создает дополнение Excel с помощью функций MATLAB, заданных FunctionFiles и архив MATLAB Production Server задан ServerArchive.

пример

compiler.build.excelClientForProductionServer(FunctionFiles,ServerArchive,Name,Value) создает дополнение Excel с опциями, заданными с помощью одних или нескольких аргументов name-value. Опции включают дополнительное имя, выводят директорию, и как обработать тип данных даты Excel.

пример

compiler.build.excelClientForProductionServer(opts) создает дополнение Excel с опциями, заданными с помощью compiler.build.ExcelClientForProductionServerOptions объект opts. Вы не можете задать никакие другие опции с помощью аргументов name-value.

пример

results = compiler.build.excelClientForProductionServer(___) возвращает информацию о сборке как compiler.build.Results объект с помощью любой из комбинаций входных аргументов в предыдущих синтаксисах. Информация о сборке состоит из типа сборки, путей к скомпилированным файлам и опций сборки.

Примеры

свернуть все

Создайте дополнение Excel для MATLAB Production Server в системе Windows с помощью результатов compiler.build.productionServerArchive функция.

Убедитесь, что у вас есть установленное следующее:

  • Набор Windows 10 SDK. Для получения дополнительной информации смотрите Windows 10 SDK.

  • MinGW-w64. Чтобы установить его от MathWorks File Exchange, смотрите Поддержку MATLAB Компилятора C/C++ MinGW-w64.

    Используйте mbuild -setup -client mbuild_com гарантировать, что MATLAB может создать дополнения Excel.

В MATLAB найдите функцию MATLAB, которую вы хотите развернуть как дополнение Excel. В данном примере используйте файл magicsquare.m расположенный в matlabroot\extern\examples\compiler.

appFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');

Создайте архив MATLAB Production Server использование compiler.build.productionServerArchive команда. Сохраните выход как compiler.build.Results объект serverBuildResults.

serverBuildResults = compiler.build.productionServerArchive(appFile);

Создайте дополнение Excel для архива MATLAB Production Server использование compiler.build.excelClientForProductionServer команда.

excelBuildResults = compiler.build.excelClientForProductionServer(serverBuildResults);

Функция генерирует следующие файлы в папке под названием magicsquareexcelClientForProductionServer в вашей текущей рабочей директории:

  • includedSupportPackages.txt

  • magicsquare.bas (Только если вы включаете 'GenerateVisualBasicFile' опция)

  • magicsquare.dll

  • magicsquare.reg

  • magicsquare.xla (Только если вы включаете 'GenerateVisualBasicFile' опция)

  • magicsquareClass.cs

  • readme.txt

  • requiredMCRProducts.txt

Создайте дополнение Excel для MATLAB Production Server в системе Windows с помощью файлов функции MATLAB и архива MATLAB Production Server.

Создайте архив MATLAB Production Server использование файла функции MATLAB. В данном примере используйте файл magicsquare.m расположенный в matlabroot\extern\examples\compiler как вход к compiler.build.productionServerArchive функция.

mpsFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
compiler.build.productionServerArchive(mpsFile);

Функция генерирует файл magicsquare.ctf в magicsquareproductionServerArchive папка.

Создайте дополнение Excel для архива MATLAB Production Server использование compiler.build.excelClientForProductionServer команда. Задайте файл функции и файл CTF как входные параметры.

excelBuildResults = compiler.build.excelClientForProductionServer(mpsFile,'magicsquareproductionServerArchive\magicsquare.ctf');

Создайте дополнение Excel и настройте его с помощью аргументов name-value.

Создайте архив MATLAB Production Server использование файла функции MATLAB. В данном примере используйте файл magicsquare.m расположенный в matlabroot\extern\examples\compiler как вход к compiler.build.productionServerArchive функция.

mpsFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
compiler.build.productionServerArchive(mpsFile);

Создайте дополнение Excel для MATLAB Production Server с помощью compiler.build.excelClientForProductionServer команда. Используйте аргументы name-value, чтобы задать дополнительное имя, сгенерировать Microsoft® Visual Basic® файл, и включает многословный выход.

compiler.build.excelClientForProductionServer(mpsFile,...
    'magicsquareproductionServerArchive\magicsquare.ctf',...
    'AddInName','MyMagicSquare',...
    'GenerateVisualBasicFile','on',...
    'Verbose','on');

Функция генерирует следующие файлы в папке под названием MyMagicSquareexcelClientForProductionServer в вашей текущей рабочей директории:

  • includedSupportPackages.txt

  • MyMagicSquare.bas

  • MyMagicSquare.dll

  • MyMagicSquare.reg

  • MyMagicSquare.xla

  • MyMagicSquareClass.cs

  • readme.txt

  • requiredMCRProducts.txt

Создайте несколько дополнений Excel для MATLAB Production Server в системе Windows с помощью compiler.build.ExcelClientForProductionServerOptions объект.

Создайте архив MATLAB Production Server использование файла функции MATLAB. В данном примере используйте файл magicsquare.m расположенный в matlabroot\extern\examples\compiler как вход к compiler.build.productionServerArchive функция.

mpsFile = fullfile(matlabroot,'extern','examples','compiler','magicsquare.m');
compiler.build.productionServerArchive(mpsFile);

Создайте ExcelClientForProductionServerOptions объект с помощью файла houdini.m расположенный в matlabroot\extern\examples\compiler. Используйте аргументы name-value, чтобы задать общую выходную директорию, сгенерировать файл Visual Basic и включить многословный выход.

appFile = fullfile(matlabroot,'extern','examples','compiler','houdini.m');
opts = compiler.build.ExcelClientForProductionServerOptions(appFile,...
    'magicsquareproductionServerArchive\magicsquare.ctf',...
    'OutputDir','D:\Documents\MATLAB\work\MPSExcelAddInBatch',...
    'GenerateVisualBasicFile','on',...
    'Verbose','on')
opts = 

  ExcelClientForProductionServerOptions with properties:

                         AddInName: 'houdini'
                      AddInVersion: '1.0.0.0'
                         ClassName: 'houdiniClass'
                        DebugBuild: off
                     FunctionFiles: {'C:\Program Files\MATLAB\R2021b\extern\examples\compiler\houdini.m'}
           GenerateVisualBasicFile: on
                     ServerArchive: 'magicsquareproductionServerArchive\magicsquare.ctf'
          ReplaceExcelBlankWithNaN: off
          ConvertExcelDateToString: off
           ReplaceNaNToZeroInExcel: off
    ConvertNumericOutToDateInExcel: off
                           Verbose: on
                         OutputDir: 'D:\Documents\MATLAB\work\MPSExcelAddInBatch'

Создайте дополнение с помощью ExcelAddInOptions объект.

compiler.build.excelClientForProductionServer(opts);

Создать новое дополнение с помощью файла функции houdini.m с теми же опциями используйте запись через точку, чтобы изменить FunctionFiles аргумент существующего ExcelAddInOptions объект прежде, чем запустить сборку функционирует снова.

appFile2 = fullfile(matlabroot,'extern','examples','compiler','houdini.m');
opts.FunctionFiles = appFile2;
compiler.build.excelClientForProductionServer(opts);

Путем изменения FunctionFiles аргумент и рекомпиляция, можно создать несколько дополнений с помощью того же объекта опций.

Создайте дополнение Excel для MATLAB Production Server и сохраните информацию о типе сборки, сгенерированных файлах, включал пакеты поддержки и опции сборки к compiler.build.Results объект.

Создайте архив MATLAB Production Server использование файла magicsquare.m расположенный в matlabroot\extern\examples\compiler. Сохраните выход как compiler.build.Results объект serverBuildResults.

serverBuildResults = compiler.build.productionServerArchive('magicsquare.m');

Создайте дополнение Excel с помощью serverBuildResults объект.

results = compiler.build.excelClientForProductionServer(serverBuildResults)
results = 

  Results with properties:

              BuildType: 'excelClientForProductionServer'
                  Files: {1×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.ExcelClientForProductionServerOptions]

Files свойство содержит пути к следующим скомпилированным файлам:

  • magicsquare.dll

  • magicsquare.bas

  • magicsquare.xla

Примечание

Файлы magicsquare.bas и magicsquare.xla включены в Files только если вы включаете 'GenerateVisualBasicFile' опция в compiler.build.excelClientForProductionServer команда.

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

свернуть все

Файлы, реализующие функции MATLAB в виде вектора символов, строкового скаляра, массива строк или массива ячеек из символьных векторов. Пути к файлам могут быть относительно текущей рабочей директории или абсолюта. Файлы должны иметь .m расширение.

Пример: ["myfunc1.m","myfunc2.m"]

Типы данных: char | string | cell

Дополнение Excel создает опции в виде compiler.build.ExcelClientForProductionServerOptions объект.

Создайте результаты в виде compiler.build.Results объект. Создайте Results объект путем сохранения выхода из compiler.build.productionServerArchive функция.

Архив MATLAB Production Server, развернутый на Рабочем сервере в виде вектора символов или строкового скаляра.

Пример: 'mpsArchive.ctf'

Типы данных: char | string

Аргументы name-value

Задайте дополнительные разделенные запятой пары Name,Value аргументы. Name имя аргумента и Value соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

Пример: 'Verbose','on'

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

Пример: 'AddInName','myAddIn'

Типы данных: char | string

Дополнительная версия в виде вектора символов или строкового скаляра.

Пример: 'AddInVersion','4.0'

Типы данных: char | string

Имя сгенерированного класса в виде вектора символов или строкового скаляра. Вы не можете задать эту опцию, если вы используете ClassMap входной параметр. Имена классов должны удовлетворить требования имени класса Excel.

Значением по умолчанию является AddInName аргумент добавлен с Class.

Пример: 'ClassName','MagicSquareClass'

Типы данных: char | string

Отметьте, чтобы преобразовать дату Excel, чтобы представить в виде строки в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем компилятор преобразует тип данных даты Excel в строку MATLAB.

  • Если вы устанавливаете это свойство на 'off', затем даты не преобразованы.

Пример: 'ConvertExcelDateToString','On'

Типы данных: логический

Отметьте, чтобы преобразовать числовые данные в дату Excel в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем компилятор преобразует числовые данные в тип данных даты Excel.

  • Если вы устанавливаете это свойство на 'off', затем числовые данные не преобразованы.

Пример: 'ConvertNumericOutToDateInExcel','On'

Типы данных: логический

Отметьте, чтобы включить отладочные символы в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем дополнение скомпилировано с отладочными символами.

  • Если вы устанавливаете это свойство на 'off', затем дополнение не скомпилировано с отладочными символами.

Пример: 'DebugSymbols','On'

Типы данных: логический

Отметьте, чтобы сгенерировать файл Visual Basic (.bas) и дополнительный файл Excel (.xla) в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем функция генерирует дополнение Excel файл XLA и файл BAS Visual Basic, содержащий интерфейс Microsoft Excel Formula Function к дополнению.

  • Если вы устанавливаете это свойство на 'off', затем функция не генерирует файл Visual Basic или дополнительный файл Excel.

Пример: 'GenerateVisualBasicFile','On'

Типы данных: логический

Путь к выходной директории, где файлы типа "build" сохранены в виде вектора символов или строкового скаляра. Путь может быть относительно текущей рабочей директории или абсолюта.

Имя по умолчанию папки сборки является дополнительным именем, добавленным с excelAddIn.

Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagicexcelAddIn'

Типы данных: char | string

Отметьте, чтобы преобразовать пустые ячейки Excel в NaN в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем компилятор преобразует пустые ячейки Excel в NaN в скомпилированном артефакте.

  • Если вы устанавливаете это свойство на 'off', затем пустые ячейки Excel не преобразованы.

Пример: 'ReplaceExcelBlankWithNaN','On'

Типы данных: логический

Отметьте, чтобы преобразовать записи NaN, чтобы обнулить в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем компилятор преобразует записи NaN от скомпилированного артефакта, чтобы обнулить в Excel.

  • Если вы устанавливаете это свойство на 'off', затем записи NaN не преобразованы.

Пример: 'ReplaceNaNToZeroInExcel','On'

Типы данных: логический

Отметьте, чтобы управлять многословием сборки в виде 'on' или 'off', или как числовой или логический 1 TRUE) или 0 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа matlab.lang.OnOffSwitchState.

  • Если вы устанавливаете это свойство на 'on', затем окно команды MATLAB отображает информацию о прогрессе, указывающую на выход компилятора во время процесса сборки.

  • Если вы устанавливаете это свойство на 'off', затем командное окно не отображает информацию о прогрессе.

Пример: 'Verbose','On'

Типы данных: логический

Выходные аргументы

свернуть все

Создайте результаты, возвращенные как compiler.build.Results объект. Results объект содержит:

  • Создайте тип, который является 'excelClientForProductionServer'

  • Пути к следующим файлам:

    • AddInName.dll

    • AddInName.bas (если вы включаете 'GenerateVisualBasicFile' опция)

    • AddInName.xla (если вы включаете 'GenerateVisualBasicFile' опция)

  • Список включенных пакетов поддержки

  • Создайте опции в виде ExcelClientForProductionServerOptions объект

Ограничения

  • Эта функция только поддерживается на операционных системах Windows.

Введенный в R2021b