GBBopen 1.5 Reference -- initial-class-instance-number

initial-class-instance-number

initial-class-instance-number

unit-class-name-or-instance => integer

[Generic Function]

Purpose
Return the initial instance-name counter value associated with a unit class.

Method signatures

initial-class-instance-number (unit-class-name symbol) => integer

initial-class-instance-number (unit-instance standard-unit-instance) => 0

Package :gbbopen

Module :gbbopen-core

Arguments and values

unit-class-name-or-instance		A unit instance or a symbol naming a unit class
integer		An integer

Returns
The initial instance-name counter value associated with the unit class.

Examples
Return the initial instance-name value associated with unit class ksa:

  > (initial-class-instance-number 'ksa)
  0
  >

Note
The initial instance-name value associated with a unit class is not used if the :use-global-instance-name-counter class option is true for the unit class.

The GBBopen Project

initial-class-instance-number