Antenna Object

Antenna properties associated with radio transmitters and receivers are specified as attributes of an antenna object. This provides a convenient way to assign identical antenna properties to groups of receivers and transmitters within a node.

Antennas are only used for modeling radio transmission, and affect the simulation only through their association with radio transmitters and receivers. Packet streams are used to couple antennas to receivers and transmitters. A packet stream can lead from a radio transmitter to an antenna, or from an antenna to a radio receiver. No other connections to or from antennas are permitted.

In the Node Editor, antennas are by default represented as square boxes with an image of a parabolic dish inside. The antenna’s name is displayed beneath it as shown in the figure below:

Figure 62: Antenna Representation

Antenna Representation

The primary purpose of the antenna object is to allow modeling of directional gain at radio receivers and transmitters. Each antenna is assigned a gain pattern that specifies the gain relative to isotropic radiated power as a function of horizontal and vertical plane deflection angles, polar and azimuth. Thus antenna gain patterns are three-dimensional models generated as a function of two variables.

Antenna Object Attributes

The built-in attributes of the antenna object are listed in the following table.

Table 22: Antenna Object Built-In Attributes

Name Data Type
name string
pattern typed file
boresight azimuth toggle double
boresight polar toggle double
antenna location compound
target location coordinate type enum
target location: global coordinates compound
target location: body coordinates compound
secondary target location coordinate type enum
secondary target location: global coordinates compound
secondary target location: body coordinates compound
icon name icon

antenna location

This compound attribute specifies placement of the antenna relative to the node containing it. The location is given by x, y, and z offsets (in meters) from the node’s position (for details, see the description of body coordinates in “Antenna Coordinate Systems” on page 60).

Editing Simulation
Data Type compound compound
Access read / write read / write

x (m)

This sub-attribute specifies the location of the antenna on the x axis of the containing node. Positive values represent locations toward the front of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units meters
Constraints none

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “antenna x” (not as a sub-attribute of “antenna location”).

y (m)

This sub-attribute specifies the location of the antenna on the y axis of the containing node. Positive values represent locations toward the left of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units meters
Constraints none

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “antenna y” (not as a sub-attribute of “antenna location”).

z (m)

This sub-attribute specifies the location of the antenna on the z axis of the containing node. Positive values represent locations toward the top of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 1.5
Units meters
Constraints none

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “antenna z” (not as a sub-attribute of “antenna location”).

boresight azimuth

This attribute specifies the azimuth component of the reference direction used for pointing the antenna. Typically, the boresight direction is inherited from the antenna pattern; use this attribute to specify a reference direction for older antenna patterns that do not contain boresight information.

Editing Simulation
Data Type toggle double double
Access read / write / promote read / write
Default Value inherit from pattern (disabled)
Units degrees
Constraints 0.0 <= boresight azimuth < 360.0

boresight polar

This attribute specifies the polar component of the reference direction used for pointing the antenna. Typically, the boresight direction is inherited from the antenna pattern; use this attribute to specify a reference direction for older antenna patterns that do not contain boresight information.

Editing Simulation
Data Type toggle double double
Access read / write / promote read / write
Default Value inherit from pattern (disabled)
Units degrees
Constraints 0.0 <= boresight polar <= 180.0

icon name

This attribute specifies the name of the icon used to represent the antenna module in the Node Editor display and in node model printouts. 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 antenna
Units
Constraints

name

This attribute is a user-assigned identification for the antenna module. The value assigned to this attribute appears beneath the module’s icon in the node diagram. It can also be used to refer to the object during simulation. Refer to the documentation on the KP op_id_from_name() for more information.

Editing Simulation
Data Type string string
Access read / write read
Default Value a_n, n >= 0
Units N/A
Constraints unique in node model; no dots

pattern

This attribute specifies the name of the antenna pattern gain table used to map three-dimensional direction of transmission to antenna gain. Antenna pattern gain tables can be constructed in the Antenna Pattern Editor or via the External Model Access (EMA) package. The antenna pattern gain table is typically used by the Radio Transceiver Pipeline antenna gain stages “tagain model” and “ragain model”.

Editing Simulation
Data Type typed file string
Access read / write / promote read / write
Default Value isotropic
Units
Constraints

secondary target location: body coordinates

This compound attribute specifies the aiming point of the antenna’s secondary reference point, expressed in body coordinates (as described in “Antenna Coordinate Systems” on page 60). The aiming point is given by x, y, and z coordinates relative to the node containing the antenna. This attribute is used to determine the secondary target location when the secondary target location coordinate type attribute is set to “body”.

During simulation, this attribute can be used to keep the antenna’s secondary reference pointed in a particular direction relative to the containing node.

Editing Simulation
Data Type compound compound
Access read / write / promote read / write

x (m)

This sub-attribute specifies the target location on the x axis of the antenna’s containing node. Positive values represent locations toward the front of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 2.0
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “secondary target x” (not as a sub-attribute of “secondary target location: body coordinates”).

y (m)

This sub-attribute specifies the target location on the y axis of the antenna’s containing node. Positive values represent locations toward the left of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 2.0
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “secondary target y” (not as a sub-attribute of “secondary target location: body coordinates”).

z (m)

This sub-attribute specifies the target location on the z axis of the antenna’s containing node. Positive values represent locations toward the top of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 1.5
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “secondary target z” (not as a sub-attribute of “secondary target location: body coordinates”).

secondary target location: global coordinates

This compound attribute specifies the aiming point of the antenna’s secondary reference point, expressed in global coordinates (as described in “Antenna Coordinate Systems” on page 60). The aiming point is given by latitude, longitude, and altitude. This attribute is used to determine the secondary target location when the secondary target location coordinate type attribute is set to “global”.

During simulation, this attribute can be used to keep the secondary reference point pointed at a particular location (such as a fixed node).

Editing Simulation
Data Type compound compound
Access read / write / promote read / write

latitude (deg)

This sub-attribute specifies the latitude component of the secondary target location.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units degrees
Constraints -90.0 <= latitude <= 90.0

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “secondary target latitude” (not as a sub-attribute of “secondary target location: global coordinates”).

longitude (deg)

This sub-attribute specifies the longitude component of the secondary target location.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units degrees
Constraints -180.0 <= longitude <= 180.0 (-180 is equivalent to 180)

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “secondary target longitude” (not as a sub-attribute of “secondary target location: global coordinates”).

altitude (m)

This sub-attribute specifies the altitude component of the secondary target location. Altitude is measured from the earth’s surface.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “secondary target altitude” (not as a sub-attribute of “secondary target location: global coordinates”).

secondary target location coordinate type

This attribute specifies the type of coordinates used for the secondary reference aiming point of the antenna. Depending on the value of this attribute, the target location will be specified by either the secondary target location: global coordinates or secondary target location: body coordinates attribute.

Editing Simulation
Data Type enum enum
Access read / write / promote read
Default Value global
Units
Constraints global, body

target location: body coordinates

This compound attribute specifies the aiming point of the antenna boresight, expressed in body coordinates (as described in “Antenna Coordinate Systems” on page 60). The aiming point is given by x, y, and z coordinates relative to the node containing the antenna. This attribute is used to determine the target location when the target location coordinate type attribute is set to “body”.

During simulation, this attribute can be used to keep the antenna boresight pointed in a particular direction relative to the containing node.

Editing Simulation
Data Type compound compound
Access read / write / promote read / write

x (m)

This sub-attribute specifies the target location on the x axis of the antenna’s containing node. Positive values represent locations toward the front of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 4.0
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “target x” (not as a sub-attribute of “target location: body coordinates”).

y (m)

This sub-attribute specifies the target location on the y axis of the antenna’s containing node. Positive values represent locations toward the left of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “target y” (not as a sub-attribute of “target location: body coordinates”).

z (m)

This sub-attribute specifies the target location on the z axis of the antenna’s containing node. Positive values represent locations toward the top of the node.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 1.5
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “target z” (not as a sub-attribute of “target location: body coordinates”).

target location: global coordinates

This compound attribute specifies the aiming point of the antenna boresight, expressed in global coordinates (as described in “Antenna Coordinate Systems” on page 60). The aiming point is given by latitude, longitude, and altitude. This attribute is used to determine the target location when the target location coordinate type attribute is set to “global”.

During simulation, this attribute can be used to keep the antenna boresight pointed at a particular location (such as a fixed node).

Editing Simulation
Data Type compound double
Access read / write / promote read / write

latitude (deg)

This sub-attribute specifies the latitude component of the target location.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units degrees
Constraints -90.0 <= latitude <= 90.0

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “target latitude” (not as a sub-attribute of “target location: global coordinates”).

longitude (deg)

This sub-attribute specifies the longitude component of the target location.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units degrees
Constraints -180.0 <= longitude <= 180.0 (-180 is equivalent to 180)

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “target longitude” (not as a sub-attribute of “target location: global coordinates”).

altitude (m)

This sub-attribute specifies the altitude component of the target location. Altitude is measured from the earth’s surface.

Editing Simulation¹
Data Type double double
Access read / write / promote read / write
Default Value 0.0
Units meters
Constraints

¹ To access this sub-attribute from simulation code, treat it as a top-level attribute named “target altitude” (not as a sub-attribute of “target location: global coordinates”).

target location coordinate type

This attribute specifies the type of coordinates used for the boresight aiming point of the antenna. Depending on the value of this attribute, the target location will be specified by either the target location: global coordinates or target location: body coordinates attribute.

Editing Simulation
Data Type enum enum
Access read / write / promote read
Default Value global
Units
Constraints global, body

Antenna Object Statistics

The antenna module does not generate any statistics.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com