Satellite Communications Node Object
Satellite 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. They provide all of the capabilities of fixed communication nodes, but in addition are mobile and can follow a prescribed orbit file. For more information, refer to “Satellite Nodes” on page 8.
The default representation of a satellite communications node is a hexagon with a satellite, as shown in the following figure.
Figure 58: Default Satellite Communications Node Icon

Satellite communications nodes can be connected to other nodes via radio links only. Satellite nodes cannot be connected via duplex point-to-point links, simplex point-to-point links, or bus links. Satellite nodes are usually assigned an orbit file created using the Satellite Tool Kit from Analytical Graphics, and then imported into Riverbed Modeler. See “Orbits” on page 25 for more information about creating and importing orbit files.
Satellite Communications Node Object Attributes
The built-in attributes of the satellite communications node object are listed below, in alphabetical order.
Table 18: Satellite Communications Node Object Built-In Attributes
| Name | Editing Data Type |
|---|---|
| altitude | double |
| color | color |
| condition | toggle |
| creation data | string |
| creation source | string |
| creation timestamp | date |
| financial cost | string |
| icon name | string |
| minimized icon | minimized icon |
| model | typed file |
| name | string |
| orbit | typed file |
| phase | double |
| position cache time granularity | double |
| priority | integer |
| sys id | integer |
| threshold | double |
| user id | integer |
| x position | double |
| y position | double |
altitude
This attribute represents the distance of a satellite communications node from the surface of the earth, in meters. Because the node is mobile, the value of this attribute can vary throughout the simulation. Each time the satellite node needs to update its position, the altitude will be recomputed based on a linear interpolation between the altitudes of the points specified in the node’s associated orbit file. This attribute is critical to determining line-of-sight closure for radio communications.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read |
| Default Value | 0.0 | |
| Units | meters | |
| Constraints | None |
color
This attribute specifies the color of a node’s orbit 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, etc.
| Editing | Simulation | |
|---|---|---|
| Data Type | color | N/A |
| Access | read / write | N/A |
| Default Value | RGB331 | |
| 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.
| 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 |
icon name
This attribute allows the user to modify the bitmap used to represent the communications node in 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 | satellite_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 of modules within the node 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 | sat_node_n, n >= 0 |
|
| Units | N/A | |
| Constraints | unique name, no dots, not “top” |
orbit
This attribute is a text string which corresponds to the name of a binary-formatted orbit file with a .orb suffix (suffix is not included in attribute value). The orbit file holds data specifying the times and locations that the satellite node will pass through as the simulation progresses. An orbit specifies samples of the actual path taken by a satellite node over time. The position of the node is determined at any time during simulation by linearly interpolating between adjacent samples. For additional information on the creation and use of satellite orbits, refer to “Orbits” on page 25.
| Editing | Simulation | |
|---|---|---|
| Data Type | typed file | string |
| Access | read / write / promote | read |
| Default Value | None | |
| Units | N/A | |
| Constraints | None |
phase
This attribute specifies an orbit shift forward or backward in time. The position of the satellite at any time t during a simulation is the position for time (t - phase), as given by the orbit file. For example, with a phase of 100.0 seconds and a simulation time of 300.0, the satellite’s position will be that given 200.0 seconds from the start of the orbit file. In this case, the satellite’s position is held constant at the initial position in the orbit file for the first 100.0 seconds of the simulation. If a negative phase is used, such as -100.0 seconds, the satellite’s position at simulation time 0.0 seconds will be that given 100.0 seconds from the start of the orbit file. Thus, a negative phase shifts an orbit forward in time.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write / promote | read |
| Default Value | 0.0 | |
| Units | sec | |
| Constraints | None |
position cache time granularity
This attribute specifies a time window within which the position of the satellite node 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 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 <= 32,000 |
sys id
This attribute contains a positive read-only integer which is provided for identification purposes. The system assigns a unique number to each satellite communications node object. This number typically corresponds to the order in which the objects are defined: the first satellite node created has sys id 0, the second has sys id 1, and in general the nth node has sys id n-1. It can be used, for instance, in identifying a satellite node within a route or when looping through links 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 satellite communications node object |
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 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 |
user id
This attribute is an integer which is provided for user-specific identification purposes. Unlike the sys id attribute, 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 is 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 utilizing units other than degrees, it represents the distance the node is to the right of the left edge of the subnet extent.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write | read |
| Default Value | N/A | |
| Units | N/A | |
| Constraints | None |
y position
This attribute is 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 utilizing units other than degrees, it represents the distance the node is from the top edge of the subnet extent.
| Editing | Simulation | |
|---|---|---|
| Data Type | double | double |
| Access | read / write | read |
| Default Value | N/A | |
| Units | See description | |
| Constraints | None |