Maria GDK 4.5.0.133
Documentation of managed code in release branch
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider Interface Reference

Provides methods for computation of microwave (VHF/UHF bands) propagation in terrain - and related stuff. More...

Inheritance diagram for TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider:
TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider

Public Member Functions

RadioPropagationModelInfo GetModelByName (string modelName)
 Finds a computation method from lookup by name in the Models dictionary.
 
bool AddLayer (IRadioPropagationLayer layer)
 Handles addition of a new RadioPropagationLayer.
 
void RemoveLayer (IRadioPropagationLayer layer)
 Handles removal of an existing RadioPropagationLayer.
 
bool StoreLayer (string path, IRadioPropagationLayer layer)
 Store a RadioPropagationLayer to a named file.
 
IRadioPropagationLayer LoadLayer (string path)
 Creates a RadioPropagationLayer from file.
 
bool ExportCoverageChartToGeoTIFF (string path, IRadioPropagationLayer layer)
 Export a layer's coverage chart to a named file using the GeoTIFF format.
 
void RegisterAntennaType (string antennaType, IAntennaGainDistribution gainDistribution)
 Register or redefine an antenna type along with nominal gain distribution model.
 
IAntennaGainDistribution GetGainDistribution (string antennaType)
 Gets nominal gain distribution model associated with a specific antenna type.
 
IEnumerable< string > GetRegisteredAntennaTypes ()
 Gets set of registered antenna types.
 

Properties

IPropagationToolManager ToolManager [get]
 Get tool manager.
 
IRadioPropagationNativeBridge NativeBridge [get]
 Access to native (C++) methods.
 
ObservableCollection< IRadioPropagationLayer > Layers [get]
 Ordered sets of transmitter-receiver units.
 
Dictionary< string, RadioPropagationModelInfo > Models [get]
 Collection of methods for computation of microwave propagation in terrain - among other things.
 
uint Version [get]
 Gets code version for data file compatibility checks.
 

Detailed Description

Provides methods for computation of microwave (VHF/UHF bands) propagation in terrain - and related stuff.

Member Function Documentation

◆ AddLayer()

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.AddLayer ( IRadioPropagationLayer  layer)

Handles addition of a new RadioPropagationLayer.

Parameters
layer
Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ ExportCoverageChartToGeoTIFF()

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.ExportCoverageChartToGeoTIFF ( string  path,
IRadioPropagationLayer  layer 
)

Export a layer's coverage chart to a named file using the GeoTIFF format.

Parameters
path
layer
Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ GetGainDistribution()

IAntennaGainDistribution TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.GetGainDistribution ( string  antennaType)

Gets nominal gain distribution model associated with a specific antenna type.

Parameters
antennaType
Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ GetModelByName()

RadioPropagationModelInfo TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.GetModelByName ( string  modelName)

Finds a computation method from lookup by name in the Models dictionary.

Parameters
modelName
Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ GetRegisteredAntennaTypes()

IEnumerable< string > TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.GetRegisteredAntennaTypes ( )

Gets set of registered antenna types.

Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ LoadLayer()

IRadioPropagationLayer TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.LoadLayer ( string  path)

Creates a RadioPropagationLayer from file.

Parameters
path
Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ RegisterAntennaType()

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.RegisterAntennaType ( string  antennaType,
IAntennaGainDistribution  gainDistribution 
)

Register or redefine an antenna type along with nominal gain distribution model.

Parameters
antennaType
gainDistribution

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ RemoveLayer()

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.RemoveLayer ( IRadioPropagationLayer  layer)

Handles removal of an existing RadioPropagationLayer.

Parameters
layer

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ StoreLayer()

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.StoreLayer ( string  path,
IRadioPropagationLayer  layer 
)

Store a RadioPropagationLayer to a named file.

Parameters
path
layer
Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

Property Documentation

◆ Layers

ObservableCollection<IRadioPropagationLayer> TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.Layers
get

Ordered sets of transmitter-receiver units.

Use the AddLayer()/RemoveLayer() methods to add/remove layers. Do not add/remove from this collection directly

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ Models

Dictionary<string, RadioPropagationModelInfo> TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.Models
get

Collection of methods for computation of microwave propagation in terrain - among other things.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ NativeBridge

IRadioPropagationNativeBridge TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.NativeBridge
get

Access to native (C++) methods.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ ToolManager

IPropagationToolManager TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.ToolManager
get

Get tool manager.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

◆ Version

uint TPG.GeoFramework.RadioPropagation.Provider.Contracts.IRadioPropagationProvider.Version
get

Gets code version for data file compatibility checks.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.RadioPropagationProvider.

The documentation for this interface was generated from the following file: