Чтобы задать текст справки для свойств адаптера в файле IMDF, используйте Help элемент. Вы можете включать только один Help узел в файле IMDF, и он должен быть дочерним узлом корневого узла.
Как дети Help узел, вы создаете AdaptorHelp узлы, которые содержат текст справки для определенного свойства. Вы используете name атрибут AdaptorHelp элемент для определения свойства, с которым связана справка.
Вы можете включать содержимое конкретного устройства в текст справки. Этот текст появляется только при выборе конкретного устройства. Используйте одну или несколько DeviceHelp узлы для добавления справки по устройствам к AdaptorHelp узел. Вы используете device атрибут DeviceHelp элемент, чтобы указать, когда должен появиться текст. Можно также создать ссылки на справку по свойствам с помощью SeeAlso узлы.
В следующем примере описывается, как использовать эти элементы для создания справки по свойствам. Слова курсивом представляют текст, который вы должны задать.
<ImageAcquisitionInfo> <Help> <AdaptorHelp property=propertyname> Help text <DeviceHelp device=devicename> Device-specific help text </DeviceHelp> <SeeAlso> References to other properties </SeeAlso </AdaptorHelp> . . . </Help> </ImageAcquisitionInfo>
В следующей таблице перечислены теги, которые можно использовать для определения справки. Для получения дополнительной информации см. эти темы.
Элемент | Описание | Признаки |
|---|---|---|
| Определяет раздел справки в файле IMDF. Должен быть дочерним элементом | Ничего |
| Определяет интерактивную справку для свойства. Узел справки может содержать один или несколько узлов AdaptorHelp. |
|
| Задает текст конкретного устройства в справке по свойствам. Этот элемент является необязательным. Система координат |
|
| Определяет линию «См. также в справке по свойствам». Этот элемент является необязательным. Система координат | Ничего |
Цель использования Help элемент в файле IMDF должен создавать текст справки для свойств конкретного устройства. Пользователь вашего адаптера может отобразить текст справки в командной строке с помощью imaqhelp команда.
В следующем примере показано, как пользователь отображает текст справки для свойства конкретного устройства с помощью imaqhelp команда. Чтобы узнать, как создать эту справку в файле IMDF, смотрите Создание узлов AdaptorHelp.
Элементы этого списка соответствуют пронумерованным элементам выше.
Свойства конкретного устройства являются свойствами объекта источника видео. Пример создает объект входа видео, а затем использует getselectedsource функция для получения указателя на объект видео.
В примере используется get функция для отображения списка свойств конкретного устройства.
Используйте imaqhelp функция для отображения справки по одному из свойств объекта источника видео.
В первой линии справки перечислено имя свойства с его ограничениями, такими как область значений и разрешения.
Текст справки появляется точно так, как вы вводите его в файл IMDF. Вы включаете текст после AdaptorHelp тег.
Линия «См. также» создается SeeAlso узел.
В этом разделе описывается, как создать текст справки для свойства с помощью набора тегов справки, заданных IMDF DTD. В следующем примере показана запись IMDF для Brightness свойство, отображаемое в сценарии пользователя: справка по свойствам просмотра. Пример устанавливает property атрибут AdaptorHelp тег на имя свойства.
Примечание
Текст справки должен начинаться с однострочных сводных данных. Убедитесь, что длина каждой линии текста не превышает 80 символов.
<AdaptorHelp property="Brightness">
Specify the brightness, also called the black level.
Brightness describes the difference in intensity of light reflected from
or transmitted through an image independent of its hue and saturation.
For some devices, the value is expressed in IRE units * 100. For other
devices, the units are arbitrary. Refer to the device's documentation for
information.
Depending on the acquisition device, this property may have an associated
mode property allowing this value to be controlled automatically by the
device, or for it to be manually configured.
<SeeAlso>BrightnessMode.</SeeAlso>
</AdaptorHelp>
Чтобы включить текст справки, который появляется только для определенных устройств, используйте DeviceHelp элементы.
В этом примере текст справки содержит три раздела для конкретного устройства. Обратите внимание, как пример устанавливает device атрибут DeviceHelp свойство имени устройства.
<AdaptorHelp property="StrobeEnable"> Enables the strobe output and its timer. Upon enabling the strobe output, it will start detection of triggers and generate output as appropriate. Consult your hardware manual for a detailed description of the strobe output. <DeviceHelp device="PC2Vision">See also StrobeMode, StrobeDuration, StrobeDelay, StrobePolarity, StrobeAlignOnHs. </DeviceHelp> <DeviceHelp device="PCVisionPlus">See also StrobeMode, StrobeDelay, StrobePolarity. </DeviceHelp> <DeviceHelp device="PCRGB">For the PC-RGB, StrobeEnable only enables the timing circuitry. The strobe output must still be enabled with the StrobeOutputEnable property. See also StrobeMode, StrobePolarity, StrobeDelay, StrobeOutputEnable. </DeviceHelp> </AdaptorHelp>