urn:schemas-cosylab-com:BACI:1.0
complexType ROlong

Super Types

{http://www.w3.org/2001/XMLSchema}anyType
  |
  +--{urn:schemas-cosylab-com:BACI:1.0}CharacteristicModel (restriction)
       |
       +--{urn:schemas-cosylab-com:BACI:1.0}Property (extension)
            |
            +--{urn:schemas-cosylab-com:BACI:1.0}TypelessProperty (extension)
                 |
                 +--{urn:schemas-cosylab-com:BACI:1.0}Plong_ (restriction)
                      |
                      +--{urn:schemas-cosylab-com:BACI:1.0}Plong (extension)
                           |
                           +--{urn:schemas-cosylab-com:BACI:1.0}ROlong (extension)

Documentation

Read Only Long Property

Properties

This component is not nillable.

Model

<...
  alarm_fault_family = xs:string
  alarm_fault_member = xs:string
  alarm_high_off = xs:int : 0
  alarm_high_on = xs:int : 0
  alarm_level = xs:int : 0
  alarm_low_off = xs:int : 0
  alarm_low_on = xs:int : 0
  alarm_timer_trig = xs:double : 0.0
  archive_delta = xs:int : 0
  archive_delta_percent = xs:double : 0
  archive_max_int = xs:double : 0.0
  archive_mechanism = xs:string : monitor_collector
  archive_min_int = xs:double : 0.0
  archive_priority = xs:int : 3
  archive_suppress = xs:boolean : false
  default_timer_trig = xs:double : 1.0
  default_value = xs:int : 0
  description = xs:string : -
  format = xs:string : %d
  graph_max = xs:int : 2147483647
  graph_min = xs:int : -2147483648
  initialize_devio = xs:boolean : 0
  min_delta_trig = xs:int : 0
  min_step = xs:int : 0
  min_timer_trig = xs:double : 0.001
  resolution = xs:unsignedLong : 65535
  units = xs:string : ->

</...>

alarm_fault_family

Here user can specify fault family for the alarm. for details of the fault family see the alarm documentation. If the fault family attribute is not specified (=is empty), than default value which is BACIproperty is taken.

Type:

xs:string

Use:

optional

Form:

unqualified

alarm_fault_member

Here user can specify fault member for the alarm. for details of the fault member see the alarm documentation. If the fault member attribute is not specified (=is empty), than default value which is property name is taken.

Type:

xs:string

Use:

optional

Form:

unqualified

alarm_high_off

Same type and units as the Property. Below this value alarm is cleared

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

alarm_high_on

Same type and units as the Property. Above this value alarm is set

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

alarm_level

Defines the level (priority) of the alarm.

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

alarm_low_off

Same type and units as the Property. Above this value alarm is cleared

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

alarm_low_on

Same type and units as the Property. Below this value the alarm is set.

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

alarm_timer_trig

The minimum time interval (in seconds and fractions of seconds) for the notification of changes in the alarm status. Is the time you want the alarm system to check for the value of the property. It might be the same as default_timer_trig, but depending on you application and on the criticality of the property they might be different. For example: - If a property is normally changing slowly, but it is critical to see as soon as possible an alarm if it goes out of range, I would normally put alarm_timer_trig = 0.1 default_timer_trig - The opposite might also happen, if you care for seeing fine variations, for example to plot them, but not much for alarms because the change is in small steps and the critical range band before you get damage is quite large, you can have the alarm_timer_trig = 10 default_timer_trig A value of 0.0 (default) means that alarm triggering is disabled. See the documentation of the specific implementation for details on the implications of this value. For example in the ACS CPP baci implementation, the value of a property is checked for its status with respect to the alarm configuration by an internal monitor defined with this time interval. This means that, depending on the underlying DevIO implementation, changes in the alarm status accurring during this time interval might get un-noticed.

Type:

xs:double

Default:

0.0

Use:

optional

Form:

unqualified

archive_delta

Same type and units as parameter Property. Defines what a change in parameter value is. If the value changes for less than the amount specified here, no log entry is generated.

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

archive_delta_percent

A percentage value of double type. Defines what a percentual change in parameter value is. If the value changes percentually less than the amount specified here, no log entry is generated.

Type:

xs:double

Default:

0

Use:

optional

Form:

unqualified

archive_max_int

The maximum amount of time (in seconds and fractions of seconds) allowed to pass between two consecutive submissions to the log. If the time exceeds the value specified here, the log entry should be generated even though the value of the parameter has not changed sufficiently.

Type:

xs:double

Default:

0.0

Use:

optional

Form:

unqualified

archive_mechanism

The attribute archive_mechanism can be used to specify which mechanism should be taken for archiving the property. In this way a system that uses ACS can define its own archiving mechanism. ACS provides support for archiving properties through notification channel (notification_channel). ALMA SW provides in ARCHIVE subsytem additional mechanism: monitor collector (monitor_collector). From ACS 9.0 monitor collector is also default mechanism for archiving properties. Depend on the implementation of the archiving mechanism all or just some of archive_XYZ attributes can be used for its configuration. Notification channel uses all (three), meanwhile the monitor collector uses only archive_max_int.

Type:

xs:string

Default:

monitor_collector

Use:

optional

Form:

unqualified

archive_min_int

The minimum amount of time (in seconds and fractions of seconds) allowed to pass between two consecutive submissions to the log. If the time is smaller than the value specified here, the log entry is not submitted, even though the value of the parameter has changed. This characteristic is used for archive monitors and is independent from the min_timer_trig characteristic, that is instead used for user defined monitors.

Type:

xs:double

Default:

0.0

Use:

optional

Form:

unqualified

archive_priority

The priority of the log entry that will carry the information required for archiving the parameter's value. Default is 3 (LM_INFO). If the priority exceeds the value specified in the logging proxy's MaxCachePriority, the archiving data will be transmitted to the centralized logger immediately. If it is below MinCachePriority, the data will be ignored. If it is somewhere in-between, it will be cached locally until a sufficient amount of log entries is collected for transmission to the centralized logger.

Type:

xs:int

Default:

3

Use:

optional

Form:

unqualified

archive_suppress

The attribute archive_suppress can be used to enable, disable archiving of the property w/o changing the other values of archiving like archive_max_int, and archive_min_int.

Type:

xs:boolean

Default:

false

Use:

optional

Form:

unqualified

default_timer_trig

When a timer is created without requiring a specific time interval, this is the value used. Normally, the value of a property has an intrisic change rate that should be specified here (in seconds and fractions of seconds). In this way applications can always get a reasonable update frequency without having to "guess" how often they have to request a value and without oversampling. This is particularly useful for GUI applications.

Type:

xs:double

Default:

1.0

Use:

optional

Form:

unqualified

default_value

Same type and units as parameter Property The default value for this property, used when the property is not initialised.

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

description

Description of the function and purpose of the Property. Used in panels and to provide short help and documentation about the specific property.

Type:

xs:string

Default:

-

Use:

optional

Form:

unqualified

format

See TypelessProperty for the description. Default value has been restricted here to %d to map the intrisic structure of a long.

Type:

xs:string

Default:

%d

Use:

optional

Form:

unqualified

graph_max

Same type and units as parameter Property This characteristic represents the miximum value that the property will ever reach. The name come from the fact that it normally represents the recommended maximum for charts and gauges that display the value, but the actual meaning is wider. It should not be confused with the max_value characteristic of writable properties. The max_value represents the maximum value that can be SET, but the actual value reached by the property can in many case be higher (and defined by graph_max). For example while a device moves to the maximum allowerd set position, there can be an overshoot. Typically devices of this kind have a soft and an hard upper limit. TODO: It might be better to rename this characteristic to better express the actual meaning.

Type:

xs:int

Default:

2147483647

Use:

optional

Form:

unqualified

graph_min

Same type and units as parameter Property This characteristic represents the minimum value that the property will ever reach. The name come from the fact that it normally represents the recommended minimum for charts and gauges that display the value, but the actual meaning is wider. It should not be confused with the min_value characteristic of writable properties. The min_value represents the minimum value that can be SET, but the actual value reached by the property can in many case be lower (and defined by graph_min). For example while a device moves to the minimum allowerd set position, there can be an overshoot. Typically devices of this kind have a soft and an hard lower limit. TODO: It might be better to rename this characteristic to better express the actual meaning.

Type:

xs:int

Default:

-2147483648

Use:

optional

Form:

unqualified

initialize_devio

It is used to initialize the devIO of the property if it is true. It uses the "default_value" characteristic to initialize the devIO. The default it is false/0.

Type:

xs:boolean

Default:

0

Use:

optional

Form:

unqualified

min_delta_trig

Same type and units as parameter Property Minimum change in value (with respect to the last value published) that will trigger an on-change monitor. For a change smaller than this value, no motir will be triggered. Important to filter out small random oscillations of the value.

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

min_step

Same type and units as parameter Property This is the minimum step increment and decrement for the property. It is typically used by increment and decrement methods. A typical case is an "increment button", used to increment stepwise the value of a writable property by clicking on it. It can also be used to draw proper scale tags on a graph. When connecting to physical devices, this characteristic is often related to the resolution of the device and, therefore, to the resolution characteristic.

Type:

xs:int

Default:

0

Use:

optional

Form:

unqualified

min_timer_trig

Minimun allowed time interval (in seconds and fractions of second) for values published by timers. Independently from the requested time interval or from the frequency of change in case of monitors on changes, no values will be published less than min_timer_trig seconds from a previously published values. This characteristic is ment to limit bandwidth and avoit floading the system with new values. This characteristic is used for user defined monitors and is independent from the min_timer_trig characteristic, that is equivalently used for archive monitors.

Type:

xs:double

Default:

0.001

Use:

optional

Form:

unqualified

resolution

Bit pattern representing the significant bits in the property's value. For example a long is represented by 64 bits, but a physical device might deliver a value consisting only of 24 bits. In that case the resolution attribute has only the first 24 bits up. The remaining 8 bits shall be ignored by the application. This attribute is useful for example for returning the resolution of analog-digital conversion The specific usage must be documented case by case.

Type:

xs:unsignedLong

Default:

65535

Use:

optional

Form:

unqualified

units

A string representing the units (normally base SI units or combinations of SI units) of the quantity represented by the property.

Type:

xs:string

Default:

-

Use:

optional

Form:

unqualified

Source

<xs:complexType name="ROlong">
  <xs:complexContent>
    <xs:extension base="Plong">
      <xs:attribute default="0" name="alarm_high_on" type="xs:int" use="optional">
      </xs:attribute>
      <xs:attribute default="0" name="alarm_low_on" type="xs:int" use="optional">
      </xs:attribute>
      <xs:attribute default="0" name="alarm_high_off" type="xs:int" use="optional">
      </xs:attribute>
      <xs:attribute default="0" name="alarm_low_off" type="xs:int" use="optional">
      </xs:attribute>
      <xs:attribute default="0.0" name="alarm_timer_trig" type="xs:double">
      </xs:attribute>
      <xs:attribute default="" name="alarm_fault_family" type="xs:string" use="optional">
      </xs:attribute>
      <xs:attribute default="" name="alarm_fault_member" type="xs:string" use="optional">
      </xs:attribute>
      <xs:attribute default="0" name="alarm_level" type="xs:int" use="optional">
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>