 | Руководство VisiCAR™ Developer |
| ||||
| ||||
| << 1.9 Языковые средства | Оглавление | 1.11 Применение >> | ||
1.10 Описание встроенных процедур и функций, а также свойств и методов источников данных
На этапе проектирования отчетов есть возможность использовать различные процедуры , функции, методы, переменные и свойства для построения отчета. Переменные описывать не надо, они имеют тип Variant.
Переменную из скрипта можно использовать в объектах, и наоборот, переменную из списка переменных можно использовать в скрипте. Можно обращаться к переменным, определенным в словаре данных, к системным переменным, а также к свойствам (при использовании источников данных). В зависимости от выбранных источников данных будут доступны соответствующие свойства и методы. Переменные могут содержать в имени недопустимые с точки зрения синтаксиса символы (например, системная переменная Page#). Обращаться к таким переменным следует с использованием квадратных скобок:
Встроенные переменные и функции.
Могут применяться в бэндах ReportSummary, PageFooter, MasterFooter, DetailFooter, SubdetailFooter, GroupFooter, CrossFooter.
* Sum(AnsiString [,AnsiString] [,1])
Вычисление суммы.
Параметры:
AnsiString - выражение, сумму которого необходимо посчитать;
AnsiString - название бэнда (не обязательный параметр);
Возвращаемые значения:
Сумма выражения.
Комментарии:
Вычисляет сумму выражения для ряда строк данных. Если параметр [,AnsiString] не задан, то сумма считается по строке данных, соответствующей данному бэнду (по бэндам MasterData, DetailData, SubdetailData); иначе сумма считается только по бэнду с именем [,AnsiString] . Если в расчет надо включить невидимые бэнды, надо указывать третий параметр (1).
Пример:
Sum([Part total], Band1);
Sum([[Part total] + [Part price]]);
Sum([Part total], Band1, 1).
* Avg(AnsiString [,AnsiString] [,1])
Вычисление среднего значения.
Параметры:
AnsiString - выражение для вычисления среднего значения;
AnsiString - название бэнда (не обязательный параметр);
Возвращаемые значения:
Среднее значение выражения.
Комментарии:
Работает аналогично функции Sum().
* Min(AnsiString [,AnsiString] [,1])
Вычисление минимума.
Параметры:
AnsiString - ряд для вычисления минимума;
AnsiString - название бэнда (не обязательный параметр);
Возвращаемые значения:
Минимум выражения.
Комментарии:
Работает аналогично функции Sum().
* Max(AnsiString [,AnsiString] [,1])
Вычисление максимума.
Параметры:
AnsiString - ряд для вычисления максимума;
AnsiString - название бэнда (не обязательный параметр);
Возвращаемые значения:
Минимум выражения.
Комментарии:
Работает аналогично функции Sum()
Получить количество строк данных.
Параметры:
AnsiString - название бэнда;
Возвращаемые значения:
Количество строк данных..
Пример:
Count(Band1).
Преобразует число в строку.
Параметры:
int- число, которое необходимо преобразовать;
Возвращаемые значения:
Строка.
* Copy(AnsiString, AnsiString, int)
Возвращает подстроку .
Параметры:
AnsiString - строка, из которой необходимо выделить подстроку;
AnsiString - символ, с которого необходимо начать выделение подстроки (этот символ в подстроку не входит).
int- количество символов, которые необходимо выделить из строки.
Возвращаемые значения:
Выделенная подстрока.
Комментарии:
Из строки выделяется необходимая подстрока необходимой длинны.
* If(AnsiString, AnsiString, AnsiString)
Получить строку в зависимости от истинности или ложности условия.
Параметры:
AnsiString - строка условия, в зависимости от истинности или ложности которого будет получена соответствующая строка;
AnsiString - Строка1, которая будет получена, если условие истинно;
AnsiString - Строка2, которая будет получена, если условие ложно.
Возвращаемые значения:
Строка1 или Строка2.
* FormatFloat(AnsiString, int)
Преобразует числовое значение в строку.
Параметры:
AnsiString - строка форматирования.
int- число, которое необходимо отформатировать.
Возвращаемые значения:
Строка (отформатированное число).
Комментарии:
Преобразует числовое значение в строку, используя форматирование.
* FormatDateTime(AnsiString , TDateTime)
Преобразует дату/время.
Параметры:
AnsiString - строка форматирования.
TDateTime - значение даты и времени, которое необходимо отформатировать.
Возвращаемые значения:
Строка (отформатированное значение даты и времени).
Комментарии:
Преобразует дату/время в строку, используя форматирование.
Преобразует строку в дату.
Параметры:
AnsiString - строка, которую необходимо преобразовать.
Возвращаемые значения:
Дата.
Комментарии:
Преобразует строку в дату, используя стандартное форматирование.
Преобразует строку во время.
Параметры:
AnsiString - строка, которую необходимо преобразовать.
Возвращаемые значения:
Время.
Комментарии:
Преобразует строку во время, используя стандартное форматирование.
Преобразует символы строки в верхний регистр.
Параметры:
AnsiString - строка, которую необходимо преобразовать.
Возвращаемые значения:
Отформатированная строка.
Преобразует символы строки в нижний регистр.
Параметры:
AnsiString - строка, которую необходимо преобразовать.
Возвращаемые значения:
Отформатированная строка.
Преобразует символы строки в нижний регистр, а первый символ - в верхний.
Параметры:
AnsiString - строка, которую необходимо преобразовать.
Возвращаемые значения:
Отформатированная строка.
Возвращает длину строки.
Параметры:
AnsiString - строка, длину которой необходимо вычислить.
Возвращаемые значения:
Длинна строки.
Отбрасывает пробелы в начале и в конце строки и возвращает результат.
Параметры:
AnsiString - строка, которую необходимо преобразовать.
Возвращаемые значения:
Отформатированная строка.
Возвращает позицию подстроки в строке.
Параметры:
AnsiString - подстрока, позицию которой необходимо вычислить;
AnsiString - строка, позицию подстроки в которой необходимо вычислить.
Возвращаемые значения:
Позиция подстроки.
Возвращает целую часть числа value.
Параметры:
Int - число, целую часть которого необходимо вернуть;
Возвращаемые значения:
Целая часть числа.
Возвращает дробную часть числа.
Параметры:
Int - число, дробную часть которого необходимо вернуть;
Возвращаемые значения:
Дробная часть числа.
Возвращает округленное значение.
Параметры:
Int - число, округленное значение которого необходимо вернуть;
Возвращаемые значения:
Округленное значение числа.
Возвращает остаток от деления числа на число.
Параметры:
Int - делимое;
Int - делитель.
Возвращаемые значения:
Остаток от деления двух чисел.
Возвращает меньшее из двух чисел.
Параметры:
Int - сравниваемое число1;
Int - сравниваемое число2.
Возвращаемые значения:
Меньше из двух чисел.
Возвращает большее из двух чисел.
Параметры:
Int - сравниваемое число1;
Int - сравниваемое число2.
Возвращаемые значения:
Большее из двух чисел.
В программе существует ограничение
на количество параметров, передаваемых в процедуру или функцию — их
не должно быть больше 3. Для передачи более 3 параметров (например,
для метода void crop(int,int,int,int) источника данных img_process),
необходимо использовать класс ARGS.
Если в аргумент функции или метода можно вернуть какое-либо значение
(на это указывает знак & после аргумента, например, метод void world2pix(double
&,double &) источника данных ) — параметры в такой метод также
необходимо передавать через массив используя класс ARGS.
Пример:
begin
ARGS.clear('a'); //удаление данных массива
ARGS.add('a',10); //формирование массива
ARGS.add('a',20);
ARGS.add('a',fix_archive.X);
ARGS.add('a',fix_archive.Y);
distance:=ARGS.call('MAP_PROJ.distance','a');
//вызываем метод измерения расстояния и передаем ей в качестве параметров элементы массива “а” (4 параметра).
end;
add()
* void add(<array_name>, <item_data>)
Добавляет к массиву элемент данных.
Параметры:
array_name - имя массива, к которому необходимо добавить элемент; item_data - элемент, который необходимо добавить.
Возвращаемые значения:
Нет.
* Variant as_array(<array_name>)
Возвращает массив с именем array_name.
Параметры:
array_name - имя массива.
Возвращаемые значения:
Массив с указанным именем.
* Variant call(<function_name>,<array_name>)
Вызывает функцию и передает ей в качестве
аргумента массив.
Параметры:
function_name - имя функции;
array_name - имя массива.
Возвращаемые значения:
Массив с указанным именем.
Пример:
distance:=ARGS.call('MAP_PROJ.DISTANCE','a');
Удаляет все данные элементов массива.
Параметры:
array_name - имя массива.
Возвращаемые значения:
Нет.
* unsigned int count(<array_name>)
Возвращает количество элементов массива.
Параметры:
array_name - имя массива.
Возвращаемые значения:
Количество элементов массива.
* void fill_Aray(<array_name>,<variant_array>)
Создает массив с именем array_name
и заполняет его элементами из массива variant_array.
Параметры:
array_name - имя создаваемого массива;
variant_array - имя массива, элементами которого будет заполнен новый
массив.
Возвращаемые значения:
Нет.
* Variant get_item(<array_name>, <item_index>)
Возвращает значение элемента массива
array_name с индексом item_index.
Параметры:
array_name - имя создаваемого массива;
item_index - индекс элемента (в массивах номерация начинается с нуля
- 0, 1, 2 ...).
Возвращаемые значения:
Значение єлемента массива.
* void put_item(<array_name>,<item_index>,<data>)
Заменяет значение элемента массива
array_name с индексом item_index на значение data.
Параметры:
array_name - имя массива;
item_index - индекс элемента (в массивах нумерация начинается с нуля
- 0, 1, 2 ...);
data - значение.
Возвращаемые значения:
Нет.
* int
сurY
Возвращает текущую позицию по Y (в пикселах), с которой будет выведен
очередной бэнд. Этому свойству можно также присвоить нужное значение
для смены позиции. Это позволяет строить довольно экзотические отчеты.
* int
freespace
Возвращает высоту оставшегося свободного места на странице в пикселах.
* bool
finalpass
Возвращает истину, если отчет двухпроходный и выполняется последний
проход.
* int
pageheight
Возвращает высоту страницы в пикселах с учетом высоты бэнда Page footer.
* int
pagewidth
Возвращает ширину страницы в пикселах.
* void
stopreport()
Останавлявает построение отчета.
* void
newpage()
Начинает формирование отчета с новой страницы.
* void
newcolumn()
Начинает формирование отчета с новой колонки, если отчет многоколоночный.
* void showband(AnsiString)
Показывает бэнд с указанным именем.
Параметры:
AnsiString - название бэнда.
Возвращаемые значения:
Нет.
* void input(AnsiString [,AnsiString])
Вывод на экран диалогового окна.
Параметры:
AnsiString - заголовок диалогового окна;
AnsiString - строка, появляющаяся в строке ввода (не обязательно).
Возвращаемые значения:
Нет.
Комментарии:
Выводит на экран диалоговое окно с указанным заголовком и строкой ввода. Если задан параметр [,AnsiString], то это значение появится в строке ввода. После ввода пользователя возвращает введенную строку.
* TDataTime dayof(TDataTime)
Возвращает день даты.
Параметры:
TDataTime - дата;
Возвращаемые значения:
День указанной даты.
* TDataTime monthоf(<date>)
Возвращает месяц даты.
Параметры:
TDataTime - дата;
Возвращаемые значения:
Месяц указанной даты.
* TDataTime yearof(<date>)
Возвращает год даты.
Параметры:
TDataTime - дата;
Возвращаемые значения:
Год указанной даты.
* int messagebox(AnsiString, AnsiString, <buttons_and_icons>)
Выводит стандартное окно диалога с текстом и заголовком.
Параметры:
AnsiString - текст, который выводится в окне;
AnsiString - заголовок окна;
<buttons_and_icons> - набор кнопок и иконка окна
Возвращаемые значения:
Возвращает значение, соответствующее нажатой кнопке (mrOk, mrCancel, mrYes, mrNo)
Комментарии:
Набор кнопок и иконка окна задается в параметре <buttons_and_icons>. Возвращает значение, соответствующее нажатой кнопке (mrOk, mrCancel, mrYes, mrNo). В качестве <buttons_and_icons> можно использовать следующие значения:
Кнопка |
Иконка |
mb_Ok |
mb_IconError |
mb_OkCancel |
mb_IconQuestion |
mb_YesNo |
mb_IconInformation |
mb_YesNoCancel |
mb_IconWarning |
* int
line#
Возвращает номер строки данных; нумерация начинается с начала группы.
Например:
Master data
1. Detail data
2. Detail data
3. Detail data
Master data
1. Detail data
2. Detail data
* int
linethrough#
Возвращает номер строки данных; нумерация строк начинается с начала
отчета, например:
Master data
1. Detail data
2. Detail data
3. Detail data
Master data
4. Detail data
5. Detail data
* int
column#
Возвращает номер колонки в cross-tab отчете.
* int
current line#
Возвращает номер текущей строки отчета.
* int
Всего страниц
Возвращает общее количество страниц в сформированном отчете. Для использования
этой переменной отчет должен быть двухпроходным.
* TDataTime
date (Дата)
Возвращает дату начала формирования отчета.
* TDataTime
time (Время)
Возвращает время начала формирования отчета.
* int
page# (Страница)
Возвращает номер текущей страницы.
* int
totalpages
Возвращает общее количество страниц в сформированном отчете. Для использования
этой функции отчет должен быть двухпроходным (см. раздел Параметры отчета на
стр. 39.).
Все методы и свойства определенных классов, описанные ниже, доступны для использования при добавлении в отчет соответствующего источника данных. Хранение информации ряда источников данных организовано в виде таблицы. Для получения информации о конкретном событии необходимо переместить “курсор” на нужную позицию, используя методы next_record(), first_record(), set_record. Источники данных:
— current_fix_archive (см. Источник данных: current_fix_archive на стр. 89);
— dataset_functions (см. Источник данных: dataset_functions на стр. 123);
— dataset_props (см. Источник данных: dataset_props на стр. 125);
— datasets_list (см. Источник данных: datasets_list на стр. 129);
— events_archive (см. Источник данных: events_archive на стр. 74);
— fix_archive (см. Источник данных: fix_archive на стр. 79);
— fix_current (см. Источник данных: fix_current на стр. 84);
— fix_last (см. Источник данных: fix_last на стр. 97);
— poll_error (см. Источник данных: poll_error на стр. 111);
— virtual_dataset (см. Источник данных: virtual_dataset на стр. 127);
— table_<имя таблицы> (см. Источник данных: table_<имя таблицы> на стр. 135);
— user (см. Источник данных: user на стр. 151);
— binary_version (см. Источник данных: binary_version на стр. 164);
— plugin_version (см. Источник данных: plugin_version на стр. 162);
— objinf_window (см. Источник данных: objinf_window на стр. 160);
— distance_lines (см. Источник данных: distance_lines на стр. 158)
— map_zone (см. Источник данных: map_zone на стр. 166)
— any_table (см. Источник данных: any_table на стр. 151).
Источник данных, использующийся для пересчета координат мобильного объекта из одной проекции в другую. Это необходимо при перемещении мобильного объекта из карты в одной проекции на карту в другой проекции (например, из одной в области в другую - если карты этих областей соответствуют разным проекциям).
* MapProj*
pj
Возвращает указатель на проекцию, в которой представлены мобильные объекты.
Используется для пересчета координат положения мобильного объекта при
изменении проекции карты.
Параметры не передаются.
Нет
Источник данных: events_archive
Источник данных архива событий. Используя свойства и методы этого источника можно получить доступ к информации о событиях, произошедших в прошлом. Хранение данных источника организовано в виде таблицы.
* AnsiString
add_info
Возвращает дополнительную информацию о произошедшем событии.
* int
cond_id
Возвращает идентификатор произошедшего события.
* AnsiString
condition
Возвращает название произошедшего события.
* double
double_time
Возвращает дату когда произошло событие.
* int
obj_id
Возвращает идентификатор мобильного объекта.
* AnsiString
obj_name
Возвращает имя мобильного объекта.
* TPicture*
picture
Возвращает пиктограмму, используемую для отображения мобильного объекта
на карте.
* TDateTime
time
Возвращает дату когда произошло событие.
* unsigned
int position
Возвращает номер текущей записи.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* std::vector<int>
request_events
Возвращает массив идентификаторов событий, архив которых можно просмотреть.
* std::vector<int>
request_objects
Возвращает массив идентификаторов мобильных объектов, указанных в запросе
(объекты, по которым формировалась выборка из архива).
* TDateTime
request_time_from
Возвращает время начала просмотра архива, указанное в запросе.
* TDateTime
request_time_to
Возвращает время окончания просмотра архива, указанное в запросе.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет, достигнуто ли окончание потока данных и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void close()
Закрыть соединения с сервером.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Прекратить получение данных по данному запросу от сервера. При этом в источнике данных будут доступны только те записи, которые были получены до вызова close(). Их количество можно получить функцией loaded(). Проверить получена ли текущая запись можно функцией is_data_present(). Нет необходимости вызывать close() после получения всех данных, т.к. в этом случае поток данных закрывается самостоятельно.
Смотри также:
* AnsiString condition2str(int)
Получить строку события
Параметры:
int - идентификатор события
Возвращаемые значения:
Событие в виде строки.
* void default_param(TDateTime &,TDateTime &,std::vector<int> &,std::vector<int> &)
Получение параметров источников данных
Параметры:
TDateTime - время “с” (начало периода
просмотра). “0” означает, что время начала просмотра не ограничено;
TDateTime - время “до” (конец просмотра). “0” означает, что время окончания
просмотра не ограничено;
std::vector<int> - массив идентификаторов мобильных объектов;
std::vector<int> - массив идентификаторов событий, архив которых
необходимо просмотреть.
Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры экземпляра источника данных events_archive, установленные по умолчанию. Используется для передачи этих параметров при инициализации экземпляра источника данных из программного кода.
Смотри также:
* void default_param(idataset_ctrl*,Variant &)
Получение параметров по умолчанию источников данных.
Параметры:
idataset_ctrl* - 0 (указатель на
"интерфейс управления источником данных". Зарезервировано. Должен быть
0);
Variant & - ссылка на переменную, в которую будет записаны параметры
по умолчанию источника данных.
Cтруктура возвращаемого значение имеет вид массива: 0-ой элемент – время "с" (“0” означает, что время начала просмотра не ограничено), 1-ый – время "до" (“0” означает, что время окончания просмотра не ограничено), 2-й – массив идентификаторов мобильных объектов, 3-й – массив идентификаторов событий. Пустой массив означает все события.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры экземпляра источника данных events_archive, установленные по умолчанию. Используется для передачи этих параметров при инициализации экземпляра источника данных из программного кода.
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” в таблице источника данных на первую запись.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - номер записи, на которую необходимо переместить “курсор”.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
* const AnsiString & get_error()
Возвращает ошибку в виде строки.
Параметры:
Не передаются.
Возвращаемые значения:
Произошедшая ошибка в виде строки.
Комментарии:
Если в процессе выполнения отчета возникла ошибка – функция вернет эту ошибку в виде строки.
* AnsiString get_object_name(int)
Получить название мобильного объекта.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Название мобильного объекта.
Комментарии:
Позволяет получить название мобильного объекта по его идентификатору.
* void init(const TDateTime &,const TDateTime &,const std::vector<int> &,std::vector<int> &)
Инициализация экземпляра источника данных.
Параметры:
TDateTime - время “с” (начало периода
просмотра архива событий);
TDateTime - время “до” (конец просмотра архива событий);
std::vector<int> - массив идентификаторов мобильных объектов;
std::vector<int> - массив событий, архив которых необходимо просмотреть.
Возвращаемые значения:
Нет.
Комментарии:
Если при проектировании отчета некоторые источники данных не были инициализированы - это можно выполнить из программного кода, используя данный метод. Типовые значения параметров можно получить, вызвав метод default_param(). Для указания параметров пользователем используйте show_dialog().
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* bool is_data_present()
Проверка получения записи..
Параметры:
Не передаются.
Возвращаемые значения:
True - если необходимая запись получена;
False - если необходимая запись не получена.
Комментарии:
Процесс получения записей от сервера занимает какое-то время.
Если экземпляр источника данных инициализируется до выполнения отчёта (если он отмечен в списке источников которые подлежат инициализации), то к моменту выполнения отчёта все записи будут получены.
Если инициализировать источник данных самостоятельно необходимо следить за наличием записи с помощью функции is_data_present(). Чтобы дождаться получения всех записей используйте функцию synchronize().
Смотри также:
* unsigned int loaded()
Возвращает количество загруженных записей.
Параметры:
Не передаются.
Возвращаемые значения:
Число загруженных записей.
Комментарии:
Возвращает количество полученных записей с сервера. Записи загружаются последовательно.
Смотри также:
* bool show_dialog(TDateTime &,TDateTime &,std::vector<int> &,std::vector<int> &)
Отображает диалоговое окно инициализации источника данных.
Параметры:
TDateTime - время “с” (начало периода
просмотра архива событий);
TDateTime - время “до” (конец просмотра архива событий);
std::vector<int> - массив идентификаторов мобильных объектов;
std::vector<int> - массив событий, архив которых просматривается.
В указанных параметрах передаются значения, отображаемые при создании диалогового окна. Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
True - если диалоговое окно создано;
False - если возникала ошибка.
Комментарии:
Этот метод используется для передачи значений, выбранных пользователем, в отчет. Как правило, используется для источников, не инициализированных при создании отчета (см. раздел Создание и удаление отчета на стр. 7.). Полученные параметры передаются в метод init().
Смотри также:
* void synchronize(idataset_ctrl*)
Синхронизация.
Параметры:
idataset_ctrl* - 0.
Возвращаемые значения:
Нет.
Комментарии:
Используется для получения всех необходимых данных после инициализации источника данных из программного кода.
Смотри также:
Позволяет получить доступ к архиву перемещений мобильных объектов. Хранение данных источника организовано в виде таблицы.
* double
X
Возвращает координату Х местоположения мобильного объекта.
* double
Y
Возвращает координату Y местоположения мобильного объекта.
* double
dX
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Х; dX2+dY2=1).
* double
dY
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Y; dX2+dY2=1).
* double
double_time
Возвращает время фиксации координат местоположения мобильного объекта
(в виде числа).
* int
obj_id
Возвращает идентификатор мобильного объекта.
* AnsiString
obj_name
Возвращает название мобильного объекта.
* double
speed
Возвращает скорость движения мобильного объекта.
* TDateTime
time
Возвращает дату фиксации координат местоположения мобильного объекта.
* unsigned
int position()
Возвращает номер текущей записи в выборке.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* std::vector<int>
request_objects
Возвращает массив идентификаторов мобильных объектов, указанных в запросе
(объекты, по которым формировалась выборка из архива).
* TDateTime
request_time_from
Возвращает время начала просмотра архива, указанное в запросе.
* TDateTime
request_time_to
Возвращает время окончания просмотра архива, указанное в запросе.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет, достигнуто ли окончание потока данных и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void close()
Закрыть соединения с сервером.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Прекратить получение данных по данному запросу от сервера. При этом в источнике данных будут доступны только те записи, которые были получены до вызова close(). Их количество можно получить функцией loaded(). Проверить получена ли текущая запись можно функцией is_data_present(). Нет необходимости вызывать close() после получения всех данных, т.к. в этом случае поток данных закрывается самостоятельно.
Смотри также:
* void default_param(TDateTime &,TDateTime &,std::vector<int> &)
Получение параметров источника данных.
Параметры:
TDateTime - время “с” (начало просмотра
архива). “0” означает, что время начала просмотра не ограничено;
TDateTime - время “до” (конец просмотра архива).“0” означает, что время
окончания просмотра не ограничено;
std::vector<int> - массив идентификаторов мобильных объектов.
Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры, установленные по умолчанию для экземпляра источника данных.Эта функция используется для передачи параметров источнику данных при инициализации его из программного кода функцией init().
Смотри также:
* void default_param(idataset_ctrl*,Variant &)
Получить параметры источника данных.
Параметры:
idataset_ctrl* - 0 (указатель на
"интерфейс управления источником данных". Зарезервировано. Должен быть
0.);
Variant & – ссылка на переменную, в которую будет записаны параметры
по умолчанию источника данных. Структура возвращаемого значения имеет
вид массива: 0 элемент – время "с", 1 – время "до", 2 – массив идентификаторов
мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры, установленные по умолчанию для экземпляра источника данных.
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблице источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
* const AnsiString & get_error()
Возвращает ошибку в виде строки.
Параметры:
Не передаются.
Возвращаемые значения:
Произошедшая ошибка в виде строки.
Комментарии:
Если в процессе выполнения отчета возникла ошибка – функция вернет эту ошибку в виде строки.
* AnsiString get_object_name(int)
Получить название мобильного объекта.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Название мобильного объекта.
Комментарии:
Позволяет получить название мобильного объекта по его идентификатору.
* void init(const TDateTime &,const TDateTime &,const std::vector<int> &)
Инициализация экземпляра источника данных.
Параметры:
TDateTime - время “с” (начало периода
просмотра);
TDateTime - время “до” (конец просмотра);
std::vector<int> - массив идентификаторов мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Если при проектировании отчета некоторые источники данных не были инициализированы - это можно выполнить из программного кода, используя данный метод. Типовые значения параметров можно получить, вызвав метод default_param(). Для указания параметров пользователем используйте show_dialog()
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* bool is_data_present()
Проверка получения записи.
Параметры:
Не передаются.
Возвращаемые значения:
True - если необходимая запись получена;
False - если необходимая запись не получена.
Комментарии:
Процесс получения записей от сервера занимает какое-то время.
Если экземпляр источника данных инициализируется до выполнения отчёта (если он отмечен в списке источников которые подлежат инициализации), то к моменту выполнения отчёта все записи будут получены.
Если инициализировать источник данных самостоятельно необходимо следить за наличием записи с помощью функции is_data_present().
Чтобы дождаться получения всех записей используйте функцию synchronize()
Смотри также:
* unsigned int loaded()
Возвращает количество загруженных записей.
Параметры:
Не передаются.
Возвращаемые значения:
Число загруженных записей.
Комментарии:
Возвращает количество полученных записей с сервера. Записи загружаются последовательно.
Смотри также:
* bool show_dialog(TDateTime &,TDateTime &,std::vector<int> &)
Отображает диалоговое окно инициализации источника данных.
Параметры:
TDateTime - время “с” (начало периода
просмотра архива);
TDateTime - время “до” (конец просмотра архива);
std::vector<int> - массив идентификаторов мобильных объектов;
В указанных параметрах передаются значения, отображаемые при создании диалогового окна. Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
True - если диалоговое окно создано;
False - если возникала ошибка.
Комментарии:
Этот метод используется для передачи значений, выбранных пользователем, в отчет. Как правило, используется для источников, не инициализированных при создании отчета (см. раздел Создание и удаление отчета на стр. 7.). Полученные параметры передаются в метод init().
Смотри также:
* void synchronize(idataset_ctrl*)
Синхронизация.
Параметры:
idataset_ctrl* - 0.
Возвращаемые значения:
Нет.
Комментарии:
Используется для получения всех необходимых данных после инициализации источника данных из программного кода.
Смотри также:
Источник данных текущего положения мобильного объекта на открытой карте (перемещение объекта, просмотр архива). Позволяет получить доступ к данным объектов, отображенных на карте. Хранение информации источника организовано в виде таблицы.
* double
X
Возвращает координату Х местоположения мобильного объекта.
* double
Y
Возвращает координату Y местоположения мобильного объекта.
* double
dX
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Х; dX2+dY2=1).
* double
dY
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Y; dX2+dY2=1).
* double
double_time
Возвращает время фиксации координат местоположения мобильного объекта.
* bool
inside_map
Возвращает True если мобильный объект находится на открытой карте или
False в другом случае.
* bool
inside_picture
Возвращает True если мобильный объект находится на участке карты, отображенном
в окне программы или False в другом случае.
* bool
is_auto_change_map
Возвращает True если включен режим автозамены карты или False в другом
случае.
* bool
is_fix_map
Возвращает True если включен режим перемещения карты за выделенными
объектами или False в другом случае.
* bool
is_show_hint
Возвращает True если включен режим отображения подсказок для мобильных
объектов или False в другом случае.
* bool
is_trace_mode
Возвращает True если включен режим отображения трассы перемещения мобильных
объектов или False в другом случае.
* int
obj_id
Возвращает идентификатор мобильного объекта.
* AnsiString
obj_name
Возвращает название мобильного объекта.
* double
speed
Возвращает скорость движения мобильного объекта.
* TDateTime
time
Возвращает время фиксации координат местоположения мобильного объекта.
* unsigned
int position()
Возвращает номер текущей записи в выборке.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* std::vector<int>
request_objects
Возвращает массив идентификаторов мобильных объектов, указанных в запросе
(объекты, по которым формировалась выборка из архива).
* TDateTime
request_time_from
Возвращает время начала просмотра архива, указанное в запросе.
* TDateTime
request_time_to
Возвращает время окончания просмотра архива, указанное в запросе.
* int
sym_request
Возращает идентификатор запроса к серверу мобильных объектов, ассоциированного
с активным окном карты. (например "последнее местоположение","просмотр
архива","наблюдение за объектами"). Список доступных запросов и их названия
можно получить в источнике данных user.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет, достигнуто ли окончание потока данных и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на нужную запись в таблице источника данных.
Смотри также:
* void fix_map(int)
Режим перемещения карты за объектом
Параметры:
int - идентификатор мобильного объекта..
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить режим перемещения
карты за мобильным объектом. Работает аналогично кнопке
[Д: перемещать карту за объектами]).
Смотри также:
* void fix_map(const std::vector<int> &)
Режим перемещения карты за объектами.
Параметры:
const std::vector<int> & - массив идентификаторов мобильных объектов, за которыми необходимо перемещать карту.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить режим перемещения
карты за несколькими мобильными объектами одновременно. Работает аналогично
кнопке
[Д: перемещать карту за объектами])
Смотри также:
* void
move_map(int)
Отображение мобильного объекта в открытом окне.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить масштаб карты,
чтоб мобильный объект был отображен в открытом окне (на видимой области).
Работает аналогично кнопке
[Д: показать выделенные объекты вместе]
Смотри также:
* void move_map(const std::vector<int> &)
Отображение объектов на одной карте.
Параметры:
const std::vector<int> & - массив идентификаторов мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить масштаб карты,
чтоб несколько мобильных объектов были одновременно отображены на одной
карте (на видимой области в отрытом окне). Работает аналогично кнопке
[Д: показать выделенные объекты вместе]
Смотри также:
* void
select_obj(int)
Выбор мобильного объекта.
Параметры:
int - идентификатор мобильного объекта
Возвращаемые значения:
Нет.
Комментарии:
Позволяет выбрать (выделить) необходимый мобильный объект
* void select_obj(const std::vector<int> &)
Выбор нескольких объектов.
Параметры:
const std::vector<int> & - массив идентификаторов мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет выбрать (выделить) одновременно несколько необходимых мобильных объектов.
* void set_auto_change_map(bool)
Автоматическая замена карты.
Параметры:
True - передается для установления
режима замены карты;
False - передается для отмены режима замены карты.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить режим автоматического
изменения карты (
[Д:автоматическая замена карты])для определения необходимой карты.
Смотри также:
* void set_show_hint(bool)
Отображение подсказок.
Параметры:
True - передается для отображения
подсказок на карте;
False - передается для запрета режима отображения подсказок на карте.
Возвращаемые значения:
Нет.
Комментарии:
Разрешает или запрещает отображение подсказок для мобильных объектов.
Смотри также:
* void set_trace_mode(bool)
Отображение трассы.
Параметры:
True - передается для отображения
трассы передвижений мобильного объетка на карте;
False - передается для запрета режима отображения трассы на карте.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет устанавливать или отменять
режим отображения трассы передвижения мобильного объекта (аналогично
кнопке
[Д: отображать трассу]).
Смотри также:
Источник данных: current_fix_archive
Источник данных, предоставляющий информацию о текущем положении мобильного объекта на открытой карте при просмотре архива. Используя переменные и методы этого источника можно получить доступ к архиву перемещений мобильных объектов. Хранение данных источника организовано в виде таблицы.
* double
X
Возвращает координату Х местоположения мобильного объекта.
* double
Y
Возвращает координату Y местоположения мобильного объекта.
* double
dX
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Х; dX2+dY2=1).
* double
dY
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Y; dX2+dY2=1).
* double
double_time
Возвращает время фиксации координат местоположения мобильного объекта.
* bool
inside_map
Возвращает True если мобильный объект находится на открытой карте или
False в другом случае.
* bool
inside_picture
Возвращает True если мобильный объект находится на участке карты, отображенном
в окне программы или False в другом случае.
* bool
is_auto_change_map
Возвращает True если включен режим автозамены карты или False в другом
случае.
* bool
is_bof
Возвращает True если находимся в начале просмотра архива или False в
другом случае.
* bool
is_eof
Возвращает True если находимся в конце просмотра архива или False в
другом случае.
* bool
is_fix_map
Возвращает True если включен режим перемещения карты за выделенными
объектами или False в другом случае.
* bool
is_show_hint
Возвращает True если включен режим отображения подсказок для мобильных
объектов или False в другом случае.
* bool
is_trace_mode
Возвращает True если включен режим отображения трассы перемещения мобильных
объектов или False в другом случае.
* int
obj_id
Возвращает идентификатор мобильного объекта.
* AnsiString
obj_name
Возвращает название мобильного объекта.
* bool
pause
Возвращает True если включен “режим паузы” или False в другом случае.
* double
speed
Возвращает скорость движения мобильного объекта.
* TDateTime
time
Возвращает дату фиксации координат местоположения мобильного объекта.
* int
total_count
Возвращает общее количество координат местоположений объектов в архиве.
* unsigned
int position()
Возвращает номер текущей записи в выборке.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* std::vector<int>
request_objects
Возвращает массив идентификаторов мобильных объектов, указанных в запросе
(объекты, по которым формировалась выборка из архива).
* TDateTime
request_time_from
Возвращает время начала просмотра архива, указанное в запросе.
* TDateTime
request_time_to
Возвращает время окончания просмотра архива, указанное в запросе.
* int
sym_request
Возращает идентификатор запроса к серверу мобильных объектов, ассоциированого
с активным окном карты. Всегда соответствует запросу "просмотр архива".
Список доступных запросов и их названия можно получить в источнике данных
user.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных или нет и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
* void fix_map(int)
Режим перемещения карты за объектом
Параметры:
int - идентификатор мобильного объекта..
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить режим перемещения
карты за мобильным объектом. Работает аналогично кнопке
[Д: перемещать карту за объектами]).
Смотри также:
* void fix_map(const std::vector<int> &)
Режим перемещения карты за объектами.
Параметры:
const std::vector<int> & - массив идентификаторов мобильных объектов, за которыми необходимо перемещать карту.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить режим перемещения
карты за несколькими мобильными объектами одновременно. Работает аналогично
кнопке
[Д: перемещать карту за объектами])
Смотри также:
* void go_end()
Перейти в положение последней координаты объекта.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместиться в положение последней координаты мобильного объекта.
Перемещение в конец просмотра архива
координат. Соответствует кнопке
в окне Управление просмотром (см. раздел Работа
с архивом на стр. 30.). Перемещение в конец осуществляется
путём получения последнего блока данных с сервера мобильных объектов.
Координаты объектов присутствующие в промежуточных блоков останутся
неизвестными. Следствием этого может быть искажённая картина трасс и
неверное определение последнего местоположения объектов. Координаты
получается блоками по 512 записей.
Смотри также:
* void go_first()
Перейти в положение первой координаты объекта.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Перемещение в начало просмотра архива
координат. Соответствует кнопке
в окне Управление просмотром (см. раздел Работа
с архивом на стр. 30.).
Смотри также:
* void go_next()
Перейти в положение следующей координаты объекта.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Перемещение в следующую позицию. Соответствует
кнопке
в окне Управление просмотром (см. раздел Работа
с архивом на стр. 30.). В состоянии паузы перемещение
осуществляется к следующей координате с большим временем. В состоянии
просмотра перемещение осуществляется к следующей координате с временем
большим на delta. Величина delta определяется в зависимости от скорости
просмотра. Количество итераций go_next() может быть меньше величины
current_fix_archive.total_count
Смотри также:
* void go_preview()
Перейти в положение предыдущей координаты объекта.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Перемещение в предыдущую позицию.
Соответствует кнопке
в окне Управление просмотром (см. раздел Работа
с архивом на стр. 30.) В состоянии паузы перемещение осуществляется
к предыдущей координате с меньшем временем. В состоянии просмотра перемещение
осуществляется к предыдущей координате с временем, меньшим на delta.
Величина delta определяется в зависимости от скорости просмотра. Количество
итераций go_preview() может быть меньше величины current_fix_archive.total_count.
Смотри также:
* void
move_map(int)
Отображение мобильного объекта в открытом окне.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить масштаб карты,
чтоб мобильный объект был отображен в открытом окне (на видимой области).
Работает аналогично кнопке
[Д: показать выделенные объекты вместе]
Смотри также:
* void move_map(const std::vector<int> &)
Отображение объектов на одной карте.
Параметры:
const std::vector<int> & - массив идентификаторов мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить масштаб карты,
чтоб несколько мобильных объектов были одновременно отображены на одной
карте (на видимой области в отрытом окне). Работает аналогично кнопке
[Д: показать выделенные объекты вместе]
Смотри также:
* void
select_obj(int)
Выбор мобильного объекта.
Параметры:
int - идентификатор мобильного объекта
Возвращаемые значения:
Нет.
Комментарии:
Позволяет выбрать (выделить) необходимый мобильный объект
* void select_obj(const std::vector<int> &)
Выбор нескольких объектов.
Параметры:
const std::vector<int> & - массив идентификаторов мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет выбрать (выделить) одновременно несколько необходимых мобильных объектов.
* void set_auto_change_map(bool)
Автоматическая замена карты.
Параметры:
True - передается для установления
режима замены карты;
False - передается для отмены режима замены карты.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить режим автоматического
изменения карты (
[Д: автоматическая замена карты])для определения необходимой карты.
Смотри также:
* void set_pause(bool)
Пауза в просмотре архива.
Параметры:
True - передается для установления
режима “паузы”;
False - передается для отмены режима “паузы”.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить или отменить режим “паузы” при просмотре архива.
* void set_show_hint(bool)
Отображение подсказок.
Параметры:
True - передается для отображения
подсказок на карте;
False - передается для запрета режима отображения подсказок на карте.
Возвращаемые значения:
Нет.
Комментарии:
Разрешает или запрещает отображение подсказок для мобильных объектов.
Смотри также:
* void set_trace_mode(bool)
Отображение трассы.
Параметры:
True - передается для отображения
трассы передвижений мобильного объекта на карте;
False - передается для запрета режима отображения трассы на карте.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет устанавливать или отменять
режим отображения трассы передвижения мобильного объекта (аналогично
кнопке
[Д: отображать трассу]).
Смотри также:
* void switch_current()
Переключение источника информации на текущее положение всех объектов.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
В каждый момент просмотра архива существует текущее положение объектов, которые участвуют в запросе. switch_current() позволяет представить источник данных таким образом, чтобы он представлял собой таблицу текущего положения объектов.
* void switch_current_one()
Переключение источник информации на текущее положение мобильного объекта в данный момент времени.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Каждое положение просмотра архива, определяет только одна координата, с определённым временем. switch_current_one() позволяет представить источник данных таким образом, чтобы он представлял собой таблицу, длинною в одну запись, которая представляет собой текущее положение просмотра. Переключение в этот режим позволяет “перебрать” все координаты в архиве в хронологическом порядке.
* void switch_end()
Переключение источника информации на
конечные положения всех мобильных объектов.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет представить источник данных в виде таблицы с последним положением всех мобильных объектов, участвующих в запросе.
Положения соответствует символам F (см. раздел Работа с архивом на стр. 30.)при просмотре трассы.
* void switch_first()
Переключает источник информации на начальные положения всех мобильных объектов.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет представить источник данных в виде таблицы с первым положением всех мобильных объектов, участвующих в запросе. Положения соответствует символам S (см. раздел Работа с архивом на стр. 30.)при просмотре трассы.
* void switch_objects()
Переключает источник информации на все координаты местоположения мобильного объекта, находящиеся в памяти в данный момент.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
При просмотре архива на карте, только часть координат храниться в памяти. Остальная часть подкачивается с сервера по мере необходимости. switch_objects() позволяет представить источник данных в виде таблицы с теми положением объектов, которые находятся в данный момент в памяти. При просмотре архива с небольшим количеством координат это позволяет перебрать все координаты более естественным для FastReport путём.
* bool wait_data_load()
Ожидание необходимых данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если все необходимые данные
получены;
False - если необходимые данные не получены.
Комментарии:
Используется при выполнении запроса для проверки получены ли все необходимые данные или нет. При использовании этой команды программа будет ждать получения необходимой информации до тех пор, пока данные не будут получены.
* bool wait_data_load(unsigned int)
Ожидание необходимых данных.
Параметры:
unsigned int - значение промежутка времени в миллисекундах.
Возвращаемые значения:
True - если все необходимые данные
получены;
False - если необходимые данные не получены.
Комментарии:
Используется при выполнении запроса для проверки получены ли все необходимые данные или нет. При использовании этой команды программа будет ждать получения необходимой информации в течении указанного промежутка времени.
Источник информации предоставляет данные о последнем положении мобильного объекта. Однако, после открытия архива последнее местоположение одного или нескольких объектов может быть не известно и методы источника fix_last будут работать некорректно. Для правильной работы необходимо вначале пройти весь архив или переместиться на последнюю позицию в архиве, а затем использовать методы и переменные. Хранение данных источника организовано в виде таблицы.
* double
X
Возвращает координату Х местоположения мобильного объекта.
* double
Y
Возвращает координату Y местоположения мобильного объекта.
* double
dX
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Х; dX2+dY2=1).
* double
dY
Одна из составляющих для получения направления движения мобильного объекта
(смещение вдоль оси Y; dX2+dY2=1).
* double
double_time
Возвращает время фиксации координат местоположения мобильного объекта
(в формате double).
* int
obj_id
Возвращает идентификатор мобильного объекта.
* AnsiString
obj_name
Возвращает название мобильного объекта.
* double
speed
Возвращает скорость движения мобильного объекта.
* TDateTime
time
Возвращает дату фиксации координат местоположения мобильного объекта.
* unsigned
int position()
Возвращает номер текущей записи в выборке.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* std::vector<int>
request_objects
Возвращает массив идентификаторов мобильных объектов, указанных в запросе
(объекты, по которым формировалась выборка из архива).
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет, достигнуто ли окончание потока данных и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void close()
Закрыть соединения с сервером.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Прекратить получение данных по данному запросу от сервера. При этом в источнике данных будут доступны только те записи, которые были получены до вызова close(). Их количество можно получить функцией loaded(). Проверить получена ли текущая запись можно функцией is_data_present(). Нет необходимости вызывать close() после получения всех данных, т.к. в этом случае поток данных закрывается самостоятельно.
Смотри также:
* void default_param(idataset_ctrl*,Variant &)
Получить параметры источника данных.
Параметры:
idataset_ctrl* - 0 (указатель на
"интерфейс управления источником данных". Зарезервировано. Должен быть
0.);
Variant - ссылка на переменную, в которую будет записаны параметры по
умолчанию источника данных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры экземпляра источника данных, установленные по умолчанию. Используется для передачи этих параметров при инициализации экземпляра источника данных из программного кода.
Смотри также:
* void default_param(std::vector<int> &)
Получить параметры источника данных.
Параметры:
std::vector<int> & - массив идентификаторов мобильных объектов. Полученный результат будет сохранен в этом массиве.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры экземпляра источника данных, установленные по умолчанию. Используется для передачи этих параметров при инициализации экземпляра источника данных из программного кода.
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
* const AnsiString & get_error()
Возвращает ошибку в виде строки.
Параметры:
Не передаются.
Возвращаемые значения:
Произошедшая ошибка в виде строки.
Комментарии:
Если в процессе выполнения отчета возникла ошибка – функция вернет эту ошибку в виде строки.
* AnsiString get_object_name(int)
Получить название мобильного объекта.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Название мобильного объекта.
Комментарии:
Позволяет получить название мобильного объекта по его идентификатору.
* void init(const std::vector<int> &)
Инициализация экземпляра источника данных.
Параметры:
std::vector<int> - массив идентификаторов мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Если при проектировании отчета некоторые источники данных не были инициализированы – это можно выполнить из программного кода, используя данную функцию. Параметры для инициализации передаются при помощи метода default_param().
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* bool is_data_present()
Проверка получения записи.
Параметры:
Не передаются.
Возвращаемые значения:
True - если необходимая запись получена;
False - если необходимая запись не получена.
Комментарии:
Процесс получения записей от сервера занимает какое-то время.
Если экземпляр источника данных инициализируется до выполнения отчёта (если он отмечен в списке источников, которые подлежат инициализации), то к моменту выполнения отчёта все записи будут получены.
Если инициализировать источник данных самостоятельно — необходимо следить за наличием записи с помощью метода is_data_present().Чтобы дождаться получения всех записей используйте метод synchronize().
Смотри также:
* unsigned int loaded()
Возвращает количество загруженных записей.
Параметры:
Не передаются.
Возвращаемые значения:
Число загруженных записей.
Комментарии:
Возвращает количество полученных записей с сервера. Записи загружаются последовательно.
Смотри также:
show_dialog()
* bool show_dialog(std::vector<int> &)
Отображает диалоговое окно инициализации источника данных.
Параметры:
std::vector<int> - массив идентификаторов мобильных объектов.
В указанных параметрах передаются значения, отображаемые при создании диалогового окна. Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
True - если диалоговое окно создано;
False - если возникла ошибка.
Комментарии:
Этот метод используется для передачи значений, выбранных пользователем, в отчет. Как правило, используется для источников, не инициализированных при создании отчета (см. раздел Создание и удаление отчета на стр. 7.). Полученные параметры передаются в метод init().
Смотри также:
* void synchronize(idataset_ctrl*)
Синхронизация.
Параметры:
idataset_ctrl* - 0.
Возвращаемые значения:
Нет.
Комментарии:
Используется для получения всех необходимых данных после инициализации источника данных из программного кода.
Смотри также:
Источник предоставляет доступ к данным проекции открытой карты. Используется для пересчета точек из одной проекции в другую, вычисления расстояния между двумя точками и т.п.
* int
distance_unit
Возвращает установленные единицы измерения карты (метры - 0, километры
- 1, мили - 2).
* int
distance_unit_count
Возвращает общее количество доступных единиц измерения расстояния.
* MapProj*
pj
Возвращает указатель на установленную проекцию карты.
* double distance(double,double,double,double)
Измерение расстояния
Параметры:
double - x координата первой точки;
double - y координата первой точки;
double - x координата второй точки;
double - y координата второй точки.
Возвращаемые значения:
Расстояние между двумя точками.
Комментарии:
Измеряет расстояние между двумя точками, координаты которых заданы, как (x1,y1) и (x2,y2).
* double fwdx(double,double)
Пересчёт координаты из градусов в установленную проекцию.
Параметры:
double - долгота в формате <градусы>.<доли
градусов> местоположения точки в градусах;
double - широта в формате <градусы>.<доли градусов> местоположения
точки в градусах.
Возвращаемые значения:
x координату точки в установленной проекции.
Комментарии:
Преобразует координаты точки в градусах в координату Х картографической проекции, установленной функцией set_pj().
* double fwdx(MapProj*,double,double)
Пересчёт координаты из указанной в установленную проекцию.
Параметры:
MapProj* - указатель на картографическую
проекцию, в которой записаны координаты точки;
double - долгота местоположения точки (в указанной проекции);
double - широта местоположения точки (в указанной проекции).
Возвращаемые значения:
х координату точки в установленной проекции.
Комментарии:
Преобразует координаты точки в определенной проекции карты (передается в параметрах) в координату Х в проекции, установленной функцией set_pj().
* double fwdy(double,double)
Пересчёт координаты из градусов в установленную проекцию.
Параметры:
double - долгота в формате <градусы>.<доли
градусов> местоположения точки в градусах;
double - широта в формате <градусы>.<доли градусов> местоположения
точки в градусах.
Возвращаемые значения:
Y координату точки в установленной проекции.
Комментарии:
Преобразует координаты точки в градусах в координату Y проекции, установленной функцией set_pj().
* double fwdy(MapProj*,double,double)
Пересчёт координаты из указанной в установленную проекцию.
Параметры:
MapProj* - указатель на проекцию карты,
в которой записаны координаты точки;
double - долгота местоположения точки (в указанной проекции);
double - широта местоположения точки (в указанной проекции).
Возвращаемые значения:
y координату точки в установленной проекции.
Комментарии:
Преобразует координаты точки в определенной проекции карты (передается в параметрах) в координату Y в проекции, установленной функцией set_pj().
* double invx(double,double)
Пересчёт координаты из установленной проекции в градусы.
Параметры:
double - долгота местоположения точки;
double - широта местоположения точки.
Возвращаемые значения:
координата Х точки в градусах.
Комментарии:
Преобразует координаты точки Х в градусы относительно установленной проекции.
* double invx(MapProj*,double,double)
Пересчёт координаты из указанной в
параметрах проекции в градусы.
Параметры:
MapProj* - указатель на проекцию карты,
в которой записаны координаты точки;
double - долгота местоположения точки;
double - широта местоположения точки.
Возвращаемые значения:
координата Х точки в градусах.
Комментарии:
Преобразует координаты точки Х в градусы относительно указанной в параметрах проекции.
* double invу(double,double)
Пересчёт координаты из установленной проекции в градусы.
Параметры:
double - долгота местоположения точки;
double - широта местоположения точки.
Возвращаемые значения:
координата Y точки в градусах.
Комментарии:
Преобразует координаты точки Y в градусы относительно установленной проекции.
* double invу(MapProj*,double,double)
Пересчёт координаты из указанной в параметрах проекции в градусы.
Параметры:
MapProj* - указатель на проекцию карты,
в которой записаны координаты точки;
double - долгота местоположения точки;
double - широта местоположения точки.
Возвращаемые значения:
координата Y точки в градусах.
Комментарии:
Преобразует координаты точки Y в градусы относительно указанной в параметрах проекции.
* bool is_equal(double,double)
Сравнение двух чисел.
Параметры:
double - сравниваемое число;
double - сравниваемое число.
Возвращаемые значения:
True - если числа равны;
False - если числа не равны
Комментарии:
Сравнивает два числа, например координаты. Сравнение проводится в пределах одной проекции карты, т.е. числа должны быть записаны в координатах одной и той же проекции.
* void set_pj(MapProj*)
Установка проекции карты.
Параметры:
MapProj* - указатель на проекцию карты.
Возвращаемые значения:
Нет.
Комментарии:
Устанавливает проекцию карты.
* AnsiString distance2str(double)
Преобразование расстояния в строку.
Параметры:
double - число (например, расстояние) в метрах.
Возвращаемые значения:
Число в отформатированном виде.
Комментарии:
Используется для перевода измеренного расстояния в строку с указанием едениц измерения, в данном случае - метров.
* AnsiString distance2str(double,int )
Преобразование расстояния в строку.
Параметры:
double - число (например, расстояние) в метрах;
int - идентификатор единиц измерения, в которых будет пересчитано указанное расстояние (0-метры; 1-километры, 2-мили).
Возвращаемые значения:
Строка, содержащая измеренное расстояние в отформатированном виде.
Комментарии:
Используется для пересчета измеренного расстояния из метров в “доступные единицы измерения”. В результате получим текстовую строку соответствующего формата.
Пример:
[MAP_PROJ.DISTANCE2STR(123.5, 1)]
В результате получим: 0.123 км
* AnsiString distance_unit_name()
Получить установленные единицы измерения.
Параметры:
Не передаются.
Возвращаемые значения:
Строка, содержащая название единиц измерения.
Комментарии:
Используется для получения единиц измерения, установленных в программе в данный момент (метры, километры, мили и т.п.).
* AnsiString distance_unit_name(int)
Получить название единиц измерения.
Параметры:
int - идентификатор “доступных единиц измерения” (0-метры; 1-километры, 2-мили).
Возвращаемые значения:
Строка, содержащая название единиц измерения.
Комментарии:
Используется для получения названия единиц измерения по их идентификатору.
* double meters2unit(double)
Пересчет числа из метров в “доступные единицы измерения”.
Параметры:
double - число (расстояние), которое необходимо пересчитать.
Возвращаемые значения:
Число (расстояние) в единицах измерения, установленных в программе в данный момент.
Комментарии:
Используется для пересчета расстояния из метров в единицы измерения, установленные в программе в данный момент.
* double meters2unit(double,int)
Пересчитывает число в метрах в “необходимые
единицы измерения”.
Параметры:
double - число (расстояние), которое
необходимо пересчитать;
int - идентификатор необходимых единиц измерения (0-метры; 1-километры,
2-мили).
Возвращаемые значения:
Число (расстояние) в единицах измерения, указанных в параметрах функции.
Комментарии:
Используется для пересчета расстояния из метров в единицы измерения, указанные в параметрах функции (например, километры, мили и т.п.).
* double unit2meters(double)
Пересчет расстояние из единиц измерения,
установленных в программе в данный момент, в метры.
Параметры:
double - число (расстояние), которое необходимо пересчитать.
Возвращаемые значения:
Число (расстояние) в метрах.
Комментарии:
Используется для пересчета расстояния из установленных в программе едениц измерения в данный момент в метры.
* double unit2meters(double,int)
Пересчитывает расстояние из каких-либо
доступных единиц измерения в метры.
Параметры:
double - число, которое необходимо
пересчитать;
int - идентификатор единиц измерения, в которых указано число(0-метры;
1-километры, 2-мили).
Возвращаемые значения:
Число (расстояние) в метрах.
Комментарии:
Используется для пересчета расстояния из указанных в параметрах функции единиц измерения в метры.
* AnsiString degree_str(double)
Преобразует число в градусах в отформатированную строку.
Параметры:
double - число в градусах.
Возвращаемые значения:
Отформатированная строка.
Комментарии:
Преобразует число в градусах в отформатированную строку стандартного вида.
Пример:
MAP_PROJ.INVY(fix_archive.X, fix_archive.Y)
//в результате получим: 50,4300383333229
MAP_PROJ.DEGREE_STR(MAP_PROJ.INVY(fix_archive.X, fix_archive.Y))
//в результате получим: 50 ' 25 " 45
* AnsiString degree_str(double,AnsiString)
Преобразует число в градусах в отформатированную
строку необходимого вида.
Параметры:
double - число в градусах.
AnsiString - маска в виде строки, которая будет использоваться для форматирования. Градусы обозначаются латинской буквой d, минуты - m, секунды - s. Для отображения числа с его дробной частью используется три подряд символа (например, mmm - минуты будут отображаться с дробной частью). При использовании двух символов подряд (например, dd) - 1 будет отображаться как 01. Разрешается запись, как 'ddmmss' , так и 'dd mm ss'
Возвращаемые значения:
Отформатированная строка.
Комментарии:
Преобразует число в градусах в отформатированную строку стандартного вида.
Пример:
MAP_PROJ.DEGREE_STR(MAP_PROJ.INVY(fix_archive.X,
fix_archive.Y),'dd mm ss')
//в результате получим градусы, минуты, секунды целыми числами:
50 25 46
MAP_PROJ.DEGREE_STR(MAP_PROJ.INVY(fix_archive.X, fix_archive.Y),'ddd
mmm sss')
//в результате получим градусы , минуты, секунды с дробной частью:
50,4296116666562 25,7766999993694 46,6019999621665
Источник информации о мобильных объектах (идентификаторы, названия, описания и т.п.). Предоставляет доступ к списку групп, их параметрам, правам доступа и перечню объектов, входящих в состав групп. Редактируется на сервере мобильных объектов.
* std::vector<int>
active_group
Возвращает массив идентификаторов групп, доступных пользователю.
* std::vector<int>
active_obj
Возвращает массив идентификаторов мобильных объектов, доступных пользователю.
Все объекты, входящие в состав “доступных групп” будут перечислены в
возвращаемом списке.
* TPicture* get_car_picture(int)
Получить пиктограмму мобильного объекта.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Указатель на пиктограмму мобильного объекта.
Комментарии:
Возвращает пиктограмму, используемую для отображения мобильного объекта на карте (по умолчанию).
* TPicture* get_car_picture(int,double, double)
Получить пиктограмму мобильного объекта.
Параметры:
int - идентификатор мобильного объекта;
double - смещение “по Х” (dX);
double - смещение “по Y” (dY).
Возвращаемые значения:
Указатель на пиктограмму мобильного объекта.
Комментарии:
Используется для получения пиктограммы, используемой для отображения направления движения мобильного объекта (см. Руководство пользователя, раздел Диспетчеризация на стр. 78). Значения dX и dY соответствуют тригонометрическому кругу. Т.е. dX*dX+dY*dY=1. Вектор (0;0)-(dX,dY) определяет направление движения объекта. Свойства dX,dY можно получить у источников данных current_fix_archive, fix_archive, fix_current, fix_last.
Смотри также:
* int get_car_picture_height(int)
Получить высоту пиктограммы мобильного объекта.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Возвращает высоту пиктограммы, используемой для отображения мобильного объекта на карте.
Смотри также:
* int get_car_picture_width(int)
Получить ширину пиктограммы мобильного объекта.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Возвращает высоту пиктограммы, используемой для отображения мобильного объект на карте.
Смотри также:
* AnsiString group_description(int)
Получить описание группы мобильных объектов.
Параметры:
int - идентификатор группы мобильных объектов.
Возвращаемые значения:
Возвращает текстовое описание группы мобильных объектов.
Комментарии:
Текстовое описание группы мобильных объектов устанавливается администратором на сервере.
Смотри также:
* AnsiString group_name(int)
Получить название группы мобильных объектов.
Параметры:
int - идентификатор группы мобильных объектов.
Возвращаемые значения:
Название группы мобильных объектов.
Комментарии:
Название группы мобильных объектов редактируется администратором на сервере.
Смотри также:
* int obj_car_type(int)
Получить идентификатор типа мобильного объекта.
Параметры:
int - идентификатор объекта.
Возвращаемые значения:
Идентификатор типа мобильного объекта.
Комментарии:
Возвращаемый идентификатор соответствует типу, указанному пользователем при настройке клиентской программы (см. Руководство пользователя, раздел Диспетчеризация на стр. 78).
Смотри также:
* AnsiString obj_description(int)
Получить описание мобильного объекта.
Параметры:
int - идентификатор объекта.
Возвращаемые значения:
Текстовое описание мобильного объекта.
Комментарии:
Текстовое описание настраивается пользователем в клиентской программе (см. Руководство пользователя, раздел Диспетчеризация на стр. 78).
Смотри также:
* int obj_grp_id(int)
Получить идентификатор группы мобильных объектов.
Параметры:
int - идентификатор мобильного объекта этой группы.
Возвращаемые значения:
Идентификатор группы мобильных объектов.
Смотри также:
* AnsiString obj_name(int)
Получить название мобильного объекта.
Параметры:
int - идентификатор объекта.
Возвращаемые значения:
Название мобильного объекта.
Комментарии:
Возвращаемое значение указывается администратором сервера мобильных объектов при регистрации.
Смотри также:
* AnsiString type_description(int)
Получить описание типа мобильного объекта.
Параметры:
int - идентификатор объекта.
Возвращаемые значения:
Текстовое описание типа мобильного объекта.
Комментарии:
Настраивается пользователем при создании/редактировании типа мобильных объектов в клиентской программе (см. Руководство пользователя, раздел Диспетчеризация на стр. 78).
Смотри также:
* AnsiString type_name(int)
Получить название типа мобильного объекта.
Параметры:
int - идентификатор объекта.
Возвращаемые значения:
Название типа мобильного объекта.
Комментарии:
Настраивается пользователем при создании/редактировании типа мобильных объектов в клиентской программе (см. Руководство пользователя, раздел Диспетчеризация на стр. 78).
Смотри также:
Позволяет получить информацию об ошибках,
связанных с получением или передачей данных и команд управления мобильным
объектам. Хранение данных источника организовано в виде таблицы.
* bool
close
Возвращает True если ошибка завершилась и False в другом случае. Ошибка
считается завершенной, если определено время окончания получения сообщения
об ошибках данного типа, т.е. получено сообщение, не содержащее ошибки.
* double
code
Возвращает числовой код ошибки.
* double
double_time
Возвращает дату возникновения ошибки (в формате double).
* AnsiString
info
Возвращает дополнительную информацию об ошибке.
* double
interval
Возвращает интервал продолжительности ошибки (от начала ошибки до последнего
запроса к мобильному объекту, когда ошибка еще была зафиксирована) в
формате double.
* int
obj_id
Возвращает идентификатор мобильного объекта, для которого произошла
ошибка.
* AnsiString
obj_name
Возвращает название мобильного объекта.
* unsigned
int position()
Возвращает номер текущей записи в выборке.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* std::vector<int>
request_objects
Возвращает массив идентификаторов мобильных объектов, указанных в запросе
(объекты, по которым формировалась выборка из архива).
* TDateTime
request_time_from
Возвращает время начала просмотра архива, указанное в запросе.
* TDateTime
request_time_to
Возвращает время окончания просмотра архива, указанное в запросе.
* AnsiString
str_code
Возвращает строку ошибки.
* TDateTime
time
Возвращает дату возникновения ошибки в формате TDateTime.
* TDateTime
time_interval
Возвращает интервал от начала ошибки до последнего запроса к мобильному
объекту, когда ошибка еще была зафиксирована (в формате TDateTime).
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет, достигнуто ли окончание потока данных и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void close()
Закрыть соединения с сервером.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Прекратить получение данных по данному запросу от сервера. При этом в источнике данных будут доступны только те записи, которые были получены до вызова close(). Их количество можно получить функцией loaded(). Проверить получена ли текущая запись можно функцией is_data_present(). Нет необходимости вызывать close() после получения всех данных, т.к. в этом случае поток данных закрывается самостоятельно.
Смотри также:
* void default_param(TDateTime &,TDateTime &,std::vector<int> &)
Получение параметров источника данных.
Параметры:
TDateTime - время “с” (начало периода
просмотра). “0” означает, что начало не ограничено;
TDateTime - время “до” (конец периода просмотра). “0” означает, что
окончание не ограничено;
std::vector<int> - массив идентификаторов мобильных объектов.
Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры, установленные по умолчанию для экземпляра источника данных. Используется для передачи этих параметров при инициализации экземпляра источника данных из программного кода функцией init().
Смотри также:
* void default_param(idataset_ctrl*,Variant &)
Получить параметры источника данных.
Параметры:
idataset_ctrl* - 0 (указатель на
"интерфейс управления источником данных". Зарезервировано. Должен быть
0.);
Variant - Variant& - ссылка на переменную, в которую будет записаны
параметры по умолчанию источника данных. Структура возвращаемого значения
имеет вид массива: 0-ой элемент – время "с", 1-ый - время "до", 2-ой
- массив идентификаторов мобильных объектов. .
Возвращаемые значения:
Нет.
Комментарии:
Позволяет получить параметры, установленные по умолчанию для экземпляра источника данных. Используется для передачи параметров при инициализации экземпляра источника данных из программного кода функцией init().
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
* const AnsiString & get_error()
Возвращает ошибку в виде строки.
Параметры:
Не передаются.
Возвращаемые значения:
Произошедшая ошибка в виде строки.
Комментарии:
Если в процессе выполнения отчета возникла ошибка – функция вернет эту ошибку в виде строки.
* AnsiString get_object_name(int)
Получить название мобильного объекта.
Параметры:
int - идентификатор мобильного объекта.
Возвращаемые значения:
Название мобильного объекта.
Комментарии:
Возвращаемое значение указывается администратором сервера мобильных объектов при его регистрации.
Смотри также:
* void init(const TDateTime &,const TDateTime &,const std::vector<int> &)
Инициализация экземпляра источника данных.
Параметры:
TDateTime - время “с” (начало периода
просмотра архива событий);
TDateTime - время “до” (конец просмотра архива событий);
std::vector<int> - массив идентификаторов мобильных объектов.
Возвращаемые значения:
Нет.
Комментарии:
Если при проектировании отчета некоторые источники данных не были инициализированы - это можно выполнить из программного кода, используя даный метод. Типовые значения параметров можно получить, вызвав метод default_param(). Для указания параметров пользователем используйте show_dialog().
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет, доступен ли источник данных в данном отчете.
Смотри также:
* bool is_data_present()
Проверка получения записи.
Параметры:
Не передаются.
Возвращаемые значения:
True - если необходимая запись получена;
False - если необходимая запись не получена.
Комментарии:
Процесс получения записей от сервера занимает какое-то время.
Если экземпляр источника данных инициализируется до выполнения отчёта (если он отмечен в списке источников, которые подлежат инициализации), то к моменту выполнения отчёта все записи будут получены.
Если инициализировать источник данных самостоятельно —необходимо следить за наличием записи с помощью функции is_data_present().Чтобы дождаться получения всех записей используйте функцию synchronize().
Смотри также:
* unsigned int loaded()
Возвращает количество загруженных записей.
Параметры:
Не передаются.
Возвращаемые значения:
Число загруженных записей.
Комментарии:
Возвращает количество полученных записей с сервера. Записи загружаются последовательно.
Смотри также:
* unsigned int position()
Возвращает номер текущей записи в выборке.
Параметры:
Не передаются.
Возвращаемые значения:
Номер текущей записи.
Комментарии:
Возвращает номер текущей записи, на которой сейчас находится “курсор”.
Смотри также:
* unsigned int record_count()
Возвращает общее количество записей.
Параметры:
Не передаются.
Возвращаемые значения:
Количество всех записей.
Комментарии:
Возвращает общее количество записей в таблице источника данных.
Смотри также:
* bool show_dialog(TDateTime &,TDateTime &,std::vector<int> &)
Вызывает диалог инициализации источника данных.
Параметры:
TDateTime - время “с” (начало периода
просмотра архива событий);
TDateTime - время “до” (конец просмотра архива событий);
std::vector<int> - массив идентификаторов мобильных объектов.
В указанных параметрах передаются значения, отображаемые при создании диалогового окна. Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
True - если диалоговое окно создано;
False - если возникала ошибка.
Комментарии:
Этот метод используется для передачи значений, выбранных пользователем, в отчет. Как правило, используется для источников, не инициализированных при создании отчета(см. раздел Создание и удаление отчета на стр. 7.). Полученные параметры передаются в метод init().
Смотри также:
* void synchronize(idataset_ctrl*)
Синхронизация.
Параметры:
idataset_ctrl* - 0.
Возвращаемые значения:
Нет.
Комментарии:
Используется для получения всех необходимых данных после инициализации источника данных из программного кода.
Смотри также:
Источник данных, использующийся доя обработки изображений (изменить размер, повернуть и т.п.), а также для получения информации о рисунках.
* int
height
Возвращает высоту рисунка.
* bool
transparent
Возвращает True если рисунок прозрачен или False в другом случае.
* TPicture*
val
Возвращает указатель на рисунок, присвоенный данному экземпляру источника
данных функцией set_val(). Если ранее этому источнику данных ни один
рисунок не был присвоен — возвращает рисунок с нулевой высотой, нулевой
шириной.
* int
width
Возвращает ширину рисунка.
* void crop(int,int)
Обрезка рисунка.
Параметры:
int - ширина;
int - высота.
Возвращаемые значения:
Нет.
Комментарии:
Выполняет обрезку изображения. За точку отсчета принимается центральная точка изображения. От этой точки откладывается необходимые ширина и высота. Все остальное “обрезается”.
Смотри также:
* void crop(int,int,int,int)
Обрезка рисунка.
Параметры:
int - х-координата точки;
int - y-координата точки;
int - ширина;
int - высота.
Возвращаемые значения:
Нет.
Комментарии:
Эта функция выполняет обрезку изображения. За точку отсчета принимается точка, относительно которой будет “обрезан” рисунок. От этой точки в равных частях откладывается необходимые ширина и высота.
Смотри также:
* void draw(int,int,TPicture*)
Отобразить рисунок.
Параметры:
int - х-координата верхнего левого
угла рисунка;
int - у-координата верхнего левого угла рисунка”;
TPicture* - указатель на рисунок.
Возвращаемые значения:
Нет.
Смотри также:
* void rotate90()
Поворот изображения.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Поворачивает изображение на 90 градусов против часовой стрелки.
* void rotate_90()
Поворот изображения.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Поворачивает изображение на 90 градусов по часовой стрелке.
* void set_transparent(bool)
Установить режим прозрачности изображения.
Параметры:
True - установить режим прозрачности;
False - отменить режим прозрачности.
Возвращаемые значения:
Нет.
set_val()
* void set_val(TPicture*)
Загрузить рисунок в источник данных.
Параметры:
TPicture* - указатель на рисунок.
Возвращаемые значения:
Нет.
Комментарии:
Используется для загрузки рисунка в класс источника данных. При этом создается копия рисунка для последующей работы — изменения размера, поворота и т.п.
Пример:
begin
img_process.set_val(map_window.picture);
img_process.crop(200,200);
pic.Picture:=img_process.val;
pic.Picture:= IMG_PROCESS.SET_TRANSPARENT(True);
end
Источник данных, позволяющий получить доступ к карте, открытой в данный момент в программе. Доступен только для активного окна открытой карты. Используется для получения характеристик карты, ее свойств, изображения видимого участка и т.п.
* int
http_request_delay
Возвращает время задержки перед загрузкой карты в миллисекундах. Если
значение 0 - задержки нет.
* AnsiString
map_name
Возвращает название карты (например, Киевская область).
* double
map_scale
Возвращает масштаб карты в котором она изготовлена (одна из характеристик
карты).
* AnsiString
map_type
Возвращает тип карты (например: город, область, страна).
* TPicture*
picture
Возвращает рисунок видимой части карты, открытой в окне программы.
* int
picture_height
Возвращает высоту рисунка.
* int
picture_widt
Возвращает ширину рисунка.
* MapProj*
pj
Возвращает указатель на проекцию открытой карты.
* double
relative_scale
Возвращает относительный масштаб карты от 0 до 1 (Значение “0” соответствует
наиболее детальному масштабу, а значение “1” — наименее детальному.)
* double
scale
Возвращает масштаб карты, в котором она отображена в момент формирования
отчета.
* AnsiString
title
Возвращает заголовок карты (например: Карта - Киев - Просмотр журнала
с 24.05.2003 12:41:28).
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* void get_extent(double &,double &,double &)
Получить координаты участка карты,
отображенного в окне программы.
Параметры:
double - х-координата центральной
точки изображения;
double - у-координата центральной точки изображения;
double - масштаб карты.
Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
Нет.
Комментарии:
Используется для получения координат и масштаба участка карты, отображенного в видимой области открытого окна. Масштаб передается одним числом (например: 5000 =1:5000).
* void set_extent(double ,double ,double)
Установить координаты участка карты,
отображенного в окне программы.
Параметры:
double - х-координата центральной
точки изображения;
double - у-координата центральной точки изображения;
double - масштаб карты.
Возвращаемые значения:
Нет.
Комментарии:
Используется для установки координат и масштаба участка карты, отображенной в видимой области открытого окна программы. Масштаб передается одним числом (например, 5000 =1:5000).
* void get_extent(double &,double &,double &,double &)
Получить координаты участка карты,
отображенного в открытом окне программы.
Параметры:
double - х-координата нижнего левого
угла;
double - у-координата нижнего левого угла;
double - х-координата верхнего правого угла;
double - у-координата верхнего правого угла.
Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
Нет.
Комментарии:
Используется для получения координат участка карты, отображенного в открытом окне программы на видимой области в открытом окне программы.
* void get_map_extent(double &,double &,double &,double &)
Получить координаты карты.
Параметры:
double - х-координата нижнего левого
угла;
double - у-координата нижнего левого угла;
double - х-координата верхнего правого угла;
double - у-координата верхнего правого угла.
Полученный результат будет сохранен в этих переменных.
Возвращаемые значения:
Нет.
Комментарии:
Используется для получения координат всей карты, открытой в данный момент в окне программы.
* void set_extent_test_bound(double,double,double)
Установить координаты участка карты,
отображенного в окне программы.
Параметры:
double - х-координата центральной
точки изображения;
double - у-координата центральной точки изображения;
double - масштаб карты.
Возвращаемые значения:
Нет.
Комментарии:
Используется для установки координат и масштаба участка карты, отображенной в видимой области открытого окна программы. Масштаб передается одним числом (например, 5000 =1:5000). Перед установкой координат вначале будет проверено, попадает ли указанная центральная точка в область карты. Если точка попадает – координаты участка карты будут установлены. Если точка не попадает – ничего не произойдет.
* void pix2world(double &,double &)
Переводит координаты точки в пикселах
в мировые координаты.
Параметры:
double - х-координата точки в пикселах
(относительно открытого окна, содержащего изображение карты);
double - у- координата точки в пикселах (относительно открытого окна,
содержащего изображение карты).
Полученный результат будет сохранен в этих переменных (в мировых координатах).
Возвращаемые значения:
Нет.
Комментарии:
Используется для пересчета координат точки в мировые координаты.
* double pix2world(double)
Пересчитать длину отрезка (пикселы
в мировые координаты).
Параметры:
double - длинна отрезка в пикселах.
Возвращаемые значения:
Длинна отрезка в мировых координатах.
Комментарии:
Используется для пересчета длины отрезка, рассчитанной с использованием пиксельных координат крайних точек отрезка, в длину, соответствующую мировым координатам указанных точек.
* void set_http_request_delay(int)
Время задержки перед загрузкой карты.
Параметры:
int - время задержки в миллисекундах.
Возвращаемые значения:
Нет.
Комментарии:
Метод устанавливает задержку перед загрузкой фрагментов карты. Задержка перед загрузкой изображения позволяет избежать создания лишних запросов к серверу. При быстром перемещении карты, некоторые участки карты не будут полностью загружены, но запрос поступит на сервер и начнется его загрузка. Если в функцию передать 0 - задержки не будет, что ускорит загрузку изображений.
Смотри также:
* void set_relative_scale(double)
Устанавливает относительный масштаб
карты.
Параметры:
double - значение от 0 до 1.
Возвращаемые значения:
Нет.
Комментарии:
Функция устанавливает относительный масштаб карты. Значеие “0” соответствует наиболее детальному масштабу, а значение “1” — наименее детальному.
Смотри также:
* void set_scale(double)
Устанавливает масштаб карты.
Параметры:
double - число, определяющее необходимый масштаб.
Возвращаемые значения:
Нет.
Комментарии:
Функция устанавливает необходимый масштаб для карты. Например, число 5000 соответствует масштабу 1:5000
Смотри также:
* void set_size(int,int)
Устанавливает размер рисунка.
Параметры:
int - необходимая ширина рисунка;
int - необходимая длина рисунка
Возвращаемые значения:
Нет.
Комментарии:
Функция устанавливает необходимые размеры изображения. Длинна и ширина в равных частях откладываются от центра изображения. К примеру, если для изображения 30*40 пикселей установить размер 40*50, то: существующее изображение будет расположено по центру, а по краям появятся полосы шириной в 10 пикселей.
* bool wait_map_load()
Ожидать получения всех данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если все необходимые данные
получены;
False - если не все данные получены.
Комментарии:
При использовании этой команды программа будет ждать получения всех необходимых данных (полной загрузки рисунка). Если загрузка каких-либо участков не удалась – вернет False.
* bool wait_map_load(unsigned int)
Ожидать получения данных в течении указанного промежутка времени.
Параметры:
unsigned int - значение промежутка времени в миллисекундах.
Возвращаемые значения:
True - если все необходимые данные
получены;
False - если не все данные получены.
Комментарии:
При использовании этой команды программа будет ждать получения всех необходимых данных (полной загрузки рисунка) в течении промежутка времени, указанного в параметрах функции. Если за указанное время удалось получить все необходимые данные – функция вернет True. Если получение данных не удалось – вернет False.
* void world2pix(double &,double &)
Пересчет координаты точки из мировых
координат в пикселы.
Параметры:
double - х-координата точки в мировых
координатах;
double - у- координата точки в мировых координатах.
Полученный результат будет сохранен в этих переменных (в пикселах).
Возвращаемые значения:
Нет.
Смотри также:
* double world2pix(double)
Пересчет длины отрезка из мировых координат
в пикселы.
Параметры:
double - длина отрезка в мировых координатах.
Возвращаемые значения:
Длина отрезка в пикселах.
Комментарии:
Используется для пересчета длины отрезка, рассчитанной с использованием мировых координат крайних точек отрезка, в длину, соответствующую пиксельным координатам указанных точек.
* void view_region(double,double,double,double)
Отобразить указанный участок карты
в открытом окне программы.
Параметры:
double - х-координата нижнего левого
угла;
double - у-координата нижнего левого угла;
double - х-координата верхнего правого угла;
double - у-координата верхнего правого угла.
Возвращаемые значения:
Нет.
Комментарии:
Используется для отображения в открытом окне программы необходимого участка карты.
* void view_pixel_region(double,double,double,double)
Отобразить указанный участок карты
в открытом окне программы (координаты передаются в пикселях).
Параметры:
double - х-координата нижнего левого
угла в пикселях;
double - у-координата нижнего левого угла в пикселях;
double - х-координата верхнего правого угла в пикселях;
double - у-координата верхнего правого угла в пикселях.
Возвращаемые значения:
Нет.
Комментарии:
Используется для отображения в открытом окне программы необходимого участка карты. В качестве параметров передаются пиксельные координаты (точка с координатами (0, 0) соответствует левому верхнему углу окна). Все координаты передаются относительно текущего рисунка карты.
Источник данных: dataset_functions
Источник данных, применяемый для получения информации о классах, свойствах и их методах, использующихся в программе для формирования отчета. Хранение данных источника организовано в виде таблицы.
* unsigned
int argument_count
Возвращает количество аргументов метода.
* AnsiString
full_name
Возвращает полное имя метода (например, void world2pix(double &,double
&))
* AnsiString
result_type
Возвращает тип результатов метода.
* AnsiString
short_name
Возвращает короткое имя метода (например, world2pix).
* AnsiString
val
Возвращает имя источника данных функции, установленного методом set_val.
* unsigned
int position()
Возвращает номер текущей записи в выборке.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет, достигнуто ли окончание потока данных и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор”на нужную запись в таблице источника данных. Эта функция доступна при прямом доступе к записям.
Смотри также:
* AnsiString get_argument_type(unsigned int)
Получить тип аргументов метода.
Параметры:
unsigned int - индекс аргумента метода, тип которого необходимо получить.
Возвращаемые значения:
Возвращает тип аргумента, используемого в методе. Индексация аргументов метода начинается с 0.
* bool is_out_argument(unsigned int)
Получить сведения о том, можно ли в аргументе вернуть какое-либо значение.
Параметры:
unsigned int - индекс аргумента метода.
Возвращаемые значения:
True - если в аргументе можно вернуть
какое-либо значение;
False - если в аргументе нельзя вернуть никакого значения.
Комментарии:
На то, что в аргументе можно вернуть какое-либо значение, указывает знак “&”, расположенный в списке параметров метода после конкретного аргумента. Параметры метода, содержащие такие аргументы, можно передавать только используя функции ARGS.
* void set_val(AnsiString)
Установить название источника данных.
Параметры:
AnsiString - название источника данных.
Возвращаемые значения:
Нет.
Комментарии:
Для получения информации о методах конкретного источника данных (используя dataset_function) необходимо указать его название. Для этого и используется данный метод.
Смотри также:
Источник данных: dataset_props
Источник данных о свойствах классов, использующихся в программе для получения информации из источников данных. Хранение данных источника организовано в виде таблицы.
* AnsiString
prop_name
Возвращает имя свойства (например: is_trace_mode).
* AnsiString
prop_type
Возвращает тип свойства (например: для переменной is_trace_mode — тип
bool).
* AnsiString
val
Возвращает название источника данных, установленного методом set_val().
* unsigned
int position()
Возвращает номер текущей записи в выборке.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет, достигнуто ли окончание потока данных и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо
переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
* void set_val(AnsiString)
Установить название источника данных.
Параметры:
AnsiString - название источника данных.
Возвращаемые значения:
Нет.
Комментарии:
Для получения информации о методах конкретного источника данных — необходимо указать его название. Для этого и используется данный метод.
Смотри также:
Источник данных: virtual_dataset
Предоставляет доступ к вертуальной таблице данных о всеми неободимыми методами и свойствами. Используется для управления формированием отчета. Как правило, в качестве источника для “бэндов” (см. Объект “бэнд” на стр. 18). Хранение данных источника организовано в виде таблицы.
* bool
eof
Возвращает True если достигнут конец таблицы или False в другом случае.
* unsigned
int position
Возвращает текущую позицию в таблице.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока. В зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void first_record()
Переместиться на первую запись в таблице.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись в
таблице.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись таблицы источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись
в таблице.
Параметры:
unsigned int - номер нужной записи.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в источнике данных.
Смотри также:
* void set_record_count(unsigned int)
Указать количество записей.
Параметры:
unsigned int - необходимое количество записей.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить количество записей, “содержащихся” в виртуальном источнике данных.
Источник данных: datasets_list
Используется для получения общего списка источников данных, существующих в программе. Хранение данных источника организовано в виде таблицы.
* AnsiString
class_name
Возвращает название источника данных.
* int
function_count
Возвращает количество методов источника данных.
* int
property_count
Возвращает количество свойств источника данных.
* unsigned
int position
Возвращает текущую позицию в таблице.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных или нет и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void first_record()
Переместиться на первую запись в таблице.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись в
таблице.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись таблицы источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись
в таблице.
Параметры:
unsigned int - необходимое количество записей.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
Источник данных представляет собой таблицу, содержащую запись о каждой таблице, находящейся в “базе данных”. Он позволяет получить информацию о таблицах, содержащих данные пользователя (см. Руководсто пользователя, раздел Работа с таблицами на стр. 89). Используется для доступа к произвольным таблицам без подключения их в качестве “самостоятельных” источников данных (см. Интерфейсы источников данных на стр. 73). Если необходимо использовать при выборке данных фильтры, поиск и сортировку — подключайте таблицу, как источник данных.
* std::vector<AnsiString>
columns_list
Возвращает перечень полей таблицы, запись о которой является активной
в данный момент (т.е. на этой записи установлен “курсор”).
* unsigned
int position
Возвращает номер текущей позиции “курсора”.
* unsigned
int record_count
Возвращает общее количество записей в выборке (источнике данных).
* AnsiString
table_comment
Возвращает комментарии, указанные в редакторе таблиц для таблицы, запись
которой является текущей в данный момент времени (т.е. на этой записи
установлен “курсор”).
* AnsiString
table_name
Возвращет название таблицы, запись о которой является текущей.
* unsigned
int table_record_count
Возвращает общее количество записей таблицы, запись о которой является
текущей.
* std::vector<AnsiString>
tables_list
Возвращает список всех таблиц, которые находяться в базе данных.
* std::vector<AnsiString>
types_list
Возвращает перечень типов, которые используются при создании таблиц.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных или нет и, в зависимости от результата, возвращает соответствующее значение.
* void create_table(const AnsiString &)
Добавление новой таблицы в базу данных.
Параметры:
const AnsiString & - название создаваемой таблицы
Возвращаемые значения:
Нет.
Комментарии:
Создание новой таблицы с указанным именем.
* void drop_table(const AnsiString &)
Удаление таблицы.
Параметры:
const AnsiString & - название удаляемой таблицы
Возвращаемые значения:
Нет.
Комментарии:
Позволяет удалить необходимую таблицу из базы данных.
* void first_record()
Установить “курсор” в начало таблицы записей.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Установить “курсор” на первую запись в таблице.
* AnsiString get_column_type(const AnsiString &)
Получить тип колонки таблицы.
Параметры:
const AnsiString & - название колонки
Возвращаемые значения:
AnsiString - тип указанной колонки
Комментарии:
Позволяет получить тип поля таблицы, запись о которой является текущей (т.е. на этой записи установлен “курсор”).
* void goto_table(const AnsiString &)
Сделать текущей запись о необходимой таблице.
Параметры:
const AnsiString & - название таблицы
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на запись о таблице, название которой передается в параметрах метода.
* bool is_column_autoinc(const AnsiString &)
Позволяет узнать, является ли указанное поле таблицы автоинкрементным.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
True - поле автоинкрементно;
False - поле не автоинкрементно.
Комментарии:
Позволяет узнать, установлено ли свойство автоинкрементности для необходимой колонки таблицы, запись о которой является текущей в данный момент.
* bool is_column_indexed(const AnsiString &)
Позволяет узнать, является ли указанное поле таблицы индексированным.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
True - свойство индексации установлено;
False - свойство индексации не установлено.
Комментарии:
Позволяет узнать, установлено ли свойство индексации для необходимой колонки таблицы, запись о которой является текущей в данный момент.
* bool is_column_linked(const AnsiString &)
Позволяет узнать, содержит ли данная колонка ссылку.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
True - поле содержит ссылку;
False - поле не содержит ссылку.
Комментарии:
Позволяет узнать, содержит ли поле ссылку, т.е. ограничиваются ли возможные значения данной колонки определенным диапазоном значений, представленых в другой таблице. Рассматривается поле таблицы, запись о которой является текущей на данный момент.
* bool is_column_unique(const AnsiString &)
Позволяет узнать, установлено ли свойство уникальности для указанного поля.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
True - свойство уникальности установлено;
False - свойство уникальности не установлено.
Комментарии:
Позволяет узнать, установлено ли свойство уникальности для указанной колонки. Установка этого свойства гарантирует проверку значений поля таблиы на уникальность. Рассматривается поле таблицы, запись о которой является текущей в данный момент.
* void next_record()
Перейти на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Переводит “курсор” на следующую запись в таблице (после текущей).
* void rename_table(const AnsiString &,const AnsiString &)
Переименовать таблицу.
Параметры:
const AnsiString & - текущее название таблицы;
const AnsiString & - новок название таблицы.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить название необходимой таблицы в базе данных.
* void set_record(unsigned int)
Установить позицию “курсора”.
Параметры:
unsigned int - локальный индекс записи в источнике данных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить “курсор” на указанную запись в таблице, т.е. изменить текущую позицию “курсора”
* bool type_can_autoinc(const AnsiString &)
Позволяет узнать, может ли указанный тип быть автоинкрементным.
Параметры:
const AnsiString & - название типа данных.
Возвращаемые значения:
True - если для поля такого типа можно установить свойство автоинкрементности;
False - для поля указанного типа невозможно установить свойство автоинкрементности.
Комментарии:
При передаче параметров, тип следует указывать в формате, каким мы получаем его при использовании свойства types_list (т.е. int, а не целый; TPicture *, а не графика и т.п.). Все доступные для использования типы можно получить, воспользовавшись свойством tipes_list.
Смотри также:
* bool type_can_indexed(const AnsiString &)
Позволяет узнать, может ли указанный тип быть индексированным.
Параметры:
const AnsiString & - название типа данных.
Возвращаемые значения:
True - если для поля такого типа можно установить свойство индексированности;
False - для поля указанного типа невозможно установить свойство индексированности.
Комментарии:
При передаче параметров, тип следует указывать в формате, каким мы получаем его при использовании свойства types_list (т.е. int, а не целый; TPicture *, а не графика и т.п.). Все доступные для использования типы можно получить, воспользовавшись свойством tipes_list.
Смотри также:
* bool type_can_link(const AnsiString &)
Позволяет узнать, может ли поле указанного типа содержать ссылку.
Параметры:
const AnsiString & - название типа данных.
Возвращаемые значения:
True - если поле указанного тип может содержать ссылку;
False - поле указанного типа не может содержать ссылку.
Комментарии:
При передаче параметров, тип следует указывать в формате, каким мы получаем его при использовании свойства types_list (т.е. int, а не целый; TPicture *, а не графика и т.п.). Все доступные для использования типы можно получить, воспользовавшись свойством tipes_list.
Смотри также:
* bool type_can_unique(const AnsiString &)
Позволят узнать, можна ли для поля указанного типа установить свойство уникальности.
Параметры:
const AnsiString & - название типа данных.
Возвращаемые значения:
True - если для поля такого типа можно установить свойство уникальности;
False - для поля указанного типа невозможно установить свойство уникальности.
Комментарии:
При передаче параметров, тип следует указывать в формате, каким мы получаем его при использовании свойства types_list (т.е. int, а не целый; TPicture *, а не графика и т.п.). Все доступные для использования типы можно получить, воспользовавшись свойством tipes_list.
Смотри также:
* AnsiString type_view_name(const AnsiString &)
Получить условное название типа данных, используемое в редакторе таблиц .
Параметры:
const AnsiString & - название типа данных.
Возвращаемые значения:
AnsiString - условное название указанного типа данных.
Комментарии:
При передаче параметров, тип следует указывать в формате, каким мы получаем его при использовании свойства types_list (т.е. int, а не целый; TPicture *, а не графика и т.п.). Все доступные для использования типы можно получить, воспользовавшись свойством tipes_list.
Смотри также:
Источник данных: table_<имя таблицы>
Каждая таблица, созданная пользователем
(см. Руководсто
пользователя, раздел Работа с таблицами на стр. 89),
может служить в качестве источника данных при формировании отчетов (таблица
инициализирована).
* unsigned
int position
Возвращает номер текущей позиции “курсора”.
* unsigned
int record_count
Возвращает общее количество записей в выборке (источнике данных).
* unsigned
int oid
Возвращает номер записи источника данных, под которым она храниться
в таблице (сквозная глобальная нумерация).
* unsigned
int global_record_count
Возвращает количество записей в таблице пользователя, не зависимо от
выборки источника данных.
* bool
autosave
Возвращает True если автосохранение включено, и False - в другом случае.
У всех источников данных типа table_<имя таблицы> есть общие (описаны
выше) и собственные свойства. Тип и количество таких свойств зависит
от количества и типа полей в таблице.
* void add_filter_set(const AnsiString &,const std::vector<Variant> &)
Установить фильтр данных.
Параметры:
const AnsiString & - название
колонки, данные которой необходимо отфильтровать;
const std::vector<Variant> & - массив значений, которые будут
отображаться в источнике данных в результате фильтрации.
Возвращаемые значения:
Нет.
Комментарии:
Отфильтровать строки таблицы, по указанному полю.Строка будет присутствовать в выборке, если значение (в указанной колонке) присутствует в “фильтре”.
* void add_filter_range(const AnsiString &,const Variant &,const Variant &)
Установить фильтр данных.
Параметры:
const AnsiString & - название
колонки, данные которой необходимо отфильтровать;
const Variant & - начальное значение диапазона значений для фильтрации;
const Variant & - конечное значение диапазона значений.
Возвращаемые значения:
Нет.
Комментарии:
В выборке присутствуют только строки , у которых значение (в соответствующей колонке) попадает в указанный диапазон (“с” - “по”).
* void add_filter_regexp(const AnsiString &,const AnsiString &)
Установить фильтр данных.
Параметры:
const AnsiString & - название
колонки, данные которой необходимо отфильтровать;
const AnsiString & - правило фильтрации, согласно которому будут
отфильтровываться данные указанного поля.
Возвращаемые значения:
Нет.
Комментарии:
В выборке присутствуют только строки , у которых значение (в соответствующей колонке) соответствует указанному правилу. Этот метод может применяться только к полям строкового типа.
Смотри также:
* void add_filter_regexp(const AnsiString &,const AnsiString &,int)
Установить фильтр данных с указанным параметром.
Параметры:
const AnsiString & - название
колонки, данные которой необходимо отфильтровать;
const AnsiString & - правило фильтрации, согласно которому будут
отфильтровываться данные указанного поля;
int - параметр, учивающийся при фильтрации.
Возвращаемые значения:
Нет.
Комментарии:
В выборке присутствуют только строки , у которых значение (в соответствующей колонке) соответствует указанному правилу. Этот метод может применяться только к полям строкового типа. Перечень доступных параметров, с учетом которых будет производиться фильтрация: “1” - без учета регистра символов;
Смотри также:
* void add_filter_ethalon(const AnsiString &,const Variant &)
Установить фильтр данных
Параметры:
const AnsiString & - название
колонки, данные которой необходимо отфильтровать;
const Variant & - значение;
Возвращаемые значения:
Нет.
Комментарии:
Фильтрация данных таблицы по одному значнию, из указанной колонки.
Смотри также:
* void add_sorter(const AnsiString &)
Сортировка колонки таблицы по возрастанию.
Параметры:
const AnsiString & - название колонки, данные которой необходимо отсортировать;
Возвращаемые значения:
Нет.
Комментарии:
Значения указанной колонки таблицы будут отсортированы по возрастанию.
* void add_sorter(const AnsiString &,bool)
Сортировка по возрастанию или убыванию.
Параметры:
const AnsiString & - название
колонки, данные которой необходимо отсортировать;
bool:
True - сортировка по возрастанию;
False - сортировка по убыванию.
Возвращаемые значения:
Нет.
Комментарии:
Значения указанной колонки таблицы будут отсортированы по возрастанию или убыванию, в зависимости от параметра bool.
* bool begin_change_session()
Монопольное использование таблицы.
Параметры:
Не передаются.
Возвращаемые значения:
True - если сессия была успешно открыта, т.е. установлен режим монопольного использования таблицы.
False - если сессию открыть не удалось.
Комментарии:
Установить режим монопольного использования таблицы (открытие сессии редактирования таблицы). При этом доступ к таблице другим пользователям будет запрещен. Только в монопольном режиме возможно редактирование данных таблицы.
Смотри также:
* void cancel_change_session()
Отмена монопольного режима.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Закрывает сессию редактирования таблицы без сохранения внесенных изменений. При этом таблица загружается с диска.
* void change_column_type(const AnsiString &,const AnsiString &)
Изменить тип поля таблицы.
Параметры:
const AnsiString & - название
колонки, тип которой необходимо изменить;
const AnsiString & - название нового типа колонки.
Возвращаемые значения:
Нет.
Комментарии:
При передаче параметров, тип поля указывется в формате, каким мы получаем его при использовании свойства types_list источника данных dbb_storeg. При невозможности изменить типа колонки (нельзя переконвертировать данные в указанный тип) будет сгенерировано сообщение об ошибке.
Смотри также:
* void change_field(const AnsiString &,unsigned int,const Variant &)
Изменение значение поля таблицы.
Параметры:
const AnsiString & - название
колонки;
unsigned int - локальный индекс записи в источнике данных;
const Variant & - новое значение.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить значение поля таблицы. Доступно только в монопольном режиме доступа к таблице.
Смотри также:
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных или нет и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void clear_filters()
Отменить фильтрацию.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет отменить установленное ранее правило фильтрации.
Смотри также:
* void clear_sorters()
Отменить сортировку.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет отменить установленное ранее правило и сортировки.
Смотри также:
* void create_column(const AnsiString &,const AnsiString &)
Создать колонку.
Параметры:
const AnsiString & - название создаваемого поля;
const AnsiString & - тип создаваемого поля.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет добавить новую колонку необходимого типа в таблицу. При передаче параметров, тип колонки необходимо передавать в формате, в каком мы получаем его при использовании свойства types_list.
Смотри также:
* void create_record(unsigned int)
Добавить запись.
Параметры:
unsigned int - глобальный индекс позиции, в которую будет добавлена новая запись.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет добавить запись в указанную позицию таблицы (доступно только при монопольном режиме доступа к таблице). В качестве параметра передается индекс позиции исходной таблицы (не источника данных).
* void delete_record(unsigned int)
Удалить запись.
Параметры:
unsigned int - глобальный индекс позиции в таблице, на которой находится удаляемая запись.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет удалить запись, находящуюся на указанной позиции в таблице (доступно только при монопольном режиме доступа к таблице). В качестве параметра передается индекс позиции в исходной таблице (не в источнике данных).
* void end_change_session()
Отмена монопольного режима доступа.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Если для указанной таблицы установлено свойствоautosave, то, при вызове данного метода, все внесенные изменения будут сохранены. Если свойство autosave не установлено — для сохранения изменений перед закрытием сессии необходимо вызвать метод save_table().
Смотри также:
* void erase()
Удалить запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет удалить запись, находящуюся на текущей позиции в источнике данных (доступно только при монопольном режиме доступа к таблице). В качестве параметра передается индекс позиции в источнике данных (не в исходной таблице).
* void erase(unsigned int)
Удалить запись.
Параметры:
unsigned int - локальный индекс позиции в источнике данных, на которой находится удаляемая запись.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет удалить запись, находящуюся на указанной позиции в таблице (доступно только при монопольном режиме доступа к таблице). В качестве параметра передается индекс позиции в исходной таблице (не в источнике данных).
* void erase_all()
Удалить всю таблицу.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет удалить всю таблицу из базы данных, не зависимо от выборки.
* void erase_selection()
Удалить данные в таблице.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет удалить данные из таблицы, котрые попадают под выборку (ранее примененное правило фильтрации, сортировки и т.п.).
* AnsiString field_as_string(const AnsiString &)
Получить значение текущей записи указанного поля в виде строки.
Параметры:
const AnsiString & - название поля таблицы.
Возвращаемые значения:
AnsiString - значение поля в виде строки.
Комментарии:
Позволяет получить значение текущей записи указанной колонки. Рекомендуется использовать этот метод до применения методов фильтрации add_filter_regexp().
Смотри также:
* Variant field_val(const AnsiString &)
Получить значение колонки текущей записи.
Параметры:
const AnsiString & - название поля таблицы.
Возвращаемые значения:
Variant - значение указанного поля текущей записи.
Комментарии:
Позволяет получить значение текущей записи указанной колонки.
* bool find_first(const AnsiString &,const Variant &)
Поиск данных (с начала).
Параметры:
const AnsiString & - название
колонки для поиска;
const Variant & - искомое значение.
Возвращаемые значения:
True - если найдены необходимые данные;
False - если необходимые данные не найдены.
Комментарии:
Поиск данных в указанной колонке выполняется с начала таблицы. Используйте эту команду для ускорения поиска, если заведомо известно, что нужная информация находится ближе к началу таблицы.
Смотри также:
* bool find_last(const AnsiString &,const Variant &)
Поиск данных (с конца).
Параметры:
const AnsiString & - название
колонки для поиска;
const Variant & - искомое значение.
Возвращаемые значения:
True - если найдены необходимые данные;
False - если необходимые данные не найдены.
Комментарии:
Поиск данных в указанной колонке выполняется с конца таблицы. Используйте эту команду для ускорения поиска, если заведомо известно, что нужная информация находится ближе к концу таблицы.
Смотри также:
* bool find_next(const AnsiString &,const Variant &)
Поиск данных (с текущей позиции до последней).
Параметры:
const AnsiString & - название
колонки для поиска;
const Variant & - искомое значение.
Возвращаемые значения:
True - если найдены необходимые данные;
False - если необходимые данные не найдены.
Комментарии:
Используется для поиска данных с текущей позиции (“курсора” в таблице). Направление поиска — от текущей строки таблицы до последней.
Смотри также:
* bool find_prev(const AnsiString &,const Variant &)
Поиск данных (с текущей позиции до первой).
Параметры:
const AnsiString & - название
колонки для поиска;
const Variant & - искомое значение.
Возвращаемые значения:
True - если найдены необходимые данные;
False - если необходимые данные не найдены.
Комментарии:
Используется для поиска данных с текущей позиции (“курсора” в таблице). Направление поиска — от текущей строки таблицы до первой.
Смотри также:
* void first_record()
Установить “курсор” в начало таблицы.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Установить “курсор” на первую запись в таблице.
Смотри также:
* Variant get_autoinc(const AnsiString &)
Получить автоинкремент.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
Variant - Значение автоинкремента указанной колонки.
Комментарии:
Позволяет получить последнее присвоенное значение автоинкремента указанной колонки.
* std::vector<AnsiString> get_columns_list()
Получить список полей таблицы.
Параметры:
Не передаются.
Возвращаемые значения:
std::vector<AnsiString> - массив названий колонок таблицы.
Комментарии:
Позволяет получить список отображаемых в редакторе полей таблицы, не включая поля глобальных индексов, ссылочные поля, получаемые из других таблиц и т.п.
Смотри также:
* std::vector<AnsiString> get_fields_list()
Получить список всех полей таблицы.
Параметры:
Не передаются.
Возвращаемые значения:
std::vector<AnsiString> - массив названий всех колонок таблицы.
Комментарии:
Позволяет получить список всех полей таблицы, включая поля глобальных индексов, ссылочные поля, получаемые из других таблиц и т.п.
Смотри также:
* AnsiString get_field_type(const AnsiString &)
Получить тип поля таблицы.
Параметры:
const AnsiString & - название колонки таблицы.
Возвращаемые значения:
AnsiString - тип поля указанной колонки.
Комментарии:
Позволяет получить тип указанного поля таблицы. Тип получим в формате, в котором мы его получаем при использовании свойства types_list. Можно пулучить тип не только тех полей, которые отображаютс в редакторе таблицы, но также тип ссылочных полей, получаемых из других таблиц.
Смотри также:
* Variant get_default(const AnsiString &)
Получить значение колонки, указываемое по умолчанию.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
Значение, устанавливаемое по умолчанию для указанной колонки.
Комментарии:
Позволяет получить последнее присвоенное значение автоинкремента указанной колонки.
* std::vector<Variant> get_linked_ids_list(const AnsiString &)
Получить список допустимых значений ключевого поля.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
std::vector<Variant> - массив допустимых значений ключевого поля, по которому строится ссылка.
Комментарии:
Позволяет получить список всех возможных значений ключевого поля.
* std::vector<Variant> get_linked_sub_list(const AnsiString &)
Получить список допустимых значений, подставляемых из ссылочной таблицы.
Параметры:
const AnsiString & - название колонки таблицы
Возвращаемые значения:
std::vector<Variant> - массив значений, которые отображаются в редакторе таблиц.
Комментарии:
Позволяет получить список всех значений, которые могут быть выбраны (подставленны) в указанное поле.
* AnsiString get_table_name()
Получить название таблицы.
Параметры:
Не передаются.
Возвращаемые значения:
AnsiString - название таблицы.
Комментарии:
Позволяет получить название талицы данных.
* unsigned int global2local(unsigned int)
Преобразовывает глобальный индекс записи в локальный.
Параметры:
unsigned int - глобальный индекс записи в таблице.
Возвращаемые значения:
unsigned int - локальный индекс записи
в источнике данных.
Если преобразование невозможно — возвращает “-1”.
Комментарии:
Позволяет получить значение локального индекса записи источника данных, указав значение глобального индекса этой записи в таблице.
* void insert(unsigned int,const std::vector<AnsiString> &,const std::vector<Variant> &)
Вставка записи.
Параметры:
unsigned int - глобальный индекс создаваемой записи в таблице.
const std::vector<AnsiString> & - массив названий полей, значений которых необходимо указать при создании записи,
const std::vector<Variant> & - массив значений указанных полей.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет создавать запись с необходимыми параметрами в указанных полях. Все остальные поля заполняются либо автоинкрементным значением, либо значением по умолчанию.
* bool is_autoinc(const AnsiString &)
Позволяет узнать, является ли поле автоинкрементным.
Параметры:
const AnsiString & - название колонки.
Возвращаемые значения:
True - свойство автоинкремента установлено;
False - свойство автоинкремента не установлено.
Комментарии:
Позволяет узнать устанволено ли свойство автоинкремента для указанной колонкию.
* bool is_column_linked(const AnsiString &)
Позволяет узнать, является ли колонка ссылкой.
Параметры:
const AnsiString & - название колонки.
Возвращаемые значения:
True - колонка является ссылкой;
False - колонка не является ссылкой.
Комментарии:
Позволяет узнать, является поле ссылкой или нет, т.е. подставляются в это поле значение из ссылочных таблиц или нет.
* bool is_indexed(const AnsiString &)
Позволяет узнать,является ли колонка индексированоой.
Параметры:
const AnsiString & - название колонки.
Возвращаемые значения:
True - колонка индексированная;
False - колонка не индексированная.
Комментарии:
Позволяет узнать устанволено ли свойство индексации для указанной колонкию.
* bool is_unique(const AnsiString &)
Позволяет узнать, установлено ли свойство уникальности для указанной колонки.
Параметры:
const AnsiString & - название колонки.
Возвращаемые значения:
True - свойство уникальности установлено;
False - свойство уникальности не установлено.
Комментарии:
При устанвовленном свойстве уникальности все значения указанной колонки будут проверяться на уникальность.
* void load_table()
Перегрузить таблицу.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет загрузить таблицу с диска в оперативную память. Все сделанные изменения будут потеряны (доступно только в монопольном режиме использования таблицы).
* unsigned int local2global(unsigned int)
Преобразовывает локальный индекс записи в глобальный.
Параметры:
unsigned int - локальный индекс записи в источнике данных.
Возвращаемые значения:
unsigned int - глобальный индекс записи в таблице.
Если преобразование невозможно — возвращает “-1”.
Комментарии:
Позволяет получить значение глобального индекса записи таблицы, указав значение локального индекса этой записи в источнике данных.
* void move_global_record(unsigned int,unsigned int)
Переместить запись в таблице.
Параметры:
unsigned int - глобальный индекс записи в таблице;
unsigned int - глобальный новый индекс записи в таблице, куда эта запись будет перемещена.
Возвращаемые значения:
Нет.
Комментарии:
При использовании этого метода записи с глобальными индексами “старый индекс” и “новый индекс” поменяются местами. Если указан несуществующий глобальный индекс – будет сгенерировано сообщение об ошибке.
* Variant next_autoinc(const AnsiString &)
Увеличение значения автоинкремента.
Параметры:
const AnsiString & - название поля.
Возвращаемые значения:
Variant - значение автоинкремента.
Комментарии:
Позволяет увеличить значение автоинкремента. Для поля типа “целый” автоинкремент увеличивается на “1”, для поля типа “время” — на одну секунду и т.п.
* void next_record()
Перейти на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Переводит “курсор” на следующую запись в таблице (после текущей).
Смотри также:
* unsigned int position()
Получить номер текущей позиции “курсора”.
Параметры:
Не передаются.
Возвращаемые значения:
unsigned int - номер текущей позиции.
* unsigned int push_back(const std::vector<AnsiString> &,const std::vector<Variant> &)
Вставка записи в конец таблицы.
Параметры:
const std::vector<AnsiString> & - массив названий полей;
const std::vector<Variant> & - массив значений указанных полей.
Возвращаемые значения:
unsigned int - глобальный индекс созданной записи.
Комментарии:
Позволяет вставить запись в конец таблицы. При этом в указанных полях будут отображены указанные параметры. Во всех остальных полях будут вставлены значения автоинкремента либо значения по умолчанию.
* unsigned int pushback_record()
Вставка записи в конец таблицы.
Параметры:
Не передаются.
Возвращаемые значения:
Глобальный индекс созданной записи.
Комментарии:
Позволяет вставить запись в конец таблицы. При этом во всех полях созданной записи будут указаны значения автоинкремента или значения по умолчанию.
* unsigned int record_count()
Получить количество записей в источнике
данных.
Параметры:
Не передаются.
Возвращаемые значения:
Общее количестов записей в источнике данных (не в таблице).
Смотри также:
* void remove_column(const AnsiString &)
Удалить колонку.
Параметры:
const AnsiString & - название необходимой колонки.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет удалить колонку из таблицы.
* void rename_column(const AnsiString &,const AnsiString &)
Переименовать колонку таблицы.
Параметры:
const AnsiString & - старое название поля;
const AnsiString & - новое название поля.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переименовать нужную колонку в таблице.
* void reserve(unsigned int)
Резервирование памяти.
Параметры:
unsigned int - количество записей.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет зарезервировать блок памяти при необходимости добавления в таблицу n записей (n - достаточно велико). При добавлении большого количества записей, не использовав предварительно этот метод, записи будут сохраняться в различных участках памяти. При использовании этого метода будет выделен необходимый блок памяти, в которм записи будут сохраняться “подряд”. Этот метод способствует избежанию фрагментации памяти.
* void save_table()
Сохранение таблицы.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет сохранить все изменения, сделанные в таблице. Доступно только в монопольном режиме использования таблицы. Используется перед закрытием сессии редактирования для сохранения изменений, если не установлено свойство autosave.
Смотри также:
* void set_autoinc(const AnsiString &,const Variant &)
Установить значение автоинкремента.
Параметры:
const AnsiString & - название поля;
const Variant & - необходимое значение автоинкремента.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить значение автоинкремента выбранного поля на необходимое значение.
Смотри также:
* void set_autoincrement(const AnsiString &,bool)
Установить/блокировать свойство автоинкремента.
Параметры:
const AnsiString & - название колонки таблицы;
bool:
True - установить автоинкремет;
False - отменить автоинкремент.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить или отменить установлку свойства автоинкремента для указанного поля таблицы.
* void set_autosave(bool)
Установить/блокировать автосохранение.
Параметры:
bool:
True - установить автосохранение;
False - отменить автосохранение.
Возвращаемые значения:
Нет.
Комментарии:
Если автосохранение не установлено, после изменения данных, перед закрытием сессии редактирования необходимо вызывать метод save_table().
Смотри также:
* void set_change_session()
Начать сессию редактирования таблицы (монопольное использование).
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Установить режим монопольного использования таблицы (открытие сессии редактирования таблицы). При этом доступ к таблице другим пользователям будет запрещен. Только в монопольном режиме возможно редактирование данных таблицы. При невозможности начать сессию редактирования будет сгенерировано соответствующее сообщение.
Смотри также:
* void set_default(const AnsiString &,const Variant &)
Установить значение по умолчанию.
Параметры:
const AnsiString & - название поля;
const Variant & - значение.
Возвращаемые значения:
Нет.
Комментарии:
Это значение будет автоматически указываться в поле при создании новой записи.
Смотри также:
* void set_indexed(const AnsiString &,bool)
Установить/блокировать свойство индексированности.
Параметры:
const AnsiString & - название колонки;
bool:
True - установить свойство индексированности;
False - отменить свойство индексированности.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить свойство индексированности для указанной колонки таблицы.
* void set_record(unsigned int)
Установить позицию “курсора”.
Параметры:
unsigned int - локальный индекс записи в источнике данных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить “курсор” на указанную запись в таблице, т.е. изменить текущую позицию “курсора”
* void set_unique(const AnsiString &,bool)
Установить/блокировать свойство уникальности.
Параметры:
const AnsiString & - название колонки;
bool:
True - установить свойство уникальности;
False - отменить свойство уникальности.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет установить свойство уникальности для указанной колонки таблицы. Каждая запись поля будет проверяться на уникальность.
* void update(unsigned int,const std::vector<AnsiString> &,const std::vector<Variant> &)
Редактирование записи.
Параметры:
unsigned int - локальный индекс записи в источнике данных;
const std::vector<AnsiString> & - массив названий редактируемых полей;
const std::vector<Variant> & - массив новых значений указанных полей источника данных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить необходимые поля записи.
* void update(const std::vector<AnsiString> &,const std::vector<Variant> &)
Редактирование текущей записи.
Параметры:
const std::vector<AnsiString> & - массив названий редактируемых полей;
const std::vector<Variant> & - массив новых значений указанных полей источника данных.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет изменить необходимые поля текущей записи.
Класс, который позволяет инициализировать любую доступную таблицу базы данных в качестве источника данных на этапе формирования отчета, что позволяет создавать универсальные отчеты, не привязанные к конкретной таблице.
Все свойства источника данных table_<имя таблицы> (см. Источник данных: table_<имя таблицы> на стр. 135).
Методы
Все методы источника данных table_<имя таблицы> (см. Источник данных: table_<имя таблицы> на стр. 135).
* void init(const AnsiString &)
Инициализация таблицы.
Параметры:
const AnsiString & - название таблицы.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет инициализировать любую доступную таблицу базы данных для использования ее в качестве источника данных в ходе формирования отчета.
* bool show_dialog(AnsiString &)
Отображает диалоговое окно инициализации источника данных (таблицы).
Параметры:
AnsiString & - название таблицы
Возвращаемые значения:
True - если диалоговое окно создано;
False - при возникновении ошибки.
Комментарии:
Этот метод используется для передачи значений, выбранных пользователем, в отчет. Используется для источников данных (таблиц), не инициализированных при создании отчета (см. раздел Создание и удаление отчета на стр. 7.). Полученные параметры передаются в метод init().
Смотри также:
Источник данных, предоставляющий информацию о пользователе, его лицензии, правах на выполнение операций и т.п. Хранение данных источника организовано в виде таблицы.
* int
acl_id
Возвращает идентификатор “прав пользователя” в списке всех доступных
“прав”.
* int
backend_id
Возвращает номер соединения с сервером.
* AnsiString
disp_host
Возвращает адрес диспетчерского сервера.
* int
disp_port
Возвращает номер порта диспетчерского сервера.
* TDateTime
expires
Возвращает дату окончания действия лицензии на доступ к серверу.
* int
group_id
Возвращает идентификатор группы мобильных объектов пользователя.
* AnsiString
host_id
Возвращает регистрационный номер пользователя (на сервере).
* AnsiString
login
Возвращает логин пользователя.
* AnsiString
org_name
Возвращает название организации, использующей данное программное обеспечение.
Это название было указано пользователем при регистрации программного
обеспечния на сервере мобильных объектов.
* AnsiString
perm
Возвращает, в виде, строки разрешение на выполнение операции.
* int
perm_id
Возвращает идентификатор разрешения на выполнение операции.
* int
sym_id
Возвращает константу sym_id, которая ставится в соответствие каждому
идентификатору разрешения perm_id.
* int
user_id
Возварщает идентификатор пользователя.
* AnsiString
user_name.
Возвращает имя пользователя, использующего данное програмное обеспечение
(указывалось при регистрации программного обеспечения на сервере мобильных
объектов).
* unsigned
int position
Возвращает номер текущей позиции.
* unsigned
int record_count
Возвращает общее количество записей в выборке.
* int
condition_id
Возвращает идентификатор события.
* int
custom_id
Возвращает идентификатор запроса
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных или нет и, в зависимости от результата, возвращает соответствующее значение.
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на первую запись таблицы источника данных.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на необходимую запись в таблице источника данных.
Смотри также:
* bool can_edit_group_plan(int)
Проверка разрешения на редактирование плана.
Параметры:
int - идентификатор группы мобильных объектов.
Возвращаемые значения:
True - если пользователь может редактировать план для указанной группы мобильных объектов;
False - если редактироване не доступно.
Смотри также:
* bool can_view_group_plan(int)
Проверка разрешения на просмотр плана.
Параметры:
int - идентификатор группы мобильных объектов.
Возвращаемые значения:
True - если пользователь может просматривать план для указанной группы мобильных объектов;
False - если просмотр не доступен.
Смотри также:
* bool is_permitted(int,int)
Проверка разрешения на выполнение запроса.
Параметры:
int - идентификатор мобильного объекта;
int - идентификатор разрешения на выполнение операции (perm_id)
Возвращаемые значения:
True - если пользователь может выполнить запрос для данного мобильного бъекта;
False - если выполнение запроса не доступно.
Смотри также:
* int perm2sym(int)
Получить системное значение (sym_id) разрешения на операцию.
Параметры:
int - идентификатор разрешения на выполнение операции (perm_id).
Возвращаемые значения:
Число (sym_id), соответствующее указанному идентификатору разрешения на операцию (perm_id).
Комментарии:
Позволяет получитть системное значение (sym_id), соответствующее указанному идентификатору разрешения на операцию.
Смотри также:
* int condition2perm(int)
Получить идентификатор разршения на операцию (perm_id).
Параметры:
int - идентификатор события.
Возвращаемые значения:
Идентификатор разрешения на операцию.
Комментарии:
Позволяет получить идентификатор разрешения на операцию в соответствии с указанной ситуацией.
Смотри также:
* AnsiString condition2str(int)
Получить строку события.
Параметры:
int - идентификатор события.
Возвращаемые значения:
Текстовая строка события.
Смотри также:
* int custom2perm(int)
Получить идентификатор разрешения на операцию.
Параметры:
int - идентификатор запроса.
Возвращаемые значения:
Идентификатор разрешения на операцию.
Комментарии:
Позволяет получить идентификатор разрешения на операцию в соответствии с указанным запросом.
Смотри также:
* AnsiString custom2str(int)
Получить строку запроса.
Параметры:
int - идентификатор запроса.
Возвращаемые значения:
Текстовая строка запроса.
Смотри также:
* int perm2condition(int)
Получить идентификатор события.
Параметры:
int - идентификатор разрешения на операцию.
Возвращаемые значения:
Идентификатор события.
Комментарии:
Позволяет получить идентификатор события в соответствии с идентификатором разрешения на операцию.
Смотри также:
* int perm2custom(int)
Получить идентификатор запроса.
Параметры:
int - идентификатор разрешения на операцию.
Возвращаемые значения:
Идентификатор запроса.
Комментарии:
Позволяет получить идентификатор запроса в соответствии с идентификатором разрешения на операцию.
Смотри также:
* bool perm_filter(const std::vector<int> &,int)
Проверка разрешения выполнения запроса.
Параметры:
const std::vector<int> - массив
идентификаторов мобильных объектов;
int - идентификатор разрешения на операцию (perm_id).
Возвращаемые значения:
True - если пользователь может выполнить запрос для указанных мобильных объектов;
False - если выполнение запроса не доступно.
Смотри также:
* int sym2perm(int)
Получить идентификатор разрещения на операцию (perm_id).
Параметры:
int - системное значение разрешения на операцию (sym_id).
Возвращаемые значения:
Идентификатор разрешения на операцию (perm_id), соответствующий указанному символьному значению (sym_id).
Комментарии:
Позволяет получитть идентификатор разрешения на операцию (perm_id), соответствующий указанному символьному значению.
Смотри также:
* AnsiString sym2str(int)
Получить разрешение на операцию в виде строки.
Параметры:
int - системное значение разрешения на операцию (sym_id).
Возвращаемые значения:
Разрешение на операцию в виде строки.
Комментарии:
Позволяет получитть разрешение на операцию, соответствующее указанному системному значению (sym_id).
Смотри также:
* int sym_filter(std::vector<int> &,std::vector<int> &,int)
Получить перечень мобильных объектов, для которых допустимо выполнение указанной операции.
Параметры:
std::vector<int> & - массив
проверяемых мобильных объектов. В этом массиве будут сохранены идентификаторы
мобильных объектов, для которых допустимо выпольнить указанную операцию;
std::vector<int> & - произвольный массив. В этом массиве будут
сохранены идентификаторы мобильных объектов, для которых выполнение
операции не допустимо;
int - системное значение разрешения на операцию (sym_id).
Возвращаемые значения:
-1 — если в перечне проверяемых мобильных объектов нет ни одного, для которого можно выполнить операцию;
0 — если для всех проверяемых мобильных объектов можно выполнить указанную операцию;
1 — если для некоторых мобильных объектов (в перечне проверяемых) можно выполнить указанную операцию, а для некоторых – нет.
Комментарии:
Позволяет определить для каких объектов возможно выполнить указанную операцию, а для каких – нет.
Смотри также:
* bool sym_filter(const std::vector<int>,int)
Проверка, возможно ли выполнить указанную операцию хотя бы для одного мобильного объекта из указанных.
Параметры:
std::vector<int> & - массив
идентификаторов проверяемых мобильных объектов.
int - системное значение разрешения на операцию (sym_id).
Возвращаемые значения:
True - если хотя бы для одного мобильного
объекта, из массива, можно выполнить запрос;
False - для перечисленных объектов выполнение запроса не возможно.
Комментарии:
Позволяет определить для каких объектов возможно выполнить указанную операцию, а для каких – нет.
Смотри также:
sym_is_permitted()
* bool sym_is_permitted(int,int)
Возможно ли выполнение указанного действия для мобильного объектаПроверка разрешения на выполнение действия для данного мобильного объекта.
Параметры:
int - идентификатор мобильного объекта;
int - системное значение идентификатора разрешения на выполнение операции
(sym_id).
Возвращаемые значения:
True - если выполнение запроса для
данного мобильного объекта допустимо;
False - если выполнение запроса не допустимо.
Комментарии:
Позволяет определить для каких объектов возможно выполнить указанную операцию, а для каких – нет.
Источник данных: distance_lines
Доступен только во время измерения расстояния на карте (см. Руководсто пользователя, раздел Измерение расстояния. на стр. 36). Позволяет получить доступ к различным данным, относящимся к определению расстояния. Хранение данных источника организовано в виде таблицы.
При измерении расстояния в окне Расстояниеи все сегменты записываются
в порядке, обратном их появлению на карте, а в отчете - в порядке, согласно
которому они появлялись на карте.
* double
distance
Возвращает длинну сегмента в текущей позиции таблицы данных.
* bool
is_selected
Возвращает True - если сегмент текущей записи таблицы выделен в окне
Расстояни, или False в другом случае.
* unsigned
int position.
Возвращает номер текущей позиции “курсора”.
* unsigned
int record_count.
Возвращает общее количество записей в выборке.
* double
selected_distance
Возвращает длинну выделенных сегментов.
* double
total_distance
Возвращает общую длинну всех сегментов.
* double
x1
Возвращает х-координату начальной точки сегмента текущей записи таблицы.
* double
x2
Возвращает х-координату конечной точки сегмента текущей записи таблицы.
* double
y1
Возвращает у-координату начальной точки сегмента текущей записи таблицы.
* double
y2
Возвращает у-координату конечной точки сегмента текущей записи таблицы.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных. В зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” в таблице источника данных на первую запись.
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на нужную запись в талице источника данных.
Смотри также:
* void view_selected()
Показать выделенные сегменты.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Используется для отображения на карте выделенных (в окне Расстояние) сегментов. При этом участок карты с выделеными сегментами масштабируется и размещается таким образом, чтоб были видны все выделенные сегменты.
* void view_total()
Показать все сегменты.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Используется для отображения на карте всех сегментов. При этом участок карты масштабируется и размещается таким образом, чтоб были видны все сегменты
Источник данных: objinf_window
Источник информации, позволяющий получить доступ к данным окна доступных мобильных объектов (см. Руководсто пользователя, Глава 2 на стр. 27). Хранение данных источники организовано в виде таблицы.
* int
first_selected
Возвращает идентификатор первого выделенного объекта в окне Досупные
мобильные объекты.
* bool
is_selected
Возвращает True - если мобильный объект текущей записи таблицы выделен
в окне Доступные мобильные объекты, или False в другом случае.
* int
obj_id
Возвращает идентификатор мобильного объекта текущей записи таблицы.
* unsigned
int position.
Возвращает номер текущей позиции “курсора”.
* unsigned
int record_count.
Возвращает общее количество записей в выборке.
* int
selected_count
Возвращает количество объектов, выделенных в окне Доступные мобильные
объекты.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных. В зависимости от результата, возвращает соответствующее значение.
Смотри также:
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” в таблице источника данных на первую запись.
Смотри также:
* bool is_active()
Проверка доступности источника данных.
Параметры:
Не передаются.
Возвращаемые значения:
True - если источник данных доступен
(даже если он не инициализирован);
False - если источник данных не доступен.
Комментарии:
Проверяет доступен ли источник данных в данном отчете.
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на нужную запись в таблице источника данных.
Смотри также:
Источник данных: plugin_version
Источник данных, позволяющий получить доступ к информации о плагинах для различных устройст сбора и передачи информации (см. Приложение на стр. 95). Хранение даных источника организовано в виде таблицы.
.
* AnsiString
binary_file
Возвращает путь к загруженному файлу плагина текущей записи таблицы.
* AnsiString
binary_name
Возвращает имя файла плагина текущей записи таблицы.
* int
charset
Возвращает кодировку языка, при которой был “собран” плагин.
* int
commands_count
Возвращает количество команд управления, коотрые поддерживает устройство.
* int
dev_id
Возвращает идентификатор устройства сбора и передачи информации.
* int
internal_ver
Возвращает “внутреннюю” версию плагина.
* int
lang
Возвращает идентификатор языка, при котором был “собран” плагин.
* AnsiString
plugin_name
Возвращает название плагина в виде строки.
* unsigned
int position.
Возвращает номер текущей позиции “курсора”.
* unsigned
int record_count.
Возвращает общее количество записей в выборке.
* int
requests_count
Возвращает количество общих запросов, которые поддерживает устройство.
* AnsiString
version
Возвращает версии плагина в виде строки.
* bool
version_info_present
Возвращает True — если есть информация о плагине или False в другом
случае.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных. В зависимости от результата, возвращает соответствующее значение.
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” в таблице источника данных на первую запись.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на нужную запись в талице источника данных.
Смотри также:
* int commands_id(unsigned int)
Номер команды.
Параметры:
unsigned int - идентификато управляющей команды.
Возвращаемые значения:
Порядковый номер команды.
Комментарии:
Получить порядковый номер команды в перечне всех команд устройства сбора и передачи информации.
* AnsiString commands_name(unsigned int)
Получить название команды.
Параметры:
unsigned int - идентификатор управляющей команды.
Возвращаемые значения:
Строка названия команды управления.
Комментарии:
Плучить название управляющей команды устройства сбора и передачи информаци по ее идентификатору.
* AnsiString get_version_parameter(AnsiString)
Получить параметры версии плагина.
Параметры:
AnsiString - название параметра (в виде строки). Существует ряд стандартных параметров, таких как: CompanyName, FileDescription, FileVersion, ProductVersion, InternalName, ProductName и т.д.
Возвращаемые значения:
Значение указанного параметра в виде строки.
* int requests_id(unsigned int)
Получить номер запроса.
Параметры:
unsigned int - идентификатор запроса.
Возвращаемые значения:
Порядковый номер запроса.
Комментарии:
Получить порядковый номер запроса в перечне всех запросов устройства сбора и передачи информации.
* AnsiString requests_name(unsigned int)
Поучить название запроса.
Параметры:
unsigned int - идентификатор запроса.
Возвращаемые значения:
Название запроса в виде строки.
Комментарии:
Получить название запроса устройства сбора и передачи информации по его идентификатору.
Источник данных: binary_version
* AnsiString
binary_file
Возвращает путь к загруженному выполняющемуся файлу (exe, dll, bpl )
текущей записи таблицы, находящемуся в директории главного запускаещего
файла программы.
* AnsiString
binary_name
Возвращает название загруженного выполняющегося файла (exe, dll, bpl
) текущей записи программы, находящегося в директории главного запускаещего
файла программы.
* int
charset
Возвращает кодировку, при которой был “собран” файл текущей записи таблицы.
* AnsiString
exe_file
Возвращает путь к запускающему файлу программы
* AnsiString
exe_name
Возвращает название запускающегося файла программы.
* int
lang
Возвращает язык, при котором был “собран” файл текущей записи таблицы.
* unsigned
int position.
Возвращает номер текущей позиции “курсора”.
* unsigned
int record_count.
Возвращает общее количество записей в выборке.AnsiString version
* bool
version_info_present
Возвращает True — если есть информация о плагине или False в другом
случае.
* int bin_charset(AnsiString)
Параметры:
AnsiString - название (binary_name) или путь (binary_file) к файлу.
Возвращаемые значения:
Идентификатор кодировки, при которой был “собран” указанный файл.
* int bin_lang(AnsiString)
Параметры:
AnsiString - название (binary_name) или путь (binary_file) к файлу.
Возвращаемые значения:
Идентификатор языка, при котором был “собран” указанный файл.
* AnsiString bin_version(AnsiString)
Параметры:
AnsiString - название (binary_name) или путь (binary_file) к файлу.
Возвращаемые значения:
Версии указанного файла в виде строки.
* AnsiString bin_version_parameter(AnsiString,AnsiString)
Получить параметр версии файла.
Параметры:
AnsiString - название (binary_name) или путь (binary_file) к файлу.
AnsiString - название параметра (в виде строки). Существует ряд стандартных параметров, таких как: CompanyName, FileDescription, FileVersion, ProductVersion, InternalName, ProductName и т.д.
Возвращаемые значения:
Значение указанного параметра в виде строки.
* bool check_eod()
Проверка окончания потока данных.
Параметры:
Не передаются.
Возвращаемые значения:
True — если обнаружено окончание потока данных;
False — если окончание потока данных не обнаружено.
Комментарии:
Определяет достигнуто ли окончание потока данных. В зависимости от результата, возвращает соответствующее значение.
* void first_record()
Переместиться на первую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” в таблице источника данных на первую запись.
Смотри также:
* void next_record()
Переместиться на следующую запись.
Параметры:
Не передаются.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на следующую за текущей запись в таблице источника данных.
Смотри также:
* void set_record(unsigned int)
Переместиться на необходимую запись.
Параметры:
unsigned int - число, указывающее номер записи, на которую необходимо переместиться.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет переместить “курсор” на нужную запись в талице источника данных.
Смотри также:
* AnsiString get_version_parameter(AnsiString)
Получить параметры версии файла текущей записию.
Параметры:
AnsiString - название параметра (в виде строки). Существует ряд стандартных параметров, таких как: CompanyName, FileDescription, FileVersion, ProductVersion, InternalName, ProductName и т.д.
Возвращаемые значения:
Значение указанного параметра в виде строки.
* bool version_info_present(AnsiString)
Проверка наличия информации о файле.
Параметры:
AnsiString - название (binary_name) или путь (binary_file) к файлу.
Возвращаемые значения:
True — если информация о файле присутствует;
False — если информации о файле нет.
* bool empty
Возвращает True если разрешенная зона не установлена и False в другом случае.
* double latitude
Возврощает широту установленной зоны.
* double longitude
Возврощает долготу установленной зоны.
* double radius
Возвращает радиус установленной зоны.
* void set_empty(bool)
Установить или отменить установку зоны.
Параметры:
True — разрешить режим установки зоны;
False — запретить режим установки зоны.
Возвращаемые значения:
Нет.
Комментарии:
Позволяет перейти в режим установки или отмены установки зоны. После использования этого метода можно использовать соответствующий метод установки координат радиуса, долготы и широты разрешенной зоны.
Смотри также:
* void set_values(double,double,double)
Установить параметры зоны.
Параметры:
double — широта центра разрешенной зоны;
double — долгота центра разрешенной зоны;
double — радиус центра разрешенной зоны (в метрах).
Возвращаемые значения:
Нет.
Комментарии:
Позволяет указать координаты (долготу и широту центра, а также радиус разрешенной зоны). Доступно после использования метода void set_empty().
Смотри также:
| << 1.9 Языковые средства | Оглавление | 1.11 Применение >> |
| ||
| ||
| © ООО "Кигли", 2002-2004 | ||