Class TLcdAIXM51LightElement

All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdAIXM51LightElement extends TLcdAIXM51AbstractAIXMObject
An elementary light source, part of a lighting system.
Since:
10.0
  • Field Details

    • COLOUR_PROPERTY

      public static final TLcdDataProperty COLOUR_PROPERTY
      Data property that maps to the colour element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeColour>.
    • INTENSITY_LEVEL_PROPERTY

      public static final TLcdDataProperty INTENSITY_LEVEL_PROPERTY
      Data property that maps to the intensityLevel element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeLightIntensity>.
    • INTENSITY_PROPERTY

      public static final TLcdDataProperty INTENSITY_PROPERTY
      Data property that maps to the intensity element. The possible values for this property are instances of TLcdAIXM51ValLightIntensity.
    • TYPE_PROPERTY

      public static final TLcdDataProperty TYPE_PROPERTY
      Data property that maps to the type element. The possible values for this property are the public QName constants defined in this class.
    • LOCATION_PROPERTY

      public static final TLcdDataProperty LOCATION_PROPERTY
      Data property that maps to the location element. The possible values for this property are instances of TLcdAIXM51Property<TLcdAIXM51ElevatedPoint>.
    • ANNOTATION_PROPERTY

      public static final TLcdDataProperty ANNOTATION_PROPERTY
      Data property that maps to the annotation element. The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51Note>>.
    • AVAILABILITY_PROPERTY

      public static final TLcdDataProperty AVAILABILITY_PROPERTY
      Data property that maps to the availability element. The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51LightElementStatus>>.
    • EXTENSION_PROPERTY

      public static final TLcdDataProperty EXTENSION_PROPERTY
      Data property that maps to the extension element. The possible values for this property are instances of List<TLcdAIXM51Link<TLcdAIXM51AbstractExtension>>.
  • Constructor Details

    • TLcdAIXM51LightElement

      public TLcdAIXM51LightElement()
    • TLcdAIXM51LightElement

      public TLcdAIXM51LightElement(TLcdDataType aType)
  • Method Details

    • getColour

      public TLcdAIXM51CodeColour getColour()
      Returns the role value contained in the value of the COLOUR_PROPERTY property. Returns null if the value of the COLOUR_PROPERTY property is null.

      A code indicating the colour of the lights in the group.

      Returns:
      the role value of the COLOUR_PROPERTY property.
      See Also:
    • setColour

      public void setColour(TLcdAIXM51CodeColour aValue)
      Sets the value of the property that maps to the colour element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the COLOUR_PROPERTY property is set to null.

      A code indicating the colour of the lights in the group.

      Parameters:
      aValue - the role value to set for the COLOUR_PROPERTY property.
    • getIntensityLevel

      public TLcdAIXM51CodeLightIntensity getIntensityLevel()
      Returns the role value contained in the value of the INTENSITY_LEVEL_PROPERTY property. Returns null if the value of the INTENSITY_LEVEL_PROPERTY property is null.

      A code indicating the relative intensity of the lights in the group.

      Returns:
      the role value of the INTENSITY_LEVEL_PROPERTY property.
      See Also:
    • setIntensityLevel

      public void setIntensityLevel(TLcdAIXM51CodeLightIntensity aValue)
      Sets the value of the property that maps to the intensityLevel element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the INTENSITY_LEVEL_PROPERTY property is set to null.

      A code indicating the relative intensity of the lights in the group.

      Parameters:
      aValue - the role value to set for the INTENSITY_LEVEL_PROPERTY property.
    • getIntensity

      public TLcdAIXM51ValLightIntensity getIntensity()
      Returns the value of the property that maps to the intensity element.

      The exact value of the intensity of the lights in the group.

      Returns:
      the value of the INTENSITY_PROPERTY property.
    • setIntensity

      public void setIntensity(TLcdAIXM51ValLightIntensity aValue)
      Sets the value of the property that maps to the intensity element.

      The exact value of the intensity of the lights in the group.

      Parameters:
      aValue - the value to set for the INTENSITY_PROPERTY property.
    • getType

      public TLcdAIXM51CodeLightSource getType()
      Returns the role value contained in the value of the TYPE_PROPERTY property. Returns null if the value of the TYPE_PROPERTY property is null.

      The possible values for this property are the public QName constants defined in this class.

      A code indicating the type of light source.

      Returns:
      the role value of the TYPE_PROPERTY property.
      See Also:
    • setType

      public void setType(TLcdAIXM51CodeLightSource aValue)
      Sets the value of the property that maps to the type element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the TYPE_PROPERTY property is set to null.

      The possible values for this property are the public QName constants defined in this class.

      A code indicating the type of light source.

      Parameters:
      aValue - the role value to set for the TYPE_PROPERTY property.
    • getLocation

      public TLcdAIXM51ElevatedPoint getLocation()
      Returns the role value contained in the value of the LOCATION_PROPERTY property. Returns null if the value of the LOCATION_PROPERTY property is null.

      Light element location.

      Returns:
      the role value of the LOCATION_PROPERTY property.
      See Also:
    • setLocation

      public void setLocation(TLcdAIXM51ElevatedPoint aValue)
      Sets the value of the property that maps to the location element. to a new instance of the association class TLcdAIXM51Property initialized with the given role value. In case the given role value is null, the LOCATION_PROPERTY property is set to null.

      Light element location.

      Parameters:
      aValue - the role value to set for the LOCATION_PROPERTY property.
    • getAnnotation

      public List<TLcdAIXM51Note> getAnnotation()
      Gets the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
      Returns:
      the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
      See Also:
    • getAvailability

      public List<TLcdAIXM51LightElementStatus> getAvailability()
      Gets the value of the AVAILABILITY_PROPERTY property adapted to a list of TLcdAIXM51LightElementStatus instances.

      The operational status of the LightElement.

      Returns:
      the value of the AVAILABILITY_PROPERTY property adapted to a list of TLcdAIXM51LightElementStatus instances.
      See Also:
    • getExtension

      public List<TLcdAIXM51AbstractExtension> getExtension()
      Gets the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      Returns:
      the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      See Also: