Чтобы задать текст справки для свойств адаптера в файле 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. Должен быть дочерний элемент | 'none' |
| Задает онлайновую справку для свойства. Узел Справки может содержать один или несколько узлов AdaptorHelp. |
|
| Задает специфичный для устройства текст в справке свойства. Этот элемент является дополнительным. |
|
| Задает видение также линии в справке свойства. Этот элемент является дополнительным. | 'none' |
Цель использовать Help
элемент в файле IMDF должен создать текст справки для специфичных для устройства свойств. Пользователь вашего адаптера может отобразить текст справки в командной строке с помощью imaqhelp
команда.
Следующий пример показывает, как пользователь отображает текст справки для специфичного для устройства свойства с помощью imaqhelp
команда. Чтобы видеть, как создать эту справку в файле IMDF, смотрите Создание Узлы AdaptorHelp.
Элементы в этом списке соответствуют пронумерованным элементам выше.
Специфичные для устройства свойства являются свойствами объекта источника видеосигнала. Пример создает объект ввода видео и затем использует getselectedsource
функция, чтобы получить указатель на объект источника видеосигнала.
Пример использует get
функционируйте, чтобы отобразить список специфичных для устройства свойств.
Используйте imaqhelp
функционируйте, чтобы отобразить справку для одного из свойств объекта источника видеосигнала.
Первая линия справки перечисляет имя свойства с его ограничениями, такими как область значений и разрешение.
Текст справки появляется точно так же, как вы вводите его в файл IMDF. Вы включаете текст после AdaptorHelp
тег.
Смотрите также линия создается SeeAlso
узел.
В этом разделе описывается создать текст справки для свойства с помощью набора тегов справки, заданных DTD IMDF. Следующий пример показывает запись 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>