Чтобы определить текст справки для свойств адаптера в файле 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>