Interface SiteModelRepositoryInterface

Site Model data repository.

The Site Model repository object enables standard create, read, update, and delete methods on Site Model Entities. Additional helpful methods are provided that enable more advanced retrieval of Site Model Entities.

Hierarchy

RestRepositoryInterface<SiteModelEntityInterface>
- SiteModelRepositoryInterface

Index

Methods

Methods

create

create(): SiteModelEntityInterface

Inherited from RestRepositoryInterface.create

Factory method. Creates and returns a new empty instance of the entity.

Returns SiteModelEntityInterface

filter

filter(params: RestFilterInterface): Promise<SiteModelEntityInterface[]>

Inherited from RestRepositoryInterface.filter

Find all repository items matching the filter parameters.

Parameters
- params: RestFilterInterface
Returns Promise<SiteModelEntityInterface[]>

findAll

findAll(forceFetch?: boolean): Promise<SiteModelEntityInterface[]>

Inherited from RestRepositoryInterface.findAll

Gets all repository items. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server.

Parameters
- Optional forceFetch: boolean
  
  Flag whether to force a server request or not. False by default.
Returns Promise<SiteModelEntityInterface[]>

Array of resources.

findByTypeAndDistance2D

findByTypeAndDistance2D(type: SiteModelType, pos: Vector3, maxDist: number): Promise<SiteModelEntityInterface[]>

Find Site Model Entities of a certain type within a given 2-dimensional radius [m] from a given point.

Parameters
- type: SiteModelType
  
  The SiteModelType to find.
- pos: Vector3
  
  The starting, central point to search from.
- maxDist: number
  
  The maximum distance [m] from the central point.
Returns Promise<SiteModelEntityInterface[]>

findClosestByTypeAndDistance2D

findClosestByTypeAndDistance2D(type: SiteModelType, pos: Vector3, maxDist: number): Promise<SiteModelEntityInterface>

Find the closest Site Model Entity of a certain type within a given 2-dimensional radius [m] from a given point.

Parameters
- type: SiteModelType
  
  The SiteModelType to find.
- pos: Vector3
  
  The starting, central point to search from.
- maxDist: number
  
  The maximum distance [m] from the central point.
Returns Promise<SiteModelEntityInterface>

findOne

findOne(id: number, forceFetch?: boolean): Promise<SiteModelEntityInterface>

Inherited from RestRepositoryInterface.findOne

Gets one repository item by id. The cached data will be returned if the data has been fetched before. Using the forceFetch parameter, a user can order a fresh copy to be fetched from the server. In case a new record is fetched, the data will be updated accordingly.

Parameters
- id: number
- Optional forceFetch: boolean
  
  False by default.
Returns Promise<SiteModelEntityInterface>

findWithin

findWithin(localLocation: Vector3 | Vector2, entityType?: SiteModelType): Promise<SiteModelEntityInterface[]>

Find Site Model Entities from a given local coordinate with optional Site Model type.

Parameters
- localLocation: Vector3 | Vector2
  
  Local point from which to find nearby Site Model Entities.
- Optional entityType: SiteModelType
  
  Reduce search to include only the given Site Model type.
Returns Promise<SiteModelEntityInterface[]>

generate

generate(): Promise<SiteModelEntityInterface[]>

Automatically generate a Site Model based on all datasets in the instance. Note that this will overwrite any existing Site Model data.

Returns Promise<SiteModelEntityInterface[]>

remove

remove(item: SiteModelEntityInterface): Promise<void>

Inherited from RestRepositoryInterface.remove

Deletes an item from the repository.

Parameters
- item: SiteModelEntityInterface
Returns Promise<void>

save

save(objects: SiteModelEntityInterface[]): Promise<SiteModelEntityInterface[]>

Overrides RestRepositoryInterface.save

Save Site Model Entities of type "BUILDING" or "FREE SPACE NAVIGATION AREA" to the database. Note that children SMEs of the given Building/Free-Space-Navigation-Area SME will be overwritten.

Parameters
- objects: SiteModelEntityInterface[]
  
  Collection of SiteModelEntityInterfaces to create or update.
Returns Promise<SiteModelEntityInterface[]>

updateAttributes

updateAttributes(objects: SiteModelEntityInterface[]): Promise<SiteModelEntityInterface[]>

Update the attributes of the given Site Model Entities. Please note that this only persists data that are not geometric properties.

Parameters
- objects: SiteModelEntityInterface[]
  
  Collection of SiteModelEntityInterfaces to update.
Returns Promise<SiteModelEntityInterface[]>

Generated using TypeDoc