Skip to content
We're currently creating a lot of content. Sign up to get notified when it's ready.

Asset

The Asset API lets you get information about the assets in the network. You can get a list of all the assets in the network using the getAssets method of the Network object. Part of the information that you can get from an asset is its readings data. See Readings for more details.

Values with physical units (diameters, lengths, pressures, flows…) are expressed in the units of the network. Use sdk.network.getUnits() to know which ones apply.

All assets in Qatium have a set of common properties.

  • id: A string representing the asset’s unique identifier.
  • originalId: The original id of the asset.
  • clusterId: The id of the cluster that the asset belongs to.
  • level: The network level of the asset, arterial or distribution. See Levels.
  • type: The type of the asset. See AssetTypes for more details.

Every asset also has:

  • readings: An object with the latest readings of the asset and the methods to query them. See Readings for more details.
  • sensors: An array with the names of the properties measured by sensors attached to the asset (for example, ["pressure"] for a junction).
  • simulation: Optional. An object with the simulation results of the asset for the current network time. Its values are undefined while the simulation is not available (see isSimulationLoading()).
  • zones: An array with the IDs of the zones the asset belongs to. Empty for assets outside zones or for networks without zones.
  • getPeriodSimulation(): Function that returns an array with the simulation results for the whole simulation period, as { date: Date, results } objects, where results has the same shape as simulation.

Represents a supply source in the network.

  • description: Optional. A string with the description of the supply source.
  • elevation: The elevation of the supply source.
  • geometry: The geometry of the supply source, as a GeoJSON Point object.
  • head: Optional. The head of the supply source at the start of the simulation period.
  • pattern: Optional. Currently not populated.
  • head: The head of the supply source.
  • waterAge: Optional. The water age at the supply source, in hours.

Represents a tank in the network.

  • canOverflow: Optional. Currently not populated.
  • description: Optional. A string with the description of the tank.
  • diameter: The diameter of the tank.
  • elevation: The elevation of the tank.
  • geometry: The geometry of the tank, as a GeoJSON Point object.
  • initialLevel: The water level of the tank at the start of the simulation period.
  • maximumLevel: The maximum water level of the tank.
  • minimumLevel: The minimum water level of the tank.
  • minimumVolume: Currently not populated. Always Infinity.
  • volumeCurveId: Optional. Currently not populated.
  • level: The water level of the tank.
  • pressure: The pressure at the tank.
  • volume: The volume of water in the tank.
  • waterAge: Optional. The water age in the tank, in hours.
  • netInflow: Optional. The net flow into or out of the tank (positive when filling, negative when draining), in simulation-native units (L/s for the international system, GPM for the US customary system).

Represents a pump in the network.

  • description: Optional. A string with the description of the pump.
  • elevation: The elevation of the pump.
  • geometry: The geometry of the pump, as a GeoJSON Point object.
  • head: Optional. Typed as string, but currently not populated.
  • pattern: Optional. Currently not populated.
  • power: The power of the pump, or null if not available.
  • setting: The setting (relative speed) of the pump.
  • status: The status of the pump. One of OPEN, or CLOSED.
  • status: The status of the pump, OPEN or CLOSED.
  • setting: The setting of the pump.
  • upstreamPressure: The pressure at the inlet of the pump.
  • downstreamPressure: The pressure at the outlet of the pump.
  • flow: Optional. The flow through the pump.
  • velocity: Optional. The velocity through the pump.
  • headloss: Optional. The headloss through the pump.
  • unitaryHeadloss: Optional. Currently not populated.
  • isSupplied: Whether the pump is supplied.

Represents a junction in the network.

  • demand: The demand of the junction at the start of the simulation period, or null if not available.
  • description: Optional. A string with the description of the junction.
  • elevation: The elevation of the junction.
  • emitter: The emitter coefficient of the junction, or null if it has no emitter. See getEmitterExponent().
  • geometry: The geometry of the junction, as a GeoJSON Point object.
  • group: The group of the junction. See JunctionGroups.
  • pressure: The pressure at the junction.
  • demand: The demand of the junction.
  • isSupplied: Whether the junction is supplied.
  • waterAge: Optional. The water age at the junction, in hours.

Represents a pipe in the network.

  • description: Optional. A string with the description of the pipe.
  • diameter: The diameter of the pipe.
  • geometry: The geometry of the pipe, as a GeoJSON LineString or MultiLineString object.
  • group: The group of the pipe. See PipeGroups.
  • installationDate: The installation date of the pipe, as a Date object. When the date is unknown, it is an Invalid Date. To check it, use !isNaN(pipe.installationDate.getTime()).
  • isCV: Whether the pipe has a check valve.
  • length: The length of the pipe.
  • material: Optional. The material of the pipe. See a list of possible values in the Materials section.
  • minorLoss: The minor loss coefficient of the pipe.
  • roughness: The roughness of the pipe.
  • status: The status of the pipe, OPEN or CLOSED.

Qatium calculates network levels during import, allowing for fast visualization of the arterial or distribution part of the network. To calculate them, Qatium takes the 80th percentile of the pipe diameters:

  • Pipes below the 80th percentile are part of the distribution level.
  • Pipes equal to or above it are part of the arterial level.

Then, it checks for network level consistency:

  • Every distribution pipe connected at both ends to arterial pipes is set to arterial.
  • Every arterial pipe not connected to an arterial path leading to a supply source is set to distribution.
  • Pipes connected to valves, pumps or tanks are arterial regardless of their diameter, unless they are not connected to a supply source.
  • status: The status of the pipe, OPEN or CLOSED.
  • flow: The flow in the pipe.
  • velocity: The velocity in the pipe.
  • unitaryHeadloss: The headloss per unit of length of the pipe.
  • isSupplied: Whether the pipe is supplied.

Represents a valve in the network.

  • curveId: Optional. Currently not populated.
  • description: Optional. A string with the description of the valve.
  • diameter: The diameter of the valve.
  • elevation: The elevation of the valve.
  • family: The family of the valve. See ValveFamilies.
  • geometry: The geometry of the valve, as a GeoJSON Point object.
  • group: The group of the valve. See ValveGroups.
  • minorLoss: The minor loss coefficient of the valve.
  • setting: The setting of the valve. Its meaning depends on the valve family.
  • status: The status of the valve, OPEN, CLOSED or ACTIVE.
  • status: The status of the valve, OPEN, CLOSED or ACTIVE.
  • setting: The setting of the valve.
  • flow: Optional. The flow through the valve.
  • velocity: Optional. The velocity through the valve.
  • headloss: Optional. The headloss through the valve.
  • unitaryHeadloss: Optional. Currently not populated.
  • isSupplied: Whether the valve is supplied.