Что такое ручка api

Интеллектуальные ручки пользовательского объекта в MultiCAD.NET

Удобство редактирования чертежей является одной из ключевых характеристик систем автоматизированного проектирования. Важным инструментом для работы с объектами чертежа служат ручки (grips) — специальные маркеры в ключевых точках объекта, которые позволяют видоизменять объект с помощью мыши, без использования меню или командной строки.

Механизм управления ручками в MultiCAD.NET позволяет работать как с простыми, так и интеллектуальным ручками. Про простые ручки мы писали в одной из прошлых статей, здесь же мы рассмотрим интеллектуальные ручки, которые, помимо формы (круглые, треугольные, ромбовидные и т.д.), отличаются от простых тем, что они могут изменять отдельные параметры объекта, вызывать всплывающее меню или выполнять набор действий, определенный в обработчике. Кроме, этого API интеллектуальных ручек позволяет также создавать и простые ручки, но используя при этом новый, унифицированный подход.

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

Класс McSmartGrip

Регистрация ручек

Регистрация ручек пользовательского объекта производится с помощью метода AppendGrip() класса GripPointsInfo :

Следующий фрагмент кода создает и добавляет всю ту же простую ручку:

Как видите, вся процедура очень компактна и занимает всего одну строку кода. Однако, это касалось самого элементарного случая, а именно, простых ручек. Давайте рассмотрим какие еще типы ручек поддерживаются в MultiCAD.NET API, а также специфику работы с каждым из них.

Типы ручек

Внешний вид ручек

Простая ручка

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

Результат работы такой ручки — на анимированной иллюстрации:

Ручка-кнопка

Добавим ручку-кнопку, которая будет управлять отображением рамки вокруг текста по нажатию. Для создания такой ручки используется конструктор с указанием типа ручки McBaseGrip.GripType.Button и базовым цветом. Обработчик нажатия на кнопку OnCommand меняет значение индикатор рисования рамки _show_frame на обратное. Для созданной ручки-кнопки определим внешний вид «включено», который будет меняться на «выключено» при нажатии, и обратно.

Также по нажатию ручки-кнопки может быть вызвана необходимая зарегистрированная команда:

Источник

Что такое «ручка»?

Я часто слышал о “дескрипторах”, что это такое?

Изменить:
Например, я слышал о:
оконные ручки
обработчики событий
файловые дескрипторы

и т.д. Это то же самое? Или это некоторые абстрактные термины?

Ручка – это косвенный способ ссылки на объект, принадлежащий ОС или библиотеке. Когда операционная система или библиотека владеет объектом, но хочет, чтобы клиент ссылался на него, он может предоставить ссылку на этот объект, называемый дескриптором.

Ручки могут быть реализованы по-разному. Обычно они не являются ссылками в смысле С++ или С#. Часто они представляют собой указатели на какой-то непрозрачный тип, или они могут быть (или содержать) индекс в таблицу объектов, принадлежащих операционной системе или библиотеке.

Например, в Windows, если вы создаете окно, ОС создает объект, который представляет это окно, но не возвращает указатель на этот объект. Вместо этого он возвращает дескриптор окна, который обеспечивает дополнительный слой косвенности. Когда вы передаете дескриптор окна обратно в другой вызов ОС, ОС знает, какой объект окна использовать на основе дескриптора. Это не позволяет вашему коду напрямую обращаться к объекту окна.

Дополнительный слой косвенности позволяет операционной системе или библиотеке делать такие вещи, как перемещать объекты, ссылаться на объекты и обычно контролировать, что происходит с объектом. Подобно идиоме PIMPL, реализация может полностью измениться, сохраняя при этом первоначальный API и, таким образом, не заставляя клиенты перекомпилировать. Это особенно полезно, если вы пытаетесь предложить не-объектно-ориентированный API для клиентов, написанных на процедурных языках, таких как C.

“handle” – это другое имя для ссылки на ресурс, который управляется программистом явно, а не автоматически с помощью среды выполнения.

Ручки – это указатели на неуправляемые ресурсы, такие как дескрипторы файлов, дескрипторы подключения к базе данных, дескрипторы окон и т.д. Поскольку они являются ручками для неуправляемых ресурсов, в большинстве случаев они не будут автоматически собираться с мусором, и вам необходимо обеспечить надлежащий выпуск их или вы можете услышать об утечках ручек.

Источник

Что такое «ручки» на сленге программистов?

Например, смотря видео с различных конференций Яндекса, можно часто слышать это слово.

Ну в том числе у нас есть такие ручки, в том числе продуктовые ручки, когда нужно чтобы в определенный момент в браузере что-то замигало. Ну вот это не сильно нагруженные ручки. Очень нагруженные ручки мы стали писать на плюсах.

4 ответа 4

К handle никакого отношения не имеет. К UML возможно тоже, т.к. он в документации не используется.

Подозреваю, это может быть как-то связано с внешним видом реализуемых компонентом интерфейсов в UML, которые выглядят как рукоятки в механике/гидравлике:

Всё ещё ищете ответ? Посмотрите другие вопросы с метками терминология или задайте свой вопрос.

Похожие

Подписаться на ленту

Для подписки на ленту скопируйте и вставьте эту ссылку в вашу программу для чтения RSS.

дизайн сайта / логотип © 2021 Stack Exchange Inc; материалы пользователей предоставляются на условиях лицензии cc by-sa. rev 2021.12.16.41042

Нажимая «Принять все файлы cookie» вы соглашаетесь, что Stack Exchange может хранить файлы cookie на вашем устройстве и раскрывать информацию в соответствии с нашей Политикой в отношении файлов cookie.

Источник

Что такое «ручка»?

Я вижу ссылки на дескрипторы окон, элементы управления, которые имеют ссылку на дескриптор окна и т.д. Но я не знаю, что такое дескриптор.

ОТВЕТЫ

Ответ 1

Вы можете это сделать. CWnd * pWnd = CWnd:: FromHandle (hWnd) Примечание: CWnd:: FromHandle (hWnd) является статическим и не требует экземпляра.

Он вернет вам обертку, в которую обернут hWnd. Ну не совсем! Если дескриптор на самом деле не обернут объектом, он создаст один, И ЭТО БУДЕТ ТОЛЬКО ВРЕМЕННО. Так используйте его один раз, а затем выбросьте его. Он может создать экземпляр, поскольку hWnd имеет достаточно информации в своей структуре для окон, чтобы создать экземпляр объекта CWnd. Он не добавляет его в таблицу элементов управления v, поэтому он является временным.

HWND на самом деле является объектом ядра и больше? HWND (CWnd и CWnd-производные классы) HDC (классы CDC и CDC) HMENU (CMenu) HPEN (CGdiObject) HBRUSH (CGdiObject) HFONT (CGdiObject) HBITMAP (CGdiObject) HPALETTE (CGdiObject) HRGN (CGdiObject) HIMAGELIST (CImageList) SOCKET (CSocket) (должен был быть HSOCKET?) + Другие. Я не уверен, что все они возвратят временный объект, если потребуется. GetDC (hWnd) доставит вам hDC из hWnd, но он будет временным, возможно, лучше использовать CDC claa.

Ответ 2

Дескриптор представляет собой абстрактную ссылку на какой-либо ресурс, предоставленный вам другой стороной (как правило, ОС), которую вы можете вернуть для ссылки на этот ресурс.

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

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

Ответ 3

Источник

Документирование API

При фразе «Документирование API» многие приходят в ужас, так как, на первый взгляд, это кажется очень трудным, страшным и тяжёлым. Документ по ГОСТу сразу кажется небольшой детской сказкой на этом фоне. Но не так страшен чёрт, как его малюют! Я не говорю, что документирование API — это легко и просто. Да этому нельзя научиться из одной короткой статьи или видео, но если придёт понимание этой темы, то и на изучение этой темы уйдёт гораздо меньше времени. Да–к, что же такое API? И как его задокументировать? В данной статье рассмотрена эта очень непростая тема.

Что такое API?

API (application programming interface) — это набор готовых классов, функций, процедур, структур и констант, предоставляемые самим приложением или операционной системой для взаимодействия с внешними программами.
Например, у вас есть кот Барсик, который любит лежать на обеденном столе. Вам это не нравится. Вы говорите Барсику: «Барсик, брысь со стола!». Барсик хоть и нехотя, но слезает со стола. Так вот, API — это набор команд, благодаря которым кот Барсик понял хозяина, что ему следует слезь со стола. Другой пример, если программу (модуль, библиотеку) рассматривать как чёрный ящик, то API — это множество «ручек», которые доступны пользователю данного ящика и которые он может вертеть и дёргать.
При этом пользователю необязательно понимать и знать, что такое API. API это «язык» общения между двумя программами и необходим программистам. API создаётся чтобы приложения созданные разными разработчикам корректно существовали вместе и могли взаимодействовать друг с другом. Компоненты образуют иерархию, в результате которой высокоуровневые компоненты используют API низкоуровневых компонентов, а те, в свою очередь, используют API ещё более низкоуровневых компонентов. По такому принципу построены протоколы передачи данных по Интернет. Каждый уровень пользуется функциональностью предыдущего («нижележащего») уровня и, в свою очередь, предоставляет нужную функциональность следующему («вышележащему») уровню.
На рисунке ниже представлена схема СЭД «Кодекс: Документооборот», в которой отображено API для внешних систем, а также для внутренних в данной СЭД.

API библиотеки функций и классов включает в себя описание сигнатур и семантики функций.

Сигнатура функции

Сигнатура функции — это часть общего объявления функции, позволяющая средствам трансляции идентифицировать функцию среди других. В различных языках программирования существуют разные представления о сигнатуре функции, что также тесно связано с возможностями перегрузки функций в этих языках.
Например, в языке программирования C++ простая функция однозначно опознаётся компилятором по её имени и последовательности типов её аргументов, что составляет сигнатуру функции в этом языке. Если функция является методом некоторого класса, то в сигнатуре будет участвовать и имя класса.
В языке программирования Java сигнатуру метода составляет его имя и последовательность типов параметров; тип возвращаемого значения в сигнатуре не участвует.
В СЭД «Кодекс: Документооборот» используется API на основе web-технологий REST-API, на её примере рассмотрим формирование вызова любого GET\POST запроса.

Пример формирования вызова любого GET\POST запроса

Семантика функции

Семантика функции — это описание того, что данная функция делает. Семантика функции включает в себя описание того, что является результатом вычисления функции, как и отчего этот результат зависит. Обычно результат выполнения зависит только от значений аргументов функции, но в некоторых модулях есть понятие состояния. Полным описанием семантики функций является исполняемый код функции или математическое определение функции.
Ниже, для примера, рассмотрена одна из функций СЭД «Кодекс: Документооборот».

/Documents/GetDocLinkedObjects GET
Возвращает список связанных документов по переданному идентификатору.

Таблица 1 — Идентификатор документа

Возвращаемое значение – список связей с документом.

Таблица 2 — Список связей с документом

Проблема документирования API

Документация API — это техническая (программная) документация, в которой указано как использовать API.
При этом эту документацию нужно поддерживать в актуальном стоянии чаще, чем любую другую. Ведь от актуальности документации API зависит качество разработки продукта. Однако, есть еще проблема разработки самого API системы. Любая система развивается, добавляются функции, изменяются существующие вызовы и методы. Но необходимо помнить о том, что с нашей системой могут быть интегрированы другие системы. И если изменения затронут API, то такая интеграция «развалится», при следующем обновлении произойдёт нарушение механизмов взаимодействия. Поэтому в документировании API можно выделить две основные проблемы:

Проблема стандартизации API

В первую очередь с документацией API будут работать люди. В связи с этим, для общего понимания нужен некий стандарт разработки API, чтобы разработчики даже при беглом ознакомлении понимали, как с ним корректно взаимодействовать. Также наличие стандарта API позволяет использовать средства автоматической кодогенерации, что существенно повышает скорость разработки, но об этом я расскажу позже.
Подобного рода внутренний стандарт лучше разработать и утвердить с отделом разработки программного обеспечения.
Для примера документация API должна включать:

Способы создания документации API

Одни из самых популярных спецификаций — это RAML, Swagger и API Blueprint.
Например, если программирование Системы происходи в MS Visual Studio, то в ней автоматически генерируется Xml (представлена на картинке ниже), с помощью которой уже можно создать в любой другой спецификации документацию API.

В данной статье разберём спецификацию Swagger, так как, на мой взгляд, она является более удобной для работы.
Когда понимание документирование API будет «на уровне», то можно уже выбрать любую другую программу, которая нравится больше, а для начала можно начать и с Swagger.

Swagger

Для учебных целей можно открыть Swagger Editor, в котором можно попробовать создавать документацию API.
Сайт: http://editor.swagger.io/
Swagger Editor состоит из двух блоков: код (слева), документация API (блок справа (зависит от блока слева)).

Типы аннотаций, использованные для описания методов:

Документация API

В Swagger генерация происходит автоматически.
Полученная документация содержит описание всех типов данных, возвращаемых API, список доступных методов c подробным описанием.

Описание метода API содержит его url, описание всех параметров, а также все варианты ответов. Т.к. мы ссылались на модель Post в описании ответа, мы можем видеть ссылку на эту модель и даже пример ответа API, сгенерированный на основании описания модели.

В заключении хотелось бы сказать, что документированию API невозможно научиться по одной статье, тут нужна куда более сильная теории и много практики. У вас обязательно должен быть человек, который вам поможет, подскажет и укажет на ваши ошибки. Но не забывайте, что документирование API невозможно без взаимодействия с Отделом разработки ПО. Они помогут установить и настроить программу, подскажут, где и что взять, где и что посмотреть.

Источник