External Interfaces
This section contains the information necessary to interact with Riverbed from outside the program, including
- Terrain Modeling Module Preferences
- Terrain Modeling Module Status Messages
- Terrain Modeling Module File Types
- ETS Operations
- EMA Support
For descriptions of the APIs supported by TMM, see Chapter 23 “TMM Package” on page 1 of the Discrete Event Simulation API Reference Manual.
Terrain Modeling Module Preferences
The Terrain Modeling Module adds or modifies preferences in the following programs.
Modeler Preferences
The Terrain Modeling Module adds the following preferences to Modeler. These preferences are also made available to the op_runsim program.
Enable Terrain Modeling Cache
Specifies whether a simulation should use the TMM caching system. The TMM cache keeps the results of path loss calculations so that path loss between two specific points needs to be calculated only once. For more details, see "Reusing Path Loss Calculations" on page 23.
If the positions of points change frequently, the cache can grow quite large and consume available memory. If this becomes a problem, set this attribute to FALSE.
- Tag:
tmm_use_cache - Data Type: boolean
- Default Value: TRUE
Enable Terrain Modeling Module for Simulations
When TRUE, specifies that simulations should use TMM propagation models and terrain data.
- Tag:
tmm_simulate - Data Type: boolean
- Default Value: FALSE
Generate Detailed Status
Specifies whether TMM path loss calculations should provide detailed messages. If this attribute is set to TRUE, detailed messages appear in the simulation log.
- Tag:
tmm_verbose - Data Type: boolean
- Default Value: FALSE
Load Terrain Data Only As Needed
When TRUE, specifies that simulations should load terrain sources only when needed. When FALSE, specifies that terrain sources should be loaded when the terrain specification is selected or examined.
- Tag:
tmm_load_as_needed - Data Type: boolean
- Default Value: TRUE
Location of Terrain Data
Specifies the directory in which terrain data files are located. This value is set automatically by the Specify Terrain Data Directory operation. (This preference is superceded by the Terrain Specification File preference.)
- Tag:
tmm_data_directory - Data Type: string
- Default Value: none
Pathloss Cache Size
Specifies the maximum amount of memory, in megabytes, to be used by the path loss cache. Each cache entry for path loss between two points uses about 70 bytes of memory.
- Tag:
tmm_pathloss_cache_size - Data Type: integer
- Default Value: 2
- Units: megabytes
Profile Sample Count Setting
Controls the number of sample points used in the View Terrain Profile dialog box. When positive, it defines the number of sample values used in the dialog box. When negative, its absolute value represents the approximate distance (in meters) between samples.
- Tag:
tmm_profile_max_sample_count - Data Type: integer
- Default Value: 100
Propagation Specification File
Specifies the name of a .propag.xml file containing propagation information for the current project.
- Tag:
tmm_propagation_specification - Data Type: string
- Default Value: “”
Terrain File Cache Size
Specifies the number of files kept in memory for each multiple-file terrain source (such as DTED and DEM). Keeping more files available can make terrain operations much faster, but consumes a considerable amount of memory. (This preference is not used if the Terrain Specification File preference is set.)
- Tag:
tmm_terrain_cache_size - Data Type: integer
- Default Value: 10
Terrain Data Type
Specifies the type of data file to be read in. This value is set automatically by the Specify Terrain Data Directory operation. (This preference is superceded by the Terrain Specification File preference.)
- Tag:
tmm_data_type - Data Type: enum
- Default Value: USGS DEM
- Constraints: DTED, USGS DEM, OpenFlight, MetaFlight
Notes:
- OpenFlight and MetaFlight require a 3DNV license
- OpenFlight and MetaFlight supported only on 32-bit Windows
Terrain Propagation Zone Ratio
Specifies the minimum percentage of a path that must pass through a zone for that zone’s propagation model to be considered for use in path loss calculations. (See "Creating a Propagation Specification" on page 13 for details.) The default value of 0 means that any zone containing at least one point will be considered.
- Tag:
tmm_propagation_zone_ratio - Data Type: integer
- Default Value: 0
Terrain Propagation Zone Resolution
Specifies the number of points along a path that will be used to evaluate zones. Using more points gives a more accurate selection of zone, but increases the time required for path loss calculations. (See "Creating a Propagation Specification" on page 13 for details on zone selection.)
- Tag:
tmm_propagation_zone_resolution - Data Type: integer
- Default Value: 100
Terrain Specification File
Specifies the name of a .terrain.xml file containing terrain information for the current project.
- Tag:
tmm_terrain_specification - Data Type: string
- Default Value: “”
Terrain Handler Preferences
The following preferences are defined in the supplied terrain handlers.
tmm_data_suffix_prefer
Specifies a preferred suffix for data files when files cover identical areas. This preference applies to DTED terrain.
- Data Type: string
- Default Value: dt0
tmm_dted_elev_integer_format
Specifies how negative numbers are stored in DTED files. This preference applies to DTED terrain.
- Data Type: enum
- Default Value: sign_magnitude
- Constraints: sign_magnitude, ones_complement, twos_complement
tmm_openflight_resolution
Specifies the distance (measured at the equator) between adjacent elevation values in an OpenFlight terrain database. This preference applies to Openflight terrain.
- Data Type: integer
- Default Value: 10
- Units: meters
op_mkso Preferences
TMM modifies the “type” preference in op_mkso as follows.
type
The Terrain Modeling Module adds “tmm” and “terrain” to the supported values of this preference.
- Data Type: string
- Default Value: ets
- Units: none
- Constraints: ets, repos, tmm, da, nvism, antn, terrain
op_runsim Preferences
The Terrain Modeling Module adds the following preferences to the op_runsim program.
tmm_prop_model
Specifies the name of the propagation model to use. (This preference is superceded by the Propagation Specification File preference.)
- Data Type: string
- Default Value: “”
tmm_prop_param
Specifies the name of the propagation model parameter set to use. (This preference is superceded by the Propagation Specification File preference.)
- Data Type: string
- Default Value: “”