Сообщество программистов Autodesk в СНГ :: Использование объекта DataStorage для хранения настроек

Сообщество программистов Autodesk в СНГ
Revit API
Использование объекта DataStorage для хранения настроек

13/07/2014

Использование объекта DataStorage для хранения настроек

У разработчиков часто возникает вопрос, где хранить настройки приложения либо другую информацию, которая привязана к конкретной модели.

Традиционно для этих целей использовались общие параметры, затем, расширяемая область хранения Extensible Storage. Но у обоих вариантов возникала проблема, какой элемент нужно использовать для хранения параметра или к какому применить расширяемую область. Одним из вариантов – использовать элемент ProjectInfo, содержащий в себе информацию о проекте.

Однако, при совместной работе над проектом часто возникает ситуация, когда один из пользователей заблокировал этот элемент для изменения, например, когда элементарно поменял настройки проекта.

В Revit 2013 API для этих целей появился специальный объект – DataStorage. Объект наследуется от класса Element, а, следовательно, его можно и нужно использовать для хранения расширяемой области хранения.

DataStorage не доступен пользователям. Только через API. А значит, действия пользователя не повлияют на блокировки этого элемента.

Рассмотрим пример использования DataStorage.

Так как для хранения необходимо использовать расширяемую область хранения, то, первым делом необходимо создать схему, которая будет содержать поля, в которых будет храниться ваши настройки.

Код - C#: [Выделить]

 
    public static class AdnCisSampleSchema
    {
        private readonly static Guid schemaId =
            new Guid("B08287CD-BB06-47AC-88E0-705D5411F962");
 
        public static Schema GetSchema()
        {
            //Смотрим, Загружена ли схема в память или нет
            Schema schema = Schema.Lookup(schemaId);
            if (schema != null)
                return schema; // возвращаем схему, если она уже созадна и загружена
 
            // Создаем схему, если ее еще нет.
            SchemaBuilder schemaBuilder = new SchemaBuilder(schemaId);
 
            // Схема будет содержать одно поле
            // в котором хранится URL
            schemaBuilder
                .SetSchemaName("MyAddinSettings")
                .AddSimpleField("SiteURL", typeof (string));
 
            return schemaBuilder.Finish();
        }
    }

Создадим две команды. В первой мы запишем в наш объект наши настройки. Во второй, прочитаем записанные настройки.

При первоначальной записи наш объект DataStorage еще не создан в проекте и нам необходимо его создать. При последующей же записи, нам нужно получить существующий DataStorage, который содержит настройки. Получить существующий объект нам будет необходимо так же и при сохранении.

Для удобства, создадим вспомогательный класс, для поиска нашего DataStorage. В случае, если его нет, он будет создан.

Так как DataStorage наследуется от класса Element, то применим старый добрый FilteredElementCollector для поиска элементов с фильтрацией по типу класса:

Код - C#: [Выделить]

            var dataStorages = new FilteredElementCollector(_document)
                .OfClass(typeof (DataStorage))
                .OfType<DataStorage>()
                .ToList();

Данный код вернет нам все элементы типа DataStorage в документе. Объектов может быть несколько. Всегда помните об этом. Из всех надо выбрать именно тот, который нужно вам и который хранит именно ваши настройки.

Это можно сделать, попробовав получить сущность Entity, в которой хранится ваши настройки, т.е. получить сущность с вашей схемой.

Код - C#: [Выделить]

            foreach (var dataStorage in dataStorages)
            {
                var entity = dataStorage.GetEntity(AdnCisSampleSchema.GetSchema());
                if (entity != null && entity.IsValid())
                    return dataStorage;
            }

Если объект не найден – создаем новый:

Код - C#: [Выделить]

DataStorage storage = DataStorage.Create(_document);

После того, как мы получили наш объект, мы можем в него записать наши данные.

Для этого нам надо создать объект Entity, и записать туда данные, согласно нашей созданной ранее схеме. Затем, записать эту сущность в объект DataStorage.

Код - C#: [Выделить]

            var dataStorage = GetDataStorage();
 
            Entity entity = new Entity(AdnCisSampleSchema.GetSchema());
 
            entity.Set("SiteURL", url);
 
            dataStorage.SetEntity(entity);

Для чтения наших настроек, нужно также получить объект DataStorage, который хранит наши настройки, взять сущность нашей схемы, и прочитать из нее соответствующее поле.

Код - C#: [Выделить]

            var dataStorage = GetDataStorage(true);
 
            if (dataStorage == null)
                return null;
 
            var entity = dataStorage.GetEntity(AdnCisSampleSchema.GetSchema());
 
            if (entity == null)
                return null;
 
            var url = entity.Get<string>("SiteURL");
 
            return url;

Полный код класса для чтения/записи настроек:

Код - C#: [Выделить]

    class AdnSettingsDataStorageHelper
    {
        private readonly Document _document;
 
        public AdnSettingsDataStorageHelper(Document document)
        {
            _document = document;
        }
 
        public void WriteURL(string url)
        {
            var dataStorage = GetDataStorage(true);
 
            Entity entity = new Entity(AdnCisSampleSchema.GetSchema());
 
            entity.Set("SiteURL", url);
 
            dataStorage.SetEntity(entity);
        }
 
        public string ReadURL()
        {
            var dataStorage = GetDataStorage();
 
            if (dataStorage == null)
                return null;
 
            var entity = dataStorage.GetEntity(AdnCisSampleSchema.GetSchema());
 
            if (entity == null)
                return null;
 
            var url = entity.Get<string>("SiteURL");
 
            return url;
        }
 
        /// <summary>
        /// метод ищет в документе объект DataStorage,
        /// в котором хранятся наши нстройки.
        /// В случае, если его нет, то он будет создан.
        /// </summary>
        /// <returns></returns>
        private DataStorage GetDataStorage(bool createIfNotExists = false)
        {
            // DataStorage является Element/
            // Для поиска элементов как и прежде используем
            // FilteredElementColector
 
            var dataStorages = new FilteredElementCollector(_document)
                .OfClass(typeof (DataStorage))
                .OfType<DataStorage>()
                .ToList();
 
            foreach (var dataStorage in dataStorages)
            {
                var entity = dataStorage.GetEntity(AdnCisSampleSchema.GetSchema());
                if (entity != null && entity.IsValid())
                    return dataStorage;
            }
 
            if (!createIfNotExists)
                return null;
 
            // попадаем сюда, если объект не был найден.
            // Создаем новый
            DataStorage storage = DataStorage.Create(_document);
 
            return storage;
        }
    }

И коды команд для сохранения и чтения настроек. Код довольно прост.

Сохранение настроек:

Код - C#: [Выделить]

    [Transaction(TransactionMode.Manual)]
    public class CommandWriteSettings : IExternalCommand
    {
        public Result Execute(
          ExternalCommandData commandData,
          ref string message,
          ElementSet elements)
        {
            var doc = commandData.Application.ActiveUIDocument.Document;
 
            using (Transaction trans = new Transaction(doc,"Сохранение настроек"))
            {
                trans.Start();
 
                AdnSettingsDataStorageHelper settingsDataStorageHelper =
                    new AdnSettingsDataStorageHelper(doc);
 
                settingsDataStorageHelper.WriteURL("http://adn-cis.org");
 
                var res = trans.Commit();
 
                if (res == TransactionStatus.Committed)
                    TaskDialog.Show("ADN-CIS", "Настройки сохранены");
            }
 
            return Result.Succeeded;
        }
    }

И чтение:

Код - C#: [Выделить]

    [Transaction(TransactionMode.Manual)]
    public class CommandReadSettings : IExternalCommand
    {
        public Result Execute(
            ExternalCommandData commandData,
            ref string message,
            ElementSet elements)
        {
            var doc = commandData.Application.ActiveUIDocument.Document;
 
            AdnSettingsDataStorageHelper settingsDataStorageHelper =
                   new AdnSettingsDataStorageHelper(doc);
 
            var url = settingsDataStorageHelper.ReadURL();
 
            if (url == null)
                TaskDialog.Show("ADN-CIS", "Настройки не заданы");
 
            else
                TaskDialog.Show("ADN-CIS", string.Format("Значение URL: {0}", url));
                    
           
 
            return Result.Succeeded;
        }
    }