Проект Ананас. Справочное руководство по библиотеке ananaslib

0.9.5

В Справочном руководстве приведено описание классов, составляющих ядро системы Ананас. Документ предназначен для использования в качестве Справочника по интерфейсу прикладного программирования Ананаса. Интерфейс предоставляет доступ к управлению метаданными Ананаса, данными, хранящимися в базе данных, прикладными объектами системы. Справочное руководство предназначено для программистов. Пользовательское описание системы Ананас содержится в Руководстве пользователя.

Введение

Ананас - вольная платформа, обеспечивающая ускоренное создание приложений автоматизации учетной деятельности, бизнес процессов организаций и компаний, работающих в различных сферах деятельности. Библиотека ananaslib, являясь частью платформы Ананас, обеспечивает удобный и понятный доступ к реализованным в системе функциям, для программ на языке программирования С++. Настоящее справочное руководство содержит описание методов доступа.

Основные классы

Класс aDocument

Один из важных аспектов методологии работы Ананаса с данными - управление первичными учетными документами. Для отражения хозяйственных операций Ананас предусматривает их регистрацию с помощью электронных документов. Электронные документы могут иметь произвольную структуру, состоящую из набора полей и одной или нескольких табличных частей. Информация о структуре документов хранится в системе. Управление документами осуществляется через экземпляры класса aDocument.

Класс aCatalogue

Ананас поддерживает ведение баз данных (картотек) произвольной структуры с возможностью классификации/разнесения элементов по иерархически организованным группам. Типичным примером использования этой возможности является ведение Каталога товаров, Справочника контрагентов, Реестра сотрудников. Унифицированный интерфейс доступа к таким базам данных (картотекам) обеспечивает класс aCatalogue.

Класс aDocJournal

Все электронные документы, хранящиеся в базе данных Ананаса, регистрируются системой в момент их создания в журнале документов. Для работы с журналом документов используется класс aDocJournal.

Класс aIRegister, aARegister

Ананас поддерживает ведение Регистров. Регисты служат для хронологической записи информации. В системе существует два типа регистров: информационные и накопительные. Накопительный, отличается от информационного поддержкой автоматически пересчитываемых остатков по разрезам учета. Для работы с информационными регистрами используется класс aIRegister. Для работы с накопительными - aARegister.

Класс aCfg

Ананас разработан с учетом требований адаптируемости к различным сферам учетной деятельности. Для этих целей поддерживается работа с произвольно настраиваемыми структурами данных. Такой подход требует хранения информации, описывающей структуры данных. Такую информацию принято называть метаданными. Для управления структурами данных и для работы с метаданными используется класс aCfg.

Класс aForm

Все бизнес объекты Ананаса, атрибуты которых может редактировать пользователь, имеют хотя бы одну экранную форму, работая с которой, пользователь осуществляет изменение значений атрибутов бизнес объектов. Класс aForm предоставляет набор методов, предназначенных для использования Ананас.Скриптом модуля экранной формы бизнес объекта Ананаса. Проектируя и программируя пользовательский интерфейс (Presentation layer) бизнес схемы Ананаса разработчик имеет дело с объектами класса aForm и расположенными в них виджетами.

Документация по Ananas Library. Последние изменения: Mon Jul 14 11:53:52 2008. Создано системой  doxygen 1.5.5