在IMDF文件中指定帮助
要在IMDF文件中定义适配器属性的帮助文本,请使用帮助
元素。你只能包含一个帮助
IMDF文件中的节点,它必须是根节点的子节点。
作为孩子帮助
节点,你创建AdaptorHelp
包含特定属性的帮助文本的节点。你可以使用的名字
属性。AdaptorHelp
元素来指定帮助与哪个属性关联。
您可以选择在帮助文本中包含特定于设备的内容。此文本仅在选择特定设备时出现。使用一个或多个DeviceHelp
节点将特定于设备的帮助添加到AdaptorHelp
节点。你可以使用设备
属性。DeviceHelp
元素来指定文本应该在何时出现。您还可以为属性帮助使用创建see also引用再瞧瞧
节点。
下面的示例概述了如何使用这些元素来创建属性帮助。斜体中的单词表示必须定义的文本。
< imageicittioninfo >propertyname>帮助文本< DeviceHelp设备=设备名称>特定于设备的帮助文本< / DeviceHelp > < SeeAlso >对其他属性的引用…< /帮助> < / ImageAcquisitionInfo >
下表总结了可用于定义帮助的标记。有关更多信息,请参阅这些主题。
元素 |
描述 |
属性 |
---|---|---|
|
在IMDF文件中定义帮助部分。一定是子的 |
没有一个 |
|
定义属性的在线帮助。Help节点可以包含一个或多个AdaptorHelp节点。 |
|
|
在属性帮助中指定特定于设备的文本。该元素是可选的。一个 |
|
|
在属性帮助中定义see also行。该元素是可选的。一个 |
没有一个 |
用户场景:查看属性帮助
使用的目的帮助
元素的作用是为特定于设备的属性创建帮助文本。属性可以在命令行上显示帮助文本imaqhelp
命令。
属性显示特定于设备的属性的帮助文本imaqhelp
命令。要了解如何在IMDF文件中创建此帮助,请参见创建AdaptorHelp节点.
此列表中的项目对应于上面编号的元素。
特定于设备的属性是视频源对象的属性。示例创建视频输入对象,然后使用
getselectedsource
函数获取视频源对象的句柄。该示例使用
得到
函数显示特定于设备的属性列表。使用
imaqhelp
函数显示视频源对象的一个属性的帮助。帮助的第一行列出了属性的名称及其约束,如范围和权限。
在IMDF文件中输入帮助时,帮助文本会显示出来。的后面加上文本
AdaptorHelp
标签。的另请参阅控件创建的
再瞧瞧
节点。
创建AdaptorHelp节点
本节描述如何使用IMDF DTD定义的帮助标记集为属性创建帮助文本。的IMDF条目,示例如下亮度
属性,显示在用户场景:查看属性帮助.该示例设置了财产
属性。AdaptorHelp
标记到属性的名称。
指定亮度,也称为黑电平。亮度描述了从图像反射或通过图像传输的光强度的差异,与图像的色调和饱和度无关。对于某些设备,该值以IRE单位* 100表示。对于其他设备,单位是任意的。有关信息,请参阅该设备的文档。根据采集设备的不同,此属性可能具有关联的mode属性,允许设备自动控制该值,或者手动配置该值。< SeeAlso > BrightnessMode。< / SeeAlso > < / AdaptorHelp >
包括特定于设备的帮助文本
若要包含仅针对特定设备出现的帮助文本,请使用DeviceHelp
元素。
在本例中,帮助文本包含三个特定于设备的部分。注意该示例如何设置设备
属性。DeviceHelp
属性设置为设备的名称。
开启频闪输出及其定时器。启用频闪输出后,它将开始检测触发器并生成适当的输出。有关频闪输出的详细说明,请参阅硬件手册。 参见StrobeMode, StrobeDuration, StrobeDelay, StrobePolarity, StrobeAlignOnHs。 参见StrobeMode, StrobeDelay, StrobePolarity。 对于PC-RGB, StrobeEnable只开启定时电路。闪光灯输出仍然必须使用StrobeOutputEnable属性启用。参见StrobeMode, StrobePolarity, StrobeDelay, StrobeOutputEnable。< / DeviceHelp > < / AdaptorHelp >