Module entrance

Package com.here.mom.feature.indoor.entrance

Features

Parts

Enums

Entrance

feature Entrance extends MomFeature, VenueFeature

Module entrance

Entrance or exit to a structure in indoor map. Many properties like the directionality and modality come from the topology that is expected to pass through the entrance.

Property Type Modifier Description
momType "indoor.Entrance"
id string
bbox BoundingBox optional
geometry Geometry Entrance is typically represented as a line or possibly as a (thin) polygon,

but in case the total width is not known or not relevant, it can be a point too.
properties EntranceProperties
referencePoint Point optional This is the location of this feature, collapsed to a single point.

This is for any application where an approximate, but deterministic and consistent, location is useful. One

example is deciding where to "anchor" a feature within a tiled map database.

Any Reference to this feature should include this point.
nonSpatialPartitionKey string optional The partition id for a generically partitioned feature.

Generically partitioned features fall into two categories:

1. Features that have a spatial component but may not make sense to partition based on that geometry.

2. Features that don't have a strong spatial component.

How keys will be assigned and what value ranges will be used are not specified.

Examples of generically partitioned features are admin, zone, postal, phonetics, metadata, etc.
Constraint Expression Description
atMostOneDefinedProperty (is-empty(.referencePoint) is-empty(.nonSpatialPartitionKey)) At most one of non-spatial-partition-key and reference-point can be defined.

EntranceProperties

part EntranceProperties extends Common, VenueFeatureProperties

Module entrance

Whether this is entrance or exit, modality, opening hours etc are specified in the topology that passes through this entrance.

Property Type Modifier Description
@ns:com:here:mom:meta Metadata optional
@ns:com:here:mom:rmob string optional Currently not specified - may be specified by each Feature individually in future
featureType FeatureType optional Deprecated. This property is redundant to MomFeature.momType and should not be used.

MOM clients before 2.6 release had this deprecated property set to required, so

if data needs to be JSON schema validated by clients before 2.6 this property must be

set by the writer.
isoCountryCode Country optional Deprecated. This indicates which country a Feature is in, with a couple caveats.

- It may be unknown ("NONE" is a valid value, in addition to "UNDEFINED" like all MOM enums) simply because the

writer has not tried to figure it out or has otherwise not had the means to do so.

- It may be outright incorrect or a simplification of reality, specifically when a Feature is close to a country

border or in a disputed area (e.g., two or more countries claim the same area).

In all cases, writers and readers of this data should understand that the semantics of this property must be

agreed upon (if it is used at all). The preferred method of relating a Feature to a Country is through a

(direct or transitive) Reference from the Feature to an Admin.
@ns:com:here:mom:delta Branch optional
@ns:com:here:mom:mapcreator MapCreator optional
@ns:com:here:xyz Xyz optional Generic Data Hub namespace
extensionOSM MomOsm optional Optional extension for OSM (Open Street Map) metadata,

in case the object came from OSM
@ns:com:here:groundTruth GroundTruth optional Ground truth namespace
confidence ConfidenceData optional Confidence of a feature, optional only for the features

that are not participating in Quality Index.
venueId string optional Deprecated. Id of the venue. Venue Id is generated outside of MOM, and is used by the different components/services of venues.

There is no venue object, hence this is not a reference to any object,

but conceptually venue is a collection of objects of momType "indoor.{Site, Structure, Level, Space, Occupant}".

This id is linking every object to the venue.

It may have the same value as the Site object, but it doesn't have to have.

Each feature could be considered to be identifiable by a 2-level id: the venueId + feature id.

The feature id is also unique by itself.
indoorMapId string Id of the indoor map. The id is generated outside of MOM, and is used by the different components/services

of the indoor map.

Indoor map is a collection of objects of momType "indoor.{Site, Structure, Level, Space, Occupant, ...}".

This id is linking every object to the specific indoor map.

It may have the same value as the Site object, but it doesn't have to have.

Each feature could be considered to be identifiable by a 2-level id: the indoor map id + feature id.

The feature id is also unique by itself.
renderProperties RenderProperties optional optional object, will appear only for following objects Site, Structure, Level, Space (Vectors)
names Name list Optional name, e.g. "West street entrance"
clearanceHeightCm integer optional Clearance height of the entrance in centimeters, if relevant.
clearanceWidthCm integer optional Clearance width of the entrance, in centimeters, if relevant (e.g. for car entrances).
type EntranceType Type of entrance
level Level Level to which this entrance belongs to. Through the level also the structure is known.
address Address optional Internal address as micro-pa; enables connecting the entrance to the routing network of the indoor map.
Constraint Expression Description
clearanceHeightCmMin1 (non-empty(.clearanceHeightCm) -> (head(.clearanceHeightCm) >= 1))
clearanceWidthCmMin1 (non-empty(.clearanceWidthCm) -> (head(.clearanceWidthCm) >= 1))

EntranceType

enum EntranceType

Module entrance

Type of the entrance.

Value Description
UNDEFINED
DOOR_WAY entrance through a door
WALL_OPENING entrance through an opening

results matching ""

    No results matching ""