Exponenta Banner

slreportgen.report.CFunction class

Пакет: slreportgen.report

C генератор отчетов Функционального блока

расширьте все на странице

Описание

Используйте объект slreportgen.report.CFunction класс, чтобы сообщить относительно блока C Function.

По умолчанию, CFunction объектные отчеты:

  • Таблица, которая включает параметр Description и любые пользовательские параметры маски

  • Таблица, которая перечисляет содержимое параметра Symbols

  • Разделы для кода С, заданного Output Code, Start Code и параметрами Terminate Code

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

Примечание

Использовать CFunction генератор отчетов в отчете, необходимо создать отчет с помощью slreportgen.report.Report класс.

slreportgen.report.CFunction классом является handle класс.

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

HandleCompatible
true

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

Создание

Описание

rptr = slreportgen.report.CFunction() создает CFunction объект со значениями свойств по умолчанию. Необходимо задать блок C Function, чтобы сообщить путем установки Object свойство. Используйте другие свойства задать опции отчета.

пример

rptr = slreportgen.report.CFunction(cFunctionBlock) задает блок C Function, чтобы сообщить и устанавливает Object свойство к cFunctionBlock.

rptr = slreportgen.report.CFunction(Name=Value) свойства наборов с помощью аргументов name-value. Например, rptr = slreportgen.report.CFunction(Object="slrgex_cfunction/C Function") устанавливает Object свойство к "slrgex_cfunction/C Function". Можно задать несколько аргументов name-value.

Свойства

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

Блок Simulink C Function, чтобы сообщить в виде одного из этих значений:

  • Строковый скаляр или вектор символов, который содержит путь блока C Function

  • Указатель на блок C Function

  • slreportgen.finder.BlockResult объект, который представляет блок.

Примечание

Если вы используете средство поиска, чтобы найти блоки C Function и добавить результаты непосредственно в отчет, о блоках сообщают с помощью slreportgen.report.CFunction генераторы отчетов, вместо этого of slreportgen.report.SimulinkObjectProperties генераторы отчетов.

Включать ли таблицу параметров блоков в виде true или false. Если этим свойством является true, генератор отчетов генерирует таблицу, которая включает параметр Description и любые пользовательские параметры маски по умолчанию. Output Code, Start Code, Terminate Code и параметры Symbols не включены в эту таблицу, потому что о них сообщают в отдельных участках. Используйте ObjectPropertiesReporter свойство этого генератора отчетов задать параметры, которые таблица включает или настроить формат таблицы. Если параметры пусты, генератор отчетов не генерирует таблицу.

Атрибуты:

GetAccess
public
SetAccess
public

Включать ли таблицу символов, используемых блоком C Function в виде true или false.

Атрибуты:

GetAccess
public
SetAccess
public

Включать ли код С, использовался для расчета выходных параметров блока C Function в виде true или false.

Атрибуты:

GetAccess
public
SetAccess
public

Включать ли код С, использовался для расчета начального состояния блока C Function в виде true или false.

Атрибуты:

GetAccess
public
SetAccess
public

Включать ли код С, который выполняет Функциональный блок C, когда это завершает работу в виде true или false.

Атрибуты:

GetAccess
public
SetAccess
public

Средство форматирования для таблицы свойств блока C Function в виде slreportgen.report.SimulinkObjectProperties объект. Значением по умолчанию этого свойства является пустой slreportgen.report.SimulinkObjectProperties объект. Можно настроить внешний вид таблицы свойств блока путем изменения свойств объекта по умолчанию или заменив его на другой SimulinkObjectProperties объект. Можно задать свойства отобразиться в этой таблице при помощи Properties свойство SimulinkObjectProperties объект. Если Properties пусто, генератор отчетов автоматически определяет который свойства отобразиться на основе параметров Функционального блока C.

Атрибуты:

GetAccess
public
SetAccess
public

Средство форматирования для таблицы символов используется Функциональным блоком C в виде mlreportgen.report.BaseTable объект. Значением по умолчанию этого свойства является пустой BaseTable объект с StyleName набор свойств к "CFunctionSymbolsTable". Можно настроить внешний вид таблицы символов путем изменения свойств объекта по умолчанию или заменив его на другой BaseTable объект. Любое содержимое, добавленное к свойству заголовка BaseTable объект появляется, прежде чем значение по умолчанию сгенерировало табличный заголовок в отчете.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных:

Средство форматирования абзаца для заголовков выхода, запустите, и оконечные секции кода отчета в виде mlreportgen.dom.Paragraph объект. Значением по умолчанию этого свойства является пустой Paragraph объект с StyleName набор свойств к "CFunctionCodeTitle". Можно настроить внешний вид заголовков секции кода путем изменения свойств объекта по умолчанию или заменив его на другой Paragraph объект. Любое содержимое добавляется к Paragraph объект в этом свойстве появляется перед заголовками кода в отчете.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных:

Средство форматирования для кода С в выходе, запустите и отключите секции кода отчета в виде mlreportgen.dom.Preformatted объект. Значением по умолчанию этого свойства является пустой Preformatted объект с StyleName установите на "CFunctionCode". Можно настроить внешний вид кода С путем изменения свойств объекта по умолчанию или заменив его на другой Preformatted объект. Любое содержимое добавляется к Preformatted объект в этом свойстве появляется перед отформатированным кодом в отчете.

Атрибуты:

GetAccess
public
SetAccess
public

Источник шаблона для этого генератора отчетов, заданного одним из этих способов:

  • Вектор символов или строковый скаляр, который задает путь файла, который содержит шаблон для этого генератора отчетов

  • Генератор отчетов или отчет, шаблон которого используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

  • Документ DOM или часть документа, шаблон которой используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

Заданный шаблон должен быть тем же типом как отчет, к которому добавлен этот генератор отчетов. Например, для Microsoft® Отчет Word, TemplateSrc должен быть шаблон генератора отчетов Word. Если TemplateSrc свойство пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию для выходного типа отчета.

Атрибуты:

GetAccess
public
SetAccess
public

Имя шаблона для этого генератора отчетов в виде вектора символов или строкового скаляра. Шаблон для этого генератора отчетов должен быть в библиотеке шаблонов шаблона, заданного TemplateSrc свойство этого генератора отчетов.

Атрибуты:

GetAccess
public
SetAccess
public

Цель гиперссылки для этого генератора отчетов в виде вектора символов или строкового скаляра, который задает ID цели ссылки или mlreportgen.dom.LinkTarget объект. Значение вектора символов или строкового скаляра преобразовано в LinkTarget объект. Цель ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.

Атрибуты:

GetAccess
public
SetAccess
public

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

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

Импортируйте пакеты API Отчета так, чтобы вы не использовали долго, полностью определенные имена классов.

import mlreportgen.report.*
import slreportgen.report.*

Создайте отчет.

rpt = slreportgen.report.Report("output","pdf");

Загрузите модель, которая имеет Функциональный блок C.

model_name = "slrgex_cfunction";
cFcnObj = "slrgex_cfunction/C Function";
load_system(model_name);

Создайте генератор отчетов главы.

chapter = Chapter(cFcnObj);

Создайте генератор отчетов Функционального блока C. По умолчанию генератор отчетов включает Выходной Код, Запустите Код, Оконечный Код, и параметры Символов, а также любые другие параметры блоков в отчете. Оконечный параметр Кода Функционального блока C в этом примере пуст.

rptr = CFunction(cFcnObj);

Добавьте генератор отчетов Функции C в главу и главу к отчету.

append(chapter,rptr);
append(rpt,chapter);

Закройте и просмотрите отчет.

close(rpt);
close_system(model_name);
rptview(rpt);

Вот информация о Функциональном блоке C в отчете:

Смотрите также

| | |

Темы

Введенный в R2021b

Документация Simulink Report Generator

Поддержка