Указывание информации свойства

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

Примечание

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

Вы используете атрибуты элемента Property, чтобы задать характеристики свойства, такие как его имя, ввести, и ограничения. Для получения дополнительной информации об атрибутах Property, смотрите Атрибуты Элемента Свойства Определения.

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

<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>

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

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

Атрибут	Описание	Необходимый
`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`, необходимо присвоить значения атрибутам `max` и `min`.
`enum`	Свойство является перечисляемым значением. Если установлено, узел `Property` должен содержать один или несколько узлов `EnumConstraintValue`. Смотрите Перечисляемые значения Определения.
`inforpositive`	Значение должно быть положительным или бесконечным
`none`	Никакие ограничения
`positive`	Значение должно быть положительным
`zeroinforpositive`	Значение должно быть больше, чем нуль или бесконечным
`zeroorpositive`	Значение должно быть больше, чем нуль

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

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

Когда вы создаете узлы EnumConstraintValue, вы задаете два атрибута:

ID значения
Имя значения

Этот пример задает свойство 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>

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