API reference / @zaes/sidc/catalog

@zaes/sidc/catalog

@zaes/sidc/catalog — what every 2525E Change 1 code means: entity names and hierarchy, what kind of drawing each is, its draw rule or icon type, and every sector modifier.

A separate entry so that reading a code does not cost the ~175 KB of tables.

Interfaces

• Entity
• SectorModifier
• SidcDescription

Type Aliases

EntityKind

type EntityKind = "icon" | "frame" | "point" | "multipoint" | "hierarchy";

What kind of drawing an entity is:

• icon: an icon inside a frame (every framed symbol set);
• frame: the 000000 Unspecified entity, a frame with no icon;
• point: a control measure or METOC symbol placed at one anchor point at a fixed screen size;
• multipoint: a line, an area, or a one-anchor shape sized in map units (a range fan, a circular target);
• hierarchy: a heading in the table with nothing of its own to draw.

Functions

describeSidc()

function describeSidc(sidc): SidcDescription;

What positions 11–20 of a 2525D/E code mean, by the 2525E Change 1 tables.

Parameters

sidc

string | NumericSidc

Returns

SidcDescription

---

getEntity()

function getEntity(symbolSet, code): Entity | undefined;

The entity a symbol set and positions 11–16 name, or undefined if 2525E Change 1 has none.

Parameters

symbolSet

string

code

string

Returns

Entity | undefined

---

getSectorModifier()

function getSectorModifier(
   symbolSet, 
   sector, 
   code, 
   identifier?
): SectorModifier | undefined;

The sector modifier a code names. identifier is SIDC position 21 (sector 1) or 22 (sector 2): '0' looks in the symbol set's own table, anything else in the common table (A-IX, A-X), whose codes are the identifier followed by the two modifier positions.

Parameters

symbolSet

string

sector

1 | 2

code

string

identifier?

string = '0'

Returns

SectorModifier | undefined

---

listEntities()

function listEntities(filter?): Entity[];

Every entity, in the standard's order, optionally of one symbol set or kind.

Parameters

filter?

kind?

EntityKind

symbolSet?

string

Returns

Entity[]

---

listSectorModifiers()

function listSectorModifiers(symbolSet, sector): SectorModifier[];

The sector modifiers of one symbol set (or common), in the standard's order.

Parameters

symbolSet

string

sector

1 | 2

Returns

SectorModifier[]