ArchiveTemplateItem

<< Click to Display Table of Contents >>

Navigation:  Интерфейс редактора проекта > Операции в редакторе проекта > Скрипт C# > Объектная модель, классы, их свойства и методы >

ArchiveTemplateItem

Тип ArchiveTemplateItem соответствует элементу Шаблон архивирования.

Унаследован от класса Item.

Общие свойства для всех элементов (класса Item) смотрите в соответствующем разделе.

Свойства и методы, характерные для ArchiveTemplateItem, представлены в таблице:

Название

Значение свойства

Описание

Пример использования

Свойства (Properties)

 

Deadband

Мертвая зона. Соответствует свойству Мертвая зона в Панели свойств в категории Параметры архивирования.

Методы доступа: get/set

// Находим тег

var tag = (TagItem)RootItemModel.GetChildByNamePath("Объекты.obj.tag");

// Выводим в консоль, делаем проверку на null, задаем шаблон архивирования

this.WriteConsole("шаблон архивирования");

this.WriteConsole(": " + tag?. ?? "null");

tag.ArchiveTemplateType = "Шаблон архивирования 1";

this.WriteConsole(": " + tag?. ?? "null");

 

// Проверка на null

var arhTmp = tag?.ArchiveTemplate;

// Задаем свойства

arhTmp.Deadband = "1";

arhTmp.MaxWritePeriod = "2";

arhTmp.MinWritePeriod = "3";

arhTmp.WriteAll = false;

arhTmp.WriteByChange = true;

arhTmp.WriteOnShutdown = true;

 

// Вывод свойств

this.WriteConsole("arhTmp.Deadband: " + arhTmp.Deadband);

this.WriteConsole("arhTmp.MaxWritePeriod: " + arhTmp.MaxWritePeriod);

this.WriteConsole("arhTmp.MinWritePeriod: " + arhTmp.MinWritePeriod);

this.WriteConsole("arhTmp.WriteAll: " + arhTmp.WriteAll);

this.WriteConsole("arhTmp.WriteByChange: " + arhTmp.WriteByChange);

this.WriteConsole("arhTmp.WriteOnShutdown: " + arhTmp.WriteOnShutdown);

this.WriteConsole("");

MaxWritePeriod

Максимальный период записи. Соответствует свойству Максимальный период записи в Панели свойств в категории Параметры архивирования.

Методы доступа: get/set

MinWritePeriod

Минимальный период записи. Соответствует свойству Минимальный период записи в Панели свойств в категории Параметры архивирования.

Методы доступа: get/set

WriteAll

Все значения. Соответствует свойству Все значения в Панели свойств в категории Параметры архивирования.

Методы доступа: get/set

WriteByChange

Запись по изменению. Соответствует свойству Запись по изменению в Панели свойств в категории Параметры архивирования.

Методы доступа: get/set

WriteOnShutdown

Запись при останове. Тип свойства - bool. Соответствует свойству Запись при останове в Панели свойств в категории Параметры архивирования.

Методы доступа: get/set

Для свойств Шаблона архивирования рекомендуется делать проверку свойств на null перед обращением, для избежания исключений.