Module space

Package com.here.mom.feature.indoor.space

Features

Parts

Enums


Access

enum Access

Module space

Access restrictions as characteristics of a space. This is used to identify what spaces in indoor maps are drivable, walkable, or both - or neither. This can be used e.g. by automated valet parking system to identify where a vehicle can drive. Vehicle-types cannot be used as it does not have a generic definition for vehicle, but ~20 separate ones, and if that class is extended by a new vehicle type, the drivable areas in existing indoor maps won't cover that new type. That is, the concepts are similar, and similarly named, but different. There is a well defined mapping, but indoor does not need, and is complicated by, the more precise granularity of the road network vehicle-types.

Value Description
UNDEFINED
PEDESTRIAN
BICYCLE
VEHICLE
NONE

LabelIcon

part LabelIcon

Module space

Property Type Modifier Description
referenceUri Url

LabelType

enum LabelType

Module space

Value Description
UNDEFINED
TEXT
ICON
NONE

Space

feature Space extends MomFeature, VenueFeature

Module space

Space refers to a physical space in a building, e.g. a room

Property Type Modifier Description
momType "indoor.Space"
id string
bbox BoundingBox optional
geometry Geometry A space of type room is typically 'Polygon'

A spaceObject can be a point-object if we do not know its area from the raw material that the customer provides

- example ATM machine can be Point or Polygon.

Currently, walls and doors are also line-string/multi-line string, till we do not facilitate capturing of

the thickness (which generally no customer provide)
properties SpaceProperties Space-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.

SpaceProperties

part SpaceProperties extends Common, VenueFeatureProperties

Module space

Highest-level space properties

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 Name for spaceType is the name of the spaceType instance, e.g. a name of a conference room. SpaceType has

its generic name, e.g. "Conference Room".
spaceCategory string Space category helps to categorize the spaces in the UI, and e.g. do searches from data storage for a subset

of spaces

Possible values are available in Indoor Map Rules (external to MOM).
spaceType string Space type is the sub-type of space category; space categories have multiple space types with similar

characteristics.

Possible values are available in Indoor Map Rules (external to MOM).
spaceTypeProperties SpaceTypeProperties optional Attributes that client is expected to configure. Optional, as some space types don't have any configurable

attributes.
parentSpace Space optional Space marked as a logical parent, example a shelf for a bin.
spaceAddress Address optional Internal space address using indoor-micro-pa category in properties
level Level Level to which this space belongs to.
drawOrder integer Represents draw order of this Space/Geometry on the Level.

drawOrder is unique for all spaces of a given level.

It is an integer value >= 0.

It is used to construct the array of Features for a given level, the order is important for the SDK and

other Renderers.

It cannot be computed from stackIndex
stackIndex integer It represents how many spaces are beneath this space on the Level,

It cannot be computed from drawOrder.

Allowed value is an integer >= 0
customerReferenceId string optional Reference to customers MIS id with respect to this object, we are not obliged to manage it,

but will keep placeholder so that customer can edit value and use it with our products.
Constraint Expression Description
drawOrderMin0 (.drawOrder >= 0)
stackIndexMin0 (.stackIndex >= 0)

SpaceTypeProperties

part SpaceTypeProperties

Module space

Configurable members, that vary within spaceType, hence values are in data

Property Type Modifier Description
isOccupiable boolean optional The space can be occupied by an occupant

This is a characteristics of the space type, not configurable
isNavigable boolean optional The space can be a destination of a navigation

This is a characteristics of the space type, not configurable
isLinearArea boolean optional Popular example of isLinearArea is indoor roads in current map making

This is a characteristics of the space type, not configurable
isNonPhysical boolean optional Example of isNonPhysical are markers, like entrance, separators of parking spaces, signs etc.

This is a characteristics of the space type, not configurable
isOpenArea boolean optional Space without physical walls

This is a characteristics of the space type, not configurable
isDisabledAccess boolean optional The space is accessible or reserved for people with disabilities
hasBabyChangingStation boolean optional The space has baby changing station (e.g. bathroom)
modality VehicleTypes optional Deprecated. Absence of modality indicates the modality of the space is unknown

Superseded by access-characteristics and routing graph / topology.
accessCharacteristics Access set Absence of access characteristics indicates the characteristics is unknown.

Used as characteristics for space types, can assist in topology creation.

E.g. a topology for a vehicles must never go to stairs.
gender Gender optional Access to the space is limited by the gender
isPaymentRequired boolean optional Access to the space requires payment. E.g. parking
currency CurrencyType optional Supported currency of the space, e.g. space representing an ATM
capacity double optional Capacity of the space, e.g. how many people can fit to a room, or how many litres a tank can accommodate
clearanceHeightCm integer optional Clearance height in centimeters. Relevant for some cases at least if it is less than level clearance height.

Space may also represent entrance, and in that case the clearance-height is especially relevant and can

determine the level clearance-height.
isRestrictedArea boolean optional The space is for restricted use only, not for public use
parkingTypeProperties ParkingTypeProperties optional Properties specific to parking spots/spaces or parking sections
trafficZoneTypes ParkingFacilityTrafficZoneType set Properties specific to traffic zones within parking facility.

A traffic zone is an independent area within a parking facility, not a parking spot or set of parking spots.

Typically only one type is present at a time, but in some cases there can be some combinations too.
bicycleRackTypes BicycleRackType set Properties specific to bicycle racks.
tags LanguageProperty list Customer specific tags for the space
customDisplayText LanguageProperty list Custom display text, is by default empty
styleProperties StyleProperties optional Custom style properties for the space, in case the default ones from Indoor Map Rules shall not be applied.
textLabelStyleProperties StyleProperties optional Custom text style properties for the space, in case the default ones from Indoor Map Rules shall not be applied.
labelType LabelType optional Custom label-type for the space, in case the default ones from Indoor Map Rules shall not be applied.
labelIcon LabelIcon optional Custom label icon for the space, in case the default ones from Indoor Map Rules shall not be applied.
traversalTypes TraversalType set Allowed traversal types in case the feature is part of a level connector.

TraversalType

enum TraversalType

Module space

Types of traversal possible for spaces on level connectors. Traversal types can be combined as needed.

Value Description
UNDEFINED
ELEVATOR
ESCALATOR
RAMP
STAIRS

results matching ""

    No results matching ""