Функции

Если вернуться к примеру из прошлого раздела, то сразу после получения указателя на активный документ (строка: Set opium=app.ActiveDocument) из указателя opium становятся доступны все поддерживаемые «сервером» функции. Для того чтобы вызвать функцию доступную из указателя, нужно вслед за именем идентификатора указателя на объект поставить символ «точка» и набрать имя функции и список параметров, если они нужны. В редакторах языка Basic действует так называемый «механизм автоматического завершения ввода». Как только вы поставите точку вслед за идентификатором объекта, рядом с точкой появится список всех доступных функций, из которого можно выбрать нужную и нажать «Пробел» для завершения ввода. Для тех, кто не очень близко знаком с Basic следует сделать несколько замечаний относительно параметров. Если функция не имеет параметров и не возвращает значения — то после ее имени не пишется больше ничего и такая запись приводит к вызову функции. Например: opium.Redraw. Если функция имеет параметры, но не возвращает значения — то после имени функции ставиться пробел, после которого через запятую перечисляются параметры. Например: opium.ScrollTo 2114.6. Если же функция имеет параметры и возвращает значение (т.е. ее вызов пишется справа от знака «=»), то в этом случае список аргументов берется в круглые скобки. Например: zk=opium.PRMGet(“Кровля”).

«О!Пиум» в процессе работы оперирует геофизическими данными различных типов. На момент написания этого документа в полном объеме поддерживаются следующие типы данных:

·        кривые

·        наборы границ

·        отсчеты (пласты)

·        параметры

Каждый тип данных имеет набор функций для манипуляций с ними. При разработке функций использовалось определенное соглашение об именах. Так функции, относящиеся к определенному типу данных, имеют префикс, состоящий из трех заглавных латинских букв составляющих фонему созвучную с названием типа данных. Функции для чтения состоят из префикса и слова «Get». Функции для записи состоят из префикса и слова «Put». После этих слов могут стоять слова описывающие смысл параметра или действия. Иногда встречаются функции, в имени которых использован префикс из шести заглавных букв. Такой префикс является комбинацией двух трехбуквенных префиксов и указывает на иерархическую подчиненность функций. Ниже приведена таблица префиксов, которая должна помочь вам ориентироваться в списке функций.

Тип данных
Префикс

Кривая

CRV

Набор границ

GRN

Отсчеты

PLS

Параметры (общие)

PRM

Параметры (кривой)

PRMCRV

Параметры (набора границ)

PRMGRN

Параметры (отсчетов)

PRMPLS

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

Далее перечислены функции доступные на момент написания документа, сгруппированные по типам данных с которыми они оперируют. дальше>>