Module structure

Package com.here.mom.feature.indoor.structure

Features

Parts

Structure

feature Structure extends MomFeature, VenueFeature

Module structure

Structure is a building, parking structure etc

Property Type Modifier Description
momType "indoor.Structure"
id string
bbox BoundingBox optional
geometry MultiPolygon Structure geometry represents footprint of the structure, combining the outlines of the levels it contains.

In case there are both indoor and outdoor levels referencing to the structure, only indoor levels are included in the geometry.

It can be a multipolygon or a polygon represented as a multipolygon.
properties StructureProperties Structure-specific properties
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.

StructureProperties

part StructureProperties extends Common, VenueFeatureProperties

Module structure

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 of the structure
structureType VenueType At least for now, we use the venue type also for structures
address Address optional Usually Structure address is same as Site address

If needed, the structure address can be modeled as an address of type micro-pa
clearanceHeightCm integer optional Clearance height for the structure in centimeters.

This is one of the clearance heights of the levels, typically the height of the main entrance.

It indicates the max guaranteed height for most parts of the structure; exceptions are provided in level

and/or space data when relevant.
baseElevationCm integer optional Elevation of a selected point in structure, typically the main level, from sea level, in centimeters. Can

be negative. In case it is not present and relative elevations are present, the value can be considered

to be 0 and relative elevations will give the absolute values.

This is the reference elevation for all levels, who only provide their elevation as delta against this one.

EGM96, the Earth Gravitational Model from 1996, is used as the standard reference system for sea level,

to provide compatibility with NDS.
drawOrder integer Amongst all drawings, this indicates rendering preference

"drawOrder": 0 is to be rendered first with details when user opens a venue
outdoorReferences OutdoorReferences optional HERE Places, Footprints and possibly other references. Only given here if references in site feature are not

accurate enough.
parkingRestrictions ParkingFacilityRestrictions optional If this is a parking garage, there may be some parking-specific access restrictions specific to this structure.

If there are site-level restrictions, they are expected to apply to all structures, without replicating the same for each structure.

However, if the structure has additional / deviating restrictions from the site,

then structure level restrictions apply for the structure.

Absence means no structure-specific restrictions, but possible site-level restrictions apply.
Constraint Expression Description
drawOrderMin0 (.drawOrder >= 0)

results matching ""

    No results matching ""