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

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}Ppattern_ (restriction)
                      |
                      +--{urn:schemas-cosylab-com:BACI:1.0}Ppattern (extension)

Documentation

pattern stands for an unsigned long long. The typedef pattern is used because this type will mostly be used to encode a pattern of status bits. The type pattern can be used also for raw binary data. 

Properties

This component is not nillable.

Model

<...
  archive_delta = xs:unsignedLong : 0
  archive_max_int = xs:double : 0.0
  archive_min_int = xs:double : 0.0
  archive_priority = xs:int : 3
  bitDescription = xs:string
  default_timer_trig = xs:double : 1.0
  default_value = xs:unsignedLong : 0
  description = xs:string : -
  format = xs:string : %u
  initialize_devio = xs:boolean : 0
  min_step = xs:unsignedLong : 0
  min_timer_trig = xs:double : 0.001
  resolution = xs:unsignedLong : 65535
  units = xs:string : -
  whenCleared = xs:string
  whenSet = xs:string>

</...>

archive_delta

For a description of this characteristic, see documentation of the Plong propery. NOTE: This is normally not used, since the concept or "delta" does not really match well with the concept of a bit patterns. The charasteristic is defined because used in the template implementation of properties in C++. It might be possible to remove it using less generic templates.

Type:

xs:unsignedLong

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

bitDescription

This characteristic is a comma separated list of strings, each describing one of the bits in the pattern (in that order).

Type:

xs:string

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

For a description of this characteristic, see documentation of the Plong propery.

Type:

xs:unsignedLong

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 %u to map the intrisic structure of a pattern.

Type:

xs:string

Default:

%u

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_step

For a description of this characteristic, see documentation of the Plong propery.

Type:

xs:unsignedLong

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

whenCleared

This characteristic is a comma separated list of integer values, each representing a color code starting from 0 to be used when the corresponding bit is cleared. To be used by GUIs to display the status of the bits with a proper color code

Type:

xs:string

Use:

optional

Form:

unqualified

whenSet

This characteristic is a comma separated list of integer values, each representing a color code starting from 0 to be used when the corresponding bit is set. To be used by GUIs to display the status of the bits with a proper color code.

Type:

xs:string

Use:

optional

Form:

unqualified

Sub Types

{urn:schemas-cosylab-com:BACI:1.0}Ppattern (extension)
  |  
  +--{urn:schemas-cosylab-com:BACI:1.0}ROpattern (extension)
  |  
  +--{urn:schemas-cosylab-com:BACI:1.0}RWpattern (extension)

Source

<xs:complexType name="Ppattern">
  <xs:complexContent>
    <xs:extension base="Ppattern_">
      <xs:attribute default="0" name="default_value" type="xs:unsignedLong" use="optional">
      </xs:attribute>
      <xs:attribute default="0" name="min_step" type="xs:unsignedLong" use="optional">
      </xs:attribute>
      <xs:attribute default="0" name="archive_delta" type="xs:unsignedLong" use="optional">
      </xs:attribute>
      <xs:attribute default="" name="bitDescription" type="xs:string" use="optional">
      </xs:attribute>
      <xs:attribute default="" name="whenSet" type="xs:string" use="optional">
      </xs:attribute>
      <xs:attribute default="" name="whenCleared" type="xs:string" use="optional">
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>