Описание API

1. Общие сведения об объектной модели данных
2. Пример низкоуровневого интерфейса
3. Функции для работы с хранилищем
4. Высокоуровневый интерфейс

Высокие темпы развития компьютерной техники, существующие в настоящее время, приводят к компьютеризации все более новых отраслей человеческой деятельности. С ростом производительности вычислительных средств увеличивается и сложность решаемых ими задач, а значит, и сложность используемых моделей данных. Широко распространенные в настоящее время реляционные модели, ориентированные на машинное представление данных, уже не позволяют описать реальный мир с необходимым уровнем детализации. На смену реляционным методам моделирования приходят объектно-ориентированные, которые изначально предназначены для описания не машинного, а реального мира. Однако простота информационного моделирования в терминах объектно-ориентированного анализа оборачивается усложнением обработки объектных данных. Объектно-ориентированной методологии, адекватной реляционной алгебре, в настоящее время не существует. Тем не менее, богатые возможности обработки объектных данных заставляют мириться со сложностями и искать новые пути использования объектов.

Одной их областей, использующих довольно сложные информационные модели, является управление машиностроительным производством, основой для которого служит описание сложного изделия управляемой конфигурации. Современное высокотехнологическое изделие уже давно не определяется только статической геометрией. Оно может изменяться во времени, иметь громадное число модификаций и вариантов комплектации, и его можно описать с различных точек зрения различным числом взаимосвязанных моделей. Сложность описания высокотехнологического изделия настолько велика, что разработка стандарта на электронное представление данных об изделии ISO 10303 (STEP) потребовала создания специального объектно-ориентированного языка информационного моделирования – EXPRESS (ISO 10303-11). Данный язык оказался настолько удачным, что его стали использовать в целом ряде далеких от машиностроения прикладных областях. Кроме того, в настоящее время его описание переведено на русский язык и выпущено как российский стандарт ГОСТ Р ИСО 10303-11.

1. Общие сведения об объектной модели данных

Информационная модель (словарь данных) на языке EXPRESS состоит из объектов (ENTITY) и их атрибутов (ATTR) (Рис. 1) . В качестве значений атрибутов могут выступать как значения простых типов (INTEGER, REAL, STRING, BOOLEAN и т.д.), так и ссылки на экземпляры других объектов. Кроме того значения атрибутов могут быть списками (ARRAY, SET, LIST и BAG) других значений. Между объектами могут устанавливаться отношения наследования как единичного, так и множественного. Экземпляры объектов INSTANCE, которые могут объединяться в группы, называемые EXTENT. Каждый INSTANCE имеет свой уникальный идентификатор, который определяет не только атрибуты данного экземпляра, но и его тип.

Рис. 1. Взаимосвязь объектов словаря и данных

Язык EXPRESS имеет как текстовую, так и графическую нотацию. Графическая более удобна для восприятия человеком, но не позволяет отобразить все аспекты модели данных. В текстовой нотации можно описать не только модель данных, но и ограничения целостности данных и правила проверки их корректности. В некотором смысле текстовое описание модели данных на языке EXPRESS аналогично заголовочному файлу в программе на C++. Они определяют объекты, их атрибуты и связи между объектами. Например:

В графической нотации, называемой EXPRESS-G, объекты отображаются в виде прямоугольников, внутри которых указывется имя объекта (рис.2). Атрибуты обозначаются тонкими линиями с именем атрибута и кружком на конце линии рядом с типом атрибута, в качестве которого могут выступать другие объекты или условные обозначения простых типов. Отношения наследования отображаются жирными линиями и кружком рядом с объектом — потомком.

Рис. 2. Модель данных в нотации EXPRESS-G

Следует заметить, что в данных примерах приведены только самые общие моменты информационного моделирования на языке EXPRESS, возможности которого гораздо богаче. Эти возможности настолько обширны, что далеко не все схемы данных, описанные на нем, можно напрямую транслировать в С++.

Для работы с элементами словаря данных в API системы PSS используются специальные классы:

2. Пример низкоуровневого интерфейса

Низкоуровневый API системы PSS представляет собой реализацию SDAI для языка С (ISO 10303-24). Для удобства работы функции данного стандарта обернуты в оболочку (класс CaplStepData), а у части функций устранен ряд параметров (например, идентификатор сессии, который не передается функции, а берется ей из класса-оболочки. У функций отсутствует префикс sdai (принадлежность функций к низкоуровневому API видна не за счет префикса, а за счет принадлежности классу CaplStepData). Для удаленной работы с базой данных в API системы PSS существует класс CaplNetStepData, который наследует функциональность CaplStepData и дополняет ее сетевыми функциями (Connect, Disconnect, SaveChanges и др.). Все функции работающие с сетью имеют префикс «NET_».

Все функции SDAI используют понятие идентификатора. Каждый экземпляр объекта имеет свой уникальный идентификатор, присваиваемый ему при создании. Для создания объекта используется функция CreateInstanceBN, которой передается имя создаваемого объекта (имя ENTITY), а возвращает она указатель на класс CaplInstance, поле «id» которого содержит идентификатор созданного экземпляра объекта (INSTANCE).

Задавать значение атрибутов любого INSTANCE можно с помощью функции sdaiPutAttrBN, а читать с помощью функции GetAttrBN. Этим функциям передается идентификатор INSTANCE, имя атрибута и адрес памяти по которому считывется значение (PutAttrBN) или в который записывается значение (GetAttrBN). Обе функции возвращают код ошибки или ноль в случае корректного выполнения. Удаляет объекты функция DeleteInstance, единственным параметром которой является идентификатор удаляемого INSTANCE. Для любого INSTANCE с помощью функции IsKindOfBN, которой передается идентификатор, можно узнать, является ли его тип наследником другого типа объекта и имя типа. Получить список экземпляров объектов (instance) определенного типа можно с помощью функции GetEntityExtentBN, передав ей имя ENTITY. Данная функция возвращает список INSTANCE как переданного ей типа, так и его потомков. Вот, пожалуй, и весь минимальный набор функций, необходимых для работы с объектно-ориентированными данными без привязки к какой-либо схеме данных.

Описание всех перечисленных функций в языке СИ будет выглядеть следующим образом:

CaplInstance  *CreateInstanceBN (const char *type_name); 
// создает Instanсе типа type_name

bool  DeleteInstance (CaplInstance  *inst);
// удаляет inst из БД

bool GetEntityExtentBN (const char *ent_name, aplExtent &extent);
// возвращает в extent набор Instance типа ent_name

bool GetAttrBN (CaplInstance *inst, const char *attr_name, CaplValue *value);
// возвращает в value значение атрибута attr_name взятого у inst

bool PutAttrBN (CaplInstance * inst, const char *attr_name, CaplValue value);
// записывает в inst значение value как значение атрибута attr_name

bool IsKindOfBN (CaplInstance  *inst, const char *type_name);
// возвращает true если inst является экземпляром типа

Использование SDAI можно проиллюстрировать на следующем примере:

В базе данных, построенной по вышеописанной модели (см. рис.2) необходимо все цветные точки сместить влево по оси X на 5, а все остальные точки, находящиеся выше прямой Y=3, сместить вверх на 7. Программа, выполняющая данную операцию, имеет вид:

#include <aplNetStepData.h> // включение описания функций SDAI

…

int i=0; // счетчик

int x,y; // координаты

aplExtent ext;  // массив для всех точек

CaplInstance *inst; // идентификатор INSTANCE

CaplStepData data;  // класс для работы с данными INSTANCE

data.LoadFromFile(“data.stp”);  // открытие файла сданными

data.GetEntityExtentBN(“point”,&ext);  // чтение списка всех точек

for(i=0 ;i<ext.GetSize();++i) // цикл по i-м элементам списка

{

    inst=ext[i]; // получение i-го элемента списка

    if(data.IsKindOfBN(inst,”colorpoint”)) // i-я точка является цветной

    {

        data.GetAttrBN(inst,”x”, &x); // чтение координаты x для i-й точки

        x-=5;   // смещение точки влево по оси X на 5

        data.PutAttrBN(inst,”x”, x); // запись новой  координаты x для i-й точки

    }

    else     // i-я точка не является цветной

    {

        data.GetAttrBN(inst,”y”, &y); // чтение координаты y i-й точки

        if(y>3)   // если точка выше Y=3

        {

            y+=7; // смещение точки вверх по оси Y на 7

            data.PutAttrBN(inst,”y”,y); // запись новой  координаты y i-й точки

        }

    }

}

data.sdaiSaveChanges(); // сохранение изменений (завершение транзакции)

В данной программе помимо проверок на ошибки используется большое число строковых операций. Каждое чтение атрибута или проверка на тип приводит к поиску переданного имени атрибута в словаре. Однако каждому элементу словаря данных в классе CaplStepData соответствует экземпляр определенного класса (CaplEntity или CaplAttr). Ссылки на экземпляры данных классов можно использовать вместо задания имен объектов, а получить их можно с помощью функций:

CaplEntity *GetEntityBN (char *name);
// получение ENTITY по его имени

CaplAttr *GetAttrDefinitionBN(char *entity_name, char *attr_name);
// получение идентификатора атрибута по его имени и имени ENTITY.

CaplAttr *GetAttrDefinition(CaplEntity *entity, char *attr_name);
// получение идентификатора атрибута по его имени и элементу словаря.

Вызывать данные функции можно только после открытия файла с данными или установки соединения с базой данных.

Большая часть функций SDAI существуют в двух вариантах: для использования элементов словаря и для использования их имен. Функции использующие имена заканчиваются на BN (By Name), а функции использующие идентификаторы таких окончаний не имеют.

При использовании идентификаторов вместо имен приведенная выше программа будет иметь вид:

#include <aplNetStepData.h> // включение описания функций SDAI

…

int i=0; // счетчик

int x,y; // координаты

aplExtent ext; // массив для всех точек

CaplInstance *inst; // идентификатор INSTANCE

CaplStepData data; // класс для работы с данными INSTANCE

data.LoadFromFile("data.stp"); // открытие файла сданными
// получение элементов словаря

CaplEntity *ent_point=data.GetEntityBN("point"); // идентификатор объекта point

CaplEntity *ent_colorpoint= data.GetEntityBN("color_point"); // идентификатор объекта color_point

CaplAttr *a_point_x= data.GetAttrDefinition(ent_point, "x"); // идентификатор атрибута x

CaplAttr *a_point_y= data.GetAttrDefinition(ent_point, "y"); // идентификатор атрибута у

data.GetEntityExtent(ent_point, &ext); // чтение списка всех точек

for (i=0 ; i<ext. GetSize( ); ++i)  // цикл по i-м элементам списка

{

    inst=ext[i]; // получение i-го элемента списка

    if(data.IsKindOf(inst, ent_colorpoint)) // i-я точка является цветной

    {

        // чтение координаты x i-й точки

        data.GetAttr(inst, a_point_x, &x);

        x-=5; // смещение точки влево по оси X на 5

        // запись новой координаты x i-й точки

        data.PutAttr(inst, a_point_x, x);

    }

    else // i-я точка не является цветной

    {

        // чтение координаты y i-й точки

        data.GetAttr(inst, a_point_y, &y);

        if(y>3) // если точка выше Y=3

        {

            y+=7; // смещение точки вверх по оси Y на 7

            // запись новой координаты y i-й точки

            data.PutAttr(inst, a_point_y, y);

        }

    }

}

data.SaveChanges(); // сохранение изменений (завершение транзакции) 

Вариант программы использующий идентификаторы будет работать гораздо быстрее за счет сокращения числа строковых операций выполняемых в цикле. Но это только один аспект быстродействия SDAI­-программ. Другим, не менее важным аспектом является способ работы в сети. Если для чтения или записи каждого атрибута каждого объекта обращаться к базе данных через сеть, то это приведет к значительным накладным расходам. Более удобно считывать или записывать сразу по несколько значений атрибутов. Такую работу можно довольно легко организовать используя механизмы кэширования данных на клиенте.

3. Функции для работы с хранилищем

Для работы с базой данных по сети в API PSS существует класс CaplNetStepData являющийся потомком CaplStepData.

Для работы с удаленной базой данных необходимо установить соединение с помощью функции NET_Connect(…). При установке соединения на клиенте создается кэш данных. Все изменения (функции PutAttr, CreateInstance и DeleteInstance) проводятся в кэше аналогично работе с файлом. Сохранение изменений в БД происходит при вызове функции NET_SaveChanges(). Разрыв связи осуществляется с помощью функции NET_Disconnect(). При разрыве связи все изменения, произошедшие после последнего вызова NET_SaveChanges(), теряются.

Чтение данных функциями GetAttr и GetEntityExtent осуществляется из кэша. Если установить режим автоматической докачки данных (по умолчанию он выключен) вызовом функции SetAutoDownloadMode(true), то при чтении атрибута (функция GetAttr) его значение будет при отсутствии в кэше закачено к кэш. Работать в таком режиме не рекомендуется, так как он сильно снижает быстродействие.

Данные могут быть закачены в кэш принудительно с помощью класса СaplLoadData, но в большинстве случаев этого не требуется, так как все функции высокоуровневого API PSS (менеджеров) все необходимые данные закачивают в кэш автоматически. Например, после вызова функции получения состава изделия все атрибуты всех входящих в изделие компонент будут закачены в кэш.

4. Высокоуровневый интерфейс

Для удобства работы в API PSS существует класс CaplAPI, который инкапсулирует в себе экземпляры класса источника данных (CaplNetStepData) и все менеджеры. Данный класс содержит функции Connect() и Disconnect(), которые помимо установки (разрыва) связи инициализируют все менеджеры, ассоциируя их с содержащимся в CaplAPI источником данных.

При использовании класса CaplAPI каркас приложения выглядит следующим образом: