Cell Simulator – Region Configuration

You can use a Readable Unit anywhere where you have the option of:

  • number or string

  • integer or string

📃 Corresponding configuration file: cell/regions.json

Regions

Schema describing the JSON file structure for the regional networks configuration. It is is used to extend the network with regional information, which enables the emulation of mobile networks. If configured very granular, these regions can reflect cells as used in the real world. Though for most use-cases it is sufficient to approximate the behaviour by defining larger regions.

Properties

Type Description Required Boundaries Default
regions mobileNetworkProperties[] An array of regional network configruations. No None None

mobileNetworkProperties

Object to define a network with specific geograpgical extensions. It applies for all regions except the global network, which covers the remaining space. The CMobileNetworkProperties only needs to be employed, when geographic information are accessed.

Properties

Type Description Required Boundaries Default
id string Network-Id for identification. No None None
area geoRectangle Object to define an immutable pair of two different geoPoints. Together they form a rectangular area. ✓ Yes None None
polygon object The area of the network as a polygon. ✓ Yes None None
uplink mobileNetworkProperties.uplink Object to define the uplink of a network. The uplink direction only allows point-to-point communication (unicast). It is composed of the three nested models for delay, transmission configuration and capacity. ✓ Yes None None
downlink mobileNetworkProperties.downlink Object to define the downlink of a network. The downlink supports two individual paths: Point-to-point communication (unicast) and Point-to-multipoint communication (multicast). ✓ Yes None None

geoRectangle

Object to define an immutable pair of two different geoPoints. Together they form a rectangular area.

Properties

Type Description Required Boundaries Default
nw geoPoint Object to define geographical point coordinates. ✓ Yes None None
se geoPoint Object to define geographical point coordinates. ✓ Yes None None

geoPoint

Object to define geographical point coordinates.

Properties

Type Description Required Boundaries Default
lon number East-west position of a point on earth. ✓ Yes [-180, 180] None
lat number North-south position of a point on earth. ✓ Yes [-$\infty$, 90] None

Object to define the uplink of a network. The uplink direction only allows point-to-point communication (unicast). It is composed of the three nested models for delay, transmission configuration and capacity.

Properties

Type Description Required Boundaries Default
delay delay Object to define a delay model. ✓ Yes None None
transmission transmission Object to define the properties of a transmission. ✓ Yes None None
capacity integer
string		 The capacity of the uplink. ✓ Yes None None

delay

Object to define a delay model.

Additionally ONE of the following property definitions apply:

gammaDelay

Object to define a model for GammaRandomDelay or GammaSpeedDelay. GammaRandomDelay bases directly on the Gamma distribution (b=2,p=2) with minimum and expected value. Due to the nature of the Gamma distribution, the resulting delays can be far higher than the expected value. GammaSpeedDelay bases on the GammaRandomDelay and includes an additional speed penalty according to the current speed of the vehicle.

Properties

Type Description Required Boundaries Default
type string Type of Gamma delay. ✓ Yes Enum None
minDelay number
string		 Minimum delay for the Gamma distribution. If defined as a number, then the default unit is ns. Alternatively this can be defined as a string to include the unit of measurement (e.g. ‘3 seconds’) ✓ Yes None None
expDelay number
string		 Expected delay for the Gamma distribution. If defined as a number, then the default unit is ns. Alternatively this can be defined as a string to include the unit of measurement (e.g. ‘3 seconds’) ✓ Yes None None

Further property restrictions:

gammaDelay.type

  • Allowed values:
    • GammaRandomDelay
    • GammaSpeedDelay

constantDelay

Object to define a model for constant delay, which delivers always the same delay.

Properties

Type Description Required Boundaries Default
type string Type of the constant delay ✓ Yes Enum None
delay number
string		 The delay, given in ns if defined as a number. Alternatively this can be defined as a string to include the unit of measurement (e.g. ‘3 seconds’) ✓ Yes None None

Further property restrictions:

constantDelay.type

  • Allowed values:
    • ConstantDelay

simpleRandomDelay

Object to define a model for a radnomised delay. Delivers number-of-steps different uniformly distributed delays in the interval defined by min and max (e.g. minDelay=30ms, maxDelay=60ms, steps=4 -> possible delays={30,40,50,60}ms.).

Properties

Type Description Required Boundaries Default
type string Type of the delay. ✓ Yes Enum None
steps integer Number of possible delays between min and max. ✓ Yes [0, +$\infty$] None
minDelay number
string		 Minimum delay in nanoseconds for the Gamma distribution. If defined as a number, then the default unit is ns. Alternatively this can be defined as a string to include the unit of measurement (e.g. ‘3 seconds’) ✓ Yes None None
maxDelay number
string		 Maximum delay in nanoseconds for the Gamma distribution. If defined as a number, then the default unit is ns. Alternatively this can be defined as a string to include the unit of measurement (e.g. ‘3 seconds’) ✓ Yes None None

Further property restrictions:

simpleRandomDelay.type

  • Allowed values:
    • SimpleRandomDelay

tranmission

Object to define the properties of a transmission.

Properties

Type Description Required Boundaries Default
lossProbability number Probability of packet retransmission (in case of configured retries > 0) or packet loss (retries = 0) for the packet retransmission/loss model. A value of 0 equals a lossfree transmission. ✓ Yes [0, 1] 0
maxRetries integer Maximum Number of retransmissions. No [0, +$\infty$] None

Object to define the downlink of a network. The downlink supports two individual paths: Point-to-point communication (unicast) and Point-to-multipoint communication (multicast).

Properties

Type Description Required Boundaries Default
unicast unicast Object to define point-to-point communication. ✓ Yes None None
multicast multicast Object to define point-to-multipoint communication. ✓ Yes None None
capacity integer
string		 The capacity of the downlink. ✓ Yes None None

unicast

Object to define point-to-point communication.

Properties

Type Description Required Boundaries Default
delay delay Object to define a delay model. ✓ Yes None None
transmission transmission Object to define the properties of a transmission. ✓ Yes None None

multicast

Object to define point-to-multipoint communication.

Properties

Type Description Required Boundaries Default
delay delay Object to define a delay model. ✓ Yes None None
transmission transmission Object to define the properties of a transmission. ✓ Yes None None
usableCapacity number The usableCapacity configures the ratio of the overall downlink capacity allowed to be used. ✓ Yes [0, 1] None