Table 6.134—DRM_HSV_Colour_Control_Link

Property

Description

Superclass

·         <DRM Control Link>

Class

·         <DRM HSV Colour Control Link>

Subclass

·         none

Definition

This DRM class defines the specialized <DRM Control Link> used to provide the connection between an ordered aggregation of <DRM Expression>s and the target fields of an <DRM HSV Colour>.

The hue_expression_index field is a 1-based index into the ordered aggregation of <DRM Expression>s, and is used to select the specific <DRM Expression> that controls the value of <DRM HSV Colour>’s hsv_data.hue field.

The saturation_expression_index field is a 1-based index into the ordered aggregation of <DRM Expression>s, and is used to select the specific <DRM Expression> that controls the value of <DRM HSV Colour>’s hsv_data.saturation field.

The value_expression_index field is a 1-based index into the ordered aggregation of <DRM Expression>s, and is used to select the specific <DRM Expression> that controls the value of <DRM HSV Colour>’s hsv_data.value field.

Example(s)

·         A control link that specifies the value for the parameter saturation for instances of a building model.

Inherited field elements

field_name

range

Field_Data_Type

description1

 

String

Field elements

field_name

range

Field_Data_Type

hue_expression_index2

 

Integer_Unsigned

saturation_expression_index3

 

Integer_Unsigned

value_expression_index4

 

Integer_Unsigned

Associated by (one-way) (inherited)

·         none

Associated by (one-way)

·         none

Associated with (two-way) (inherited)

·         none

Associated with (two-way)

·         none

Composed of (two-way) (inherited)

·         one or more {ordered} <DRM Expression>s

Composed of (two-way)

·         none

Composed of (two-way metadata) (inherited)

·         none

Composed of (two-way metadata)

·         none

Constraints

·         none

Notes

1 A text description of what the <DRM Control Link> is for.

2 Index of the expression whose value controls the hue field of the affected <DRM HSV Colour>. If 0, the hue field is not controlled.

3 Index of the expression whose value controls the saturation field of the affected <DRM HSV Colour>. If 0, the saturation field is not controlled.

4 Index of the expression whose value controls the value field of the affected <DRM HSV Colour>. If 0, the value field is not controlled.

Class diagram

<DRM HSV Colour Control Link>