GBBopen 1.5 Reference -- instance-dimension-value

instance-dimension-value

instance-dimension-value

unit-instance dimension-name => dimension-value, dimension-value-type, comparison-type, composite-type,| ordering-dimension-name

[Function]

Package :gbbopen

Module :gbbopen-core

Arguments and values

unit-instance		A unit instance
dimension-name		A symbol specifying a dimension of `unit-instance`
dimension-value		An object
dimension-value-type		One of: `:point`, `:interval`, `:mixed`, `:element`, or `:boolean`
comparison-type		One of: `number`, `fixnum`, `short-float`, `single-float`, `double-float`, `long-float`, or `pseudo-probability`
composite-type		One of `:set`, `:sequence`, (`:ascending-series` `ordering-dimension-name`), (`:descending-series` `ordering-dimension-name`), or `nil`
ordering-dimension-name		A non-keyword symbol or `nil`

Returns
Five values:

the dimension value of the unit-instance in the specified dimension
the dimension-value type of the specified dimension
the comparison type of the specified dimension
the composite type of the dimension value if it is a composite dimension value; nil if it is an incomposite dimension value
the name of the ordering dimension, if the dimension value is a series-composite dimension value; nil otherwise

Errors
The dimension dimension-name is not defined for unit-instance.

Examples
Return the x dimension value of the unit instance, hyp:

  > (instance-dimension-value hyp 'x)
  1835
  :point
  :fixnum
  nil
  nil
  >

and its classification dimension value:

  > (instance-dimension-value hyp 'classification)
  (:car :truck)
  :element
  eq
  :set
  nil
  >

Return the character dimension value of the unit instance, word:

  > (instance-dimension-value w 'character)
  "what's"
  :element
  eql
  :set
  nil
  >

and its char-code dimension value:

  > (instance-dimension-value word 'char-code)
  (119 104 97 116 39 115)
  :point
  fixnum
  :set
  nil
  >

instance-dimension-value