Указание сведений о свойствах

Чтобы указать информацию о свойствах в файле IMDF, используйте Property элемент. Вы можете включить столько, сколько Property узлы в файле IMDF по желанию. Property узлы могут быть дочерними для корневого узла, a Device узел или Videoformat узел. Узлы свойств также могут быть дочерними для Section узлы.

Примечание

Property узлы, являющиеся дочерними узлами корневого узла, влияют на все устройства, доступ к которым осуществляется через адаптер. Property узлы, являющиеся нижестоящими элементами Device или VideoFormat влияют только на это устройство или видеоформат.

Используются атрибуты Property для указания характеристик свойства, таких как его имя, тип и ограничения. Для получения дополнительной информации о Property см. раздел Задание атрибутов элемента свойства.

В следующем примере описывается использование этих элементов для указания информации о свойствах. В примере показано Property узел как дочерний от корневого узла, но используется так же, как дочерний от Device или VideoFormat узел. Слова, выделенные курсивом, представляют определенный текст.

<ImageAcquisitionInfo>
	<Property constraint=constraint_value
			 deviceSpecific=true_or_false
			 name=property_name
			 readOnly=always_never_or_whileRunning
			 type=cell_double_int_or_string
			 min=minimum_value
			 max=maximum_value
			 optional=on_or_off
			 default=default_value>
	</Property>
	.
	.
	.
</ImageAcquisitionInfo>

Задание атрибутов элемента свойства

В следующей таблице перечислены атрибуты узла Property в алфавитном порядке. В таблице приведено краткое описание свойства и перечислены требуемые свойства, а также необязательные свойства.

Признак	Описание	Необходимый
`constraint`	Указывает ограничения для свойства - см. раздел Задание значений для атрибута ограничения.	Необходимый
`default`	Значение по умолчанию для свойства.	Дополнительный
`deviceSpecific`	Логическое значение. `True` если свойство зависит от поставщика; иначе `false`.	Необходимый
`min`	Минимальное допустимое значение	Дополнительный
`max`	Максимально допустимое значение	Дополнительный
`name`	Наименование свойства	Необходимый
`optional`	Если установлено значение `off`свойство создается автоматически и добавляется к объекту при обработке файла IMDF. Если `on`, адаптер должен явно создать свойство. Значение по умолчанию: `off`.	Дополнительный
`readOnly`	Состояние свойства только для чтения: `always`, `never`, или `whileRunning`.	Необходимый
`type`	Тип данных свойства: `cell`, `double`, `int` или `character vector`.	Необходимый

Задание значений для атрибута ограничения

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

constraint=positive

В следующей таблице перечислены все возможные значения для constraint атрибут в алфавитном порядке.

Значение ограничения	Описание
`bounded`	Свойство имеет минимальное и максимальное значение. Если установить `constraint` атрибут для `bounded`, необходимо назначить значения `min` и `max` атрибуты.
`enum`	Свойство является перечисляемым значением. Если установлено, `Property` узел должен содержать один или несколько `EnumConstraintValue` узлы. См. раздел Указание перечисляемых значений.
`inforpositive`	Значение должно быть положительным или бесконечным
`none`	Без ограничений
`positive`	Значение должно быть положительным
`zeroinforpositive`	Значение должно быть больше нуля или бесконечно
`zeroorpositive`	Значение должно быть больше нуля

Задание перечисляемых значений

Если свойство использует перечисляемые значения, необходимо задать значение constraint атрибут для enum, атрибут type для character vectorи создать EnumConstraintValue элементы для каждого перечисления. EnumConstraintValue узлы являются нижестоящими элементами Property узел.

При создании узлов EnumConstraintValue необходимо указать два атрибута:

Идентификатор значения
Имя значения

В этом примере определяется свойство StrobeEnable. Атрибут ограничения имеет значение enum. Атрибут имени EnumConstraintValue узлы определяют возможные значения этого перечисления: on и off.

<Property optional="on" 
          constraint="enum"
          deviceSpecific="true" 
          name="StrobeEnable" 
          readOnly="whileRunning"
          type="string">
   <EnumConstraintValue id="0" name="off" />
   <EnumConstraintValue id="1" name="on" />
</Property>

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