Mobile Subnetwork Object
Mobile subnetwork objects can be used in much the same way as fixed subnetwork objects. They can be nested within other subnetworks to create a subnetwork hierarchy. Unlike fixed subnetworks, mobile subnetworks cannot be connected via simplex, duplex, or bus links, nor can the objects inside a mobile subnetwork be connected to any outside object via these links. The default icon representing the mobile subnetwork object is shown in the following figure.
Figure 59: Default Mobile Subnetwork Icon

At the top network level, mobile subnetwork objects are located within a global coordinate system with latitude, longitude, and altitude specifications. In turn, within each subnetwork the user can define a Cartesian coordinate system by selecting units and grid intervals for the display. The subnetwork has a certain region associated with it called the subnetwork extent. The extent defines the boundaries of the subnetwork. For example, if a subnetwork has an extent of 2000 meters in the x direction and an extent of 3000 meters in the y direction centered on point (a,b), then objects within that subnetwork can have positions between (a-1000 meters, b-1500 meters) and (a+1000 meters, b+1500 meters).
Mobile Subnetwork Object Attributes
The built-in attributes of mobile subnetwork objects are listed below, in alphabetical order.
Table 19: Subnetwork Object Attributes
| Name | Editing Data Type |
|---|---|
| altitude | double |
| altitude modeling | enumerated |
| ascent rate | string |
| attribute promotion | toggle |
| bearing | double |
| color | color |
| creation data | string |
| creation source | string |
| creation timestamp | date |
| financial cost | string |
| ground speed | string |
| icon name | string |
| map | typed file |
| minimized icon | minimized icon |
| name | string |
| outline color | color |
| pitch | double |
| position cache time granularity | double |
| priority | integer |
| roll | double |
| sys id | integer |
| threshold | double |
| trajectory | typed file |
| trajectory_speed_override | toggle double |
| unit | integer |
| user id | integer |
| x position | double |
| y position | double |
| yaw | double |
altitude
This attribute represents the distance of a mobile subnet from sea level on the surface of the earth, in meters.
If a trajectory file is specified, the value is recomputed automatically each time the mobile node needs to update its position. If a trajectory file is not specified, the value can be updated dynamically via the Kernel Procedure op_ima_obj_attr_set_dbl().
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write | read / write |
| Default Value | 0.0 | |
| Units | meters | |
| Constraints | None |
altitude modeling
This attribute determines how the Simulation Kernel interprets an object’s altitude attribute. Three settings are possible:
- relative to subnet – The altitude setting is interpreted as the object’s altitude above the current subnet.
- absolute – the altitude setting is the object’s altitude above global sea level.
- relative to terrain – the altitude setting is the object’s altitude above the underlying terrain (mountain, valley, ocean, etc.)
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | enumerated |
| Access | read / write / promote | read |
| Default Value | relative to subnet | |
| Units | N/A | |
| Constraints | See description |
ascent rate
This attribute specifies the vertical speed of the mobile subnet. It is used only when the subnet’s trajectory attribute is set to VECTOR. The attribute string is composed of a numerical value followed by a speed unit, as in “3 meter/sec”. The speed unit is either “knot” or a combination of a length unit (meter, kilometer, feet, mile, or nautical mile) and a time unit (sec, min, hour) separated by “/”.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read / write / promote | read / write |
| Default Value | None | |
| Units | See description | |
| Constraints | None |
attribute promotion
This attribute allows you to control the display of promoted attributes. When enabled, promoted attributes of objects contained in the subnet display in the subnet’s attribute list. When disabled, promoted attributes do not display or promote to the parents of the subnet.
The attribute is most useful when a model contains many levels of nested subnets, each with many nodes and many promoted attributes. In this case, displaying the Attributes dialog box of any subnet (especially the top subnet), or scrolling through the list of attributes, can be slow and cumbersome. It is recommended that you set this attribute to “disabled” except when you need to display or modify the value of a promoted attribute on a subnet.
The value of this attribute has no effect on simulation behavior.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | N/A |
| Access | read / write | N/A |
| Default Value | disabled | |
| Units | N/A | |
| Constraints | None |
bearing
This attribute specifies the bearing off north (0 - North, 90 - East, 180 - South, 270 - West) of the mobile subnet. It is used only when the subnet’s trajectory attribute is set to VECTOR.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 0.0 | |
| Units | degrees | |
| Constraints | 0.0 <= bearing < 360.0 |
color
This attribute specifies the color of a mobile subnet’s trajectory for the purpose of its depiction within the display. This attribute has no effect on simulation. The color attribute can have values ranging from RGB000 to RGB333 where each digit is an integer between 0 and 3 inclusive. The higher the first digit, the more red, the higher the second digit, the more green, and the higher the third digit, the more blue. Thus RGB000 corresponds to black, RGB333 corresponds to white, RGB300 corresponds to red, and so on.
| Editing | Simulation | |
|---|---|---|
| Data Type | color | N/A |
| Access | read / write | N/A |
| Default Value | RGB333 | |
| Units | N/A | |
| Constraints | None |
creation data
This attribute specifies additional information about the creation of the object.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | not applicable |
| Access | read/write | not applicable |
| Default Value | “” | |
| Units | ||
| Constraints |
creation source
This attribute specifies how the object was created.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | not applicable |
| Access | read/write | not applicable |
| Default Value | “Object Palette” | |
| Units | ||
| Constraints |
creation timestamp
This attribute specifies when the object was created.
| Editing | Simulation | |
|---|---|---|
| Data Type | date | not applicable |
| Access | read/write | not applicable |
| Default Value | ||
| Units | ||
| Constraints |
financial cost
This attribute specifies the cost of purchasing or maintaining the object.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read/write/promote | read/write |
| Default Value | “0.00” | |
| Units | ||
| Constraints |
ground speed
This attribute specifies the speed relative to the ground of the mobile subnet. It is used only when the subnet’s trajectory attribute is set to VECTOR. The attribute string is composed of a numerical value followed by a speed unit, as in “3 meter/sec”. The speed unit is either “knot” or a combination of a length unit (meter, kilometer, feet, mile, or nautical mile) and a time unit (sec, min, hour) separated by a “/”.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read / write / promote | read / write |
| Default Value | None | |
| Units | See description | |
| Constraints | None |
icon name
This attribute allows the user to modify the bitmap used to represent the subnetwork within network diagrams. Icons can be created with the icon editor. The value of this attribute has no effect on simulation behavior.
| Editing | Simulation | |
|---|---|---|
| Data Type | icon | N/A |
| Access | read / write | N/A |
| Default Value | subnet | |
| Units | N/A | |
| Constraints | None |
map
This attribute specifies the name of a cartographic data set file with a .cds suffix (the suffix is not included in the attribute value) whose content is depicted in the Project Editor.
This attribute has no effect on simulations.
| Editing | Simulation | |
|---|---|---|
| Data Type | typed file | N/A |
| Access | read / write | N/A |
| Default Value | None | |
| Units | N/A | |
| Constraints |
minimized icon
This attribute specifies how the subnet will be displayed when scaling would cause it to appear too small to be represented by its original icon.
| Editing | Simulation | |
|---|---|---|
| Data Type | minimized icon | not applicable |
| Access | read/write | not applicable |
| Default Value | “circle/#FF0000” | |
| Units | ||
| Constraints |
name
This attribute specifies a text string which is used for identification purposes. During simulation it is typically used for performing routing, aiding in debugging, and finding Object IDs. The subnetwork name appears in the name of each object contained in it and each level of hierarchy is separated by a “.”. For example, if subnet_1 is nested hierarchically in subnet_2, the full name of subnet_2 is “top.subnet_1.subnet_2”. The value of this attribute has no effect on simulations.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read / write | read |
| Default Value | mobile_subnet_n, n >= 0 |
|
| Units | N/A | |
| Constraints | unique name, no dots, not “top” |
outline color
This attribute specifies the color of a subnetwork perimeter display for the purpose of its depiction in the Project Editor. This attribute has no effect on simulation. The outline color attribute can have values ranging from RGB000 to RGB333, where each digit is an integer between 0 and 3 inclusive. The higher the first digit, the more red; the higher the second digit, the more green; and the higher the third digit, the more blue. Thus RGB000 corresponds to black, RGB333 corresponds to white, RGB300 corresponds to red, etc. If it is preferable not to display the subnetwork’s perimeter, choose black from the color palette to hide it.
| Editing | Simulation | |
|---|---|---|
| Data Type | color | N/A |
| Access | read / write | N/A |
| Default Value | RGB133 | |
| Units | N/A | |
| Constraints | None |
pitch
This attribute specifies the pitch component of a mobile subnet’s orientation in space. The other orientation components are roll and yaw. If a trajectory file is specified, the Simulation Kernel automatically updates the value for this attribute based on the current trajectory segment setting.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 0.0 | |
| Units | degrees | |
| Constraints | None |
position cache time granularity
This attribute specifies a time window within which the position of the mobile subnet is assumed to be constant and will not be recalculated. The default value is set to the value of the default_site_position_cache_time_granularity attribute of op_runsim.
| Editing | Simulation | |
|---|---|---|
| Data Type | N/A | double |
| Access | N/A | read / write |
| Default Value | see description | |
| Units | seconds | |
| Constraints | None |
priority
This attribute is used when multiple events are scheduled for the same simulation time, to determine in which order they will be executed. Higher priority events are executed first. Event priority is evaluated hierarchically with subnet priority being weighted higher than node priority, which is in turn weighted higher than module priority. Only the priority of the lowest parent subnet is considered when evaluating the priority of an event occurring at a module.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read / write / promote | read / write |
| Default Value | 0 | |
| Units | N/A | |
| Constraints | absolute value <= 32,000 |
roll
This attribute specifies the roll component of a mobile subnet’s orientation in space. The other orientation components are pitch and yaw. If a trajectory file is specified, the Simulation Kernel automatically updates the value for this attribute based on the current trajectory segment setting.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 0.0 | |
| Units | degrees | |
| Constraints | None |
sys id
This attribute contains a positive read-only integer which is provided for identification purposes. The system assigns a unique number to each mobile subnetwork object. This number typically corresponds to the order in which the objects are created: the first subnet created has sys id 0, the second subnet has sys id 1, and in general the nth subnet has sys id n-1. It can be used, for instance, in identifying a mobile subnet within a route or when looping through mobile subnets to access their attributes, or in general whenever a unique integer identification is required. This attribute exists only during simulation.
| Editing | Simulation | |
|---|---|---|
| Data Type | N/A | integer |
| Access | N/A | read |
| Default Value | None | |
| Units | N/A | |
| Constraints | unique for each mobile subnetwork object |
threshold
This attribute affects a subnet’s display characteristics at different zoom levels. If its value is higher than the current resolution of the map, the subnet will be displayed as a miniaturized icon. Typically, this attribute is used to ensure that network diagrams do not become cluttered with icons at higher zoom levels. The current resolution of the map can be determined in the Project Editor via the Set View Properties command. In the top subnet level, this attribute is measured in pixels/degree and in all other subnet levels, it is measured in pixels/unit of the subnet.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | N/A |
| Access | read / write | N/A |
| Default Value | 0.0 | |
| Units | N/A | |
| Constraints | See description |
trajectory
This attribute specifies an object’s movement during a simulation. Valid settings are VECTOR, NONE, or the name of an ASCII trajectory file with a .trj suffix (the suffix is not included in the attribute setting).
If trajectory is set to VECTOR, the object’s bearing, ground speed, and ascent rate attributes determine its motion.
If trajectory is set to NONE, the object will remain stationary unless its position attributes are modified directly via a KP like op_ima_obj_attr_set().
If trajectory is set to a trajectory file name, the application uses a trajectory file to determine the object’s motion. A trajectory file specifies a set of path segments that are used to determine an object’s location at a given time. The file can contain one uniform traversal time for all path segments (fixed-interval trajectories) or an individual traversal time for each segment (variable-interval trajectories).
Note: If a mobile object resides within a mobile subnetwork, and uses a segment-based trajectory, the parent subnetwork’s motion affects the object’s motion only if the trajectory is defined in non-degree coordinates (feet, miles, etc.).
See “Trajectories” on page 14 for further information on creating and using different types of trajectories.
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated/ file name | N/A |
| Access | read / write / promote | N/A |
| Default Value | None | |
| Units | N/A | |
| Constraints | See description |
trajectory_speed_override
This attribute specifies a speed to be used by the mobile site as it follows the specified trajectory.
The speed of a mobile site following a segment-based trajectory is specified in the trajectory definition. This speed can vary for each segment. You can override the speeds specified in the trajectory by setting this attribute. The speed set by this attribute will be used for all segments of the trajectory.
See “Segment-Based Trajectories” on page 14 for further information on creating and using segment-based trajectories.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle double | N/A |
| Access | read / write / promote | N/A |
| Default Value | None | |
| Units | meters/sec | |
| Constraints | None |
unit
This attribute contains the units used by objects within the subnet. The value is one of the OpT_Ima_Obj_Position_Unit_Type values (see Table 68 “Object Position Unit Type Symbolic Constants” on page 19).
Note: To determine the units for a subnet’s span or position, you must get the unit attribute for that subnet’s parent subnet.
| Editing | Simulation | |
|---|---|---|
| Data Type | not applicable | integer |
| Access | not applicable | read |
| Default Value | ||
| Units | ||
| Constraints |
user id
This attribute is an integer which is provided for user-specific identification purposes. Unlike sys id, it does not necessarily have the property of uniqueness, but it is a read/write variable and the user can assign it in any way desired.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read / write / promote | read / write |
| Default Value | 0 | |
| Units | N/A | |
| Constraints | None |
x position
This attribute specifies the x-coordinate of the center of the subnetwork extent, and the x-coordinate of the position at which the subnetwork icon is displayed in the Project Editor. Its value is specified in the units of the parent subnetwork. When the specified unit is degrees, this corresponds to the longitude of the center point. A positive value refers to degrees East longitude and a negative value refers to degrees West longitude.
If a trajectory file is specified, the Simulation Kernel automatically updates the value for this attribute by linearly interpolating between adjacent points in the trajectory file. When using a relative trajectory, the initial x position value serves as an offset that is added to all x coordinates in the trajectory file. With an absolute trajectory, the initial value of x position is irrelevant, because it will be replaced at the start of simulation by the first x coordinate in the trajectory file.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write | read / write |
| Default Value | N/A | |
| Units | See description | |
| Constraints |
y position
This attribute specifies the y-coordinate of the center of the subnetwork extent, and the y-coordinate of the position at which the subnetwork icon is displayed in the Project Editor. Its value is specified in the units of the parent subnetwork. When the specified unit is degrees, this corresponds to the latitude of the center point. A positive value refers to degrees North latitude and a negative value refers to degrees South latitude.
If a trajectory file is specified, the Simulation Kernel automatically updates the value for this attribute by linearly interpolating between adjacent points in the trajectory file. When using a relative trajectory, the initial y position value serves as an offset that is added to all y coordinates in the trajectory file. With an absolute trajectory, the initial value of y position is irrelevant, because it will be replaced at the start of simulation by the first y coordinate in the trajectory file.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write | read / write |
| Default Value | N/A | |
| Units | See description | |
| Constraints |
yaw
This attribute specifies the yaw component of a mobile subnet’s orientation in space. The other orientation components are roll and pitch. If a trajectory file is specified, the Simulation Kernel automatically updates the value for this attribute based on the current trajectory segment setting.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read / write |
| Default Value | 0.0 | |
| Units | degrees | |
| Constraints | None |