Mobile Communications Node Object
Mobile communications nodes are instances of node models. Their internal structure is editable and consists of modules which process, generate, store, receive, and transmit packets or perform other tasks according to a user-provided design. Mobile nodes provide all of the same functionality of fixed communication nodes, and in addition are able to change their position dynamically during simulation. The default representation of a mobile communication node is an octagon with four arrows, as shown in the following figure.
Figure 57: Default Mobile Communications Node Icon

Mobile communications nodes can be connected to fixed communications nodes, other mobile nodes, or satellite nodes via radio links only. Mobile nodes cannot be connected via duplex point-to-point links, simplex point-to-point links, or bus links. For more information on node mobility, refer to “Modeling Node and Subnetwork Movement” on page 13.
Mobile Communications Node Object Attributes
The built-in attributes of the mobile communications node object are listed below, in alphabetical order.
Table 17: Mobile Communications Node Object Built-In Attributes
| Name | Editing Data Type |
|---|---|
| altitude | double |
| altitude modeling | enumerated |
| ascent rate | string |
| bearing | double |
| color | color |
| condition | toggle |
| creation data | string |
| creation source | string |
| creation timestamp | date |
| financial cost | string |
| ground speed | string |
| icon name | string |
| minimized icon | minimized icon |
| model | typed file |
| name | string |
| pitch | double |
| position cache time granularity | double |
| priority | integer |
| roll | double |
| threshold | double |
| trajectory | typed file |
| trajectory_speed_override | toggle double |
| user id | integer |
| x position | double |
| y position | double |
| yaw | double |
altitude
This attribute represents the distance of a mobile communications node from sea-level on the surface of the earth, in meters. The value of this attribute can vary throughout the simulation.
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().
This attribute is critical to determining line-of-sight closure and is typically greater than 0.0.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | 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).
| Editing | Simulation | |
|---|---|---|
| Data Type | enumerated | enumerated |
| Access | read / write / promote | read |
| Default Value | relative to subnet | |
| Units | See description | |
| Constraints | None |
ascent rate
This attribute specifies the vertical speed of the mobile node. It is used only when the node’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 |
bearing
This attribute is used in conjunction with a trajectory setting of Vector to specify the bearing off magnetic north: 0 - North, 90 - East, 180 - South, 270 - West.
| 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 the node trajectory for the purpose of its depiction in the Project Editor. 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 |
condition
This attribute represents the operational status of a node. A value of “enabled” signifies that the node is functioning and that packets can be sent or received or other functions carried out. A value of “disabled” signifies that the node is unable to carry out any functions. The default value for condition is enabled.
If a user is interested in the effects of a node becoming disabled, the condition attribute will typically be modified during simulation using the KP op_ima_obj_attr_set(). Changing the value from enabled to disabled creates failure interrupts at select modules. Changing the value from disabled to enabled creates recovery interrupts at select modules. See “Network Domain” on page 292 for more information about modeling failures and recoveries.
| Editing | Simulation | |
|---|---|---|
| Data Type | toggle | toggle |
| Access | read / write / promote | read / write |
| Default Value | enabled | |
| Units | N/A | |
| Constraints | enabled, disabled |
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 node. It is used only when the node’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 communications node within network diagrams. Icons can be created with the icon editor. The value of this attribute has no impact on simulation behavior.
| Editing | Simulation | |
|---|---|---|
| Data Type | icon | N/A |
| Access | read / write | N/A |
| Default Value | mobile_comm | |
| Units | N/A | |
| Constraints | None |
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/#708090” | |
| Units | ||
| Constraints |
model
This attribute specifies the name of a node model developed either via the Node Editor or the External Model Access interface. The node model represents the internal structure and therefore the capabilities of the communications node and can also cause it to inherit attributes which have been promoted upwards.
| Editing | Simulation | |
|---|---|---|
| Data Type | typed file | string |
| Access | read / write | read |
| Default Value | ex_node | |
| Units | N/A | |
| Constraints | None |
name
This attribute specifies a string which is used for identification purposes. It is useful for identifying a node in a model report. It is also used during simulation to obtain the node’s object ID, via the KP op_id_from_name(). The object ID is in turn useful for obtaining attribute values and can also be used for performing routing or disabling/enabling nodes in a dynamic manner. The Simulation Kernel does not use this attribute.
| Editing | Simulation | |
|---|---|---|
| Data Type | string | string |
| Access | read / write | read |
| Default Value | mobile_node_n, n >= 0 |
|
| Units | N/A | |
| Constraints | unique name, no dots, not “top” |
pitch
This attribute specifies the pitch component of a mobile node’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 node is assumed to be unchanged and will not be recalculated. (See “Reducing the Number of Position Calculations” on page 13 for more details.) 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 in turn is weighted higher than module priority.
This attribute is not used by the parallel simulation kernel.
| Editing | Simulation | |
|---|---|---|
| Data Type | integer | integer |
| Access | read / write / promote | read / write |
| Default Value | 0 | |
| Units | N/A | |
| Constraints | absolute value (priority) <= 32,000 |
roll
This attribute specifies the roll component of a mobile node’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 |
threshold
This attribute affects a node’s display characteristics at different zoom levels. If its value is higher than the current resolution of the map, the node 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 from the dialog box that appears in response to 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, then 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 such as 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 | None |
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 |
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 one of the three components of the position of the communications node. The three components are x position, y position, and altitude. x position corresponds to longitude in the top subnet or in any subnet utilizing units of degrees. In subnets using units other than degrees, it represents the distance separating the node from the left edge of the subnet extent.
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 | None |
y position
This attribute specifies one of the three components of the position of the communications node. The three components are x position, y position, and altitude. y position corresponds to longitude in the top subnet or in any subnet utilizing units of degrees. In subnets using units other than degrees, it represents the distance the node is down from the top edge of the subnet extent.
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 | None |
yaw
This attribute specifies the yaw component of a mobile node’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 |