Transmitter-receiver unit with individual characteristics, coverage area and coverage result. More...

Inheritance diagram for TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver:

Public Member Functions
void	AddAntennaEffects (CoverageMatrix pAcc, bool bAttached)
	Add antenna effects to a specific coverage matrix, based on antenna characteristics and effective azimuth and elevation values for the matrix' elements. Internal ues only.

void	SetBoost (bool bBoost, double rxGain)
	Boost coverage with supplied receiver gain.

void	SetCoverageArea (GeoRect r)
	Set coverage area as a GeoRect.

void	SetCoverageArea (GeoPos pos, double radius)
	Move unit to a position, and set its assigned coverage area to be neighborhood with given radius around that position.

void	SetCoverageArea (GeoPos[] route)
	Set coverage area to trace a route.

void	SetCoverageArea (GeoPos3D[] airroute)
	Set coverage area to trace a route with elevation.

bool	GetValue (GeoPos gp, ref double value)
	Get coverage value (meaning depends on model) at given position.

bool	Calculate ()
	Caculate or recalculate coverage according currently assigned properties.

void	Cancel ()
	Cancels an ongoing coverage calculation.

void	ToStream (Stream ost)
	Save unit along with parameters and coverage data to stream.

bool	FromStream (Stream ist)
	Load unit parameters and coverage data from stream.

Properties
Guid	Id `[get]`
	Get unique id.

bool	IsRangeToolEnabled `[get, set]`
	Enable or disable range tool.

bool	IsAreaSizeToolEnabled `[get, set]`
	Enable or disable area size tool.

bool	IsMoveToolEnabled `[get, set]`
	Enable or disable range tool.

bool	AutoRecalcCoverage `[get, set]`
	Gets or sets if recalculation of coverage should be attempted automatically when position or coverage area are changed by tools. Default is true.

IRadioPropagationLayer	Layer `[get, set]`
	Get or set the RadioPropagationLayer owning the unit.

CoverageData	Coverage `[get]`
	Get the coverage data, if available.

bool	Visible `[get, set]`
	Get or set if the coverage of this unit contributes to the combined coverage of the layer.

new double	TxPower `[get, set]`
	Tx power in Watts.

new double	UavTxPower `[get, set]`
	Tx power in Watts for a remote Uav transmitter.

new IAntenna	Antenna `[get, set]`
	Antenna with specific gain distribution.

new double	TxGain `[get, set]`
	Tx antenna gain in dBm. Ignored if Antenna is present.

new double	UavTxGain `[get, set]`
	Tx antenna gain in dBm for a remote Uav transmitter.

new double	RxGain `[get, set]`
	Set antenna receiver gain.

new double	RxHeight `[get, set]`
	Set or get receiver antenna height, in meters AGL.

new double	MinSignal `[get, set]`
	Set or get the minimum signal strength in dBm for successful connectivity receptions.

new double	SNRatio `[get, set]`
	Set or get the max acceptable signal to noice ratio for successful connectivity receptions.

new NetworkUnitRole	Role `[get, set]`
	Set or get the unit role as member of a connectivity network.

new double	TxHeight `[get, set]`
	Set or get the transmitter antenna height, in meters AGL.

new GeoPos	Position `[get, set]`
	Set or get the unit position.

CoverageArea	CoverageArea `[get]`
	Get the currently assigned coverage area.

new double	Frequency `[get, set]`
	Carrier frequency in MHz, preferably within the VHF-UHF ranges.

new int	Polarization `[get]`
	Get active wave polarization.

new RadioPropagationModelInfo	Model `[get]`
	Get active propagation model.

new double	Refraction `[get]`
	Get active refraction value.

new int	NumberOfKnifeEdges `[get]`
	Get number of diffraction knife edges in currently assigned model

bool	Working `[get]`
	Get if unit is currently performing a coverage calculation.

Properties inherited from TPG.GeoFramework.RadioPropagation.Data.INetworkUnit
GeoPos	Position `[get]`
	Position of transmitter-receiver unit.

NetworkUnitRole	Role `[get]`
	Unit role within a layer set.

RadioPropagationModelInfo	Model `[get]`
	Microwave propagation model.

double	Refraction `[get]`
	Refraction coefficient used for wave propagation calculations.

int	NumberOfKnifeEdges `[get]`
	Max number of diffraction edges. Used with the VHF/UHF model.

int	Polarization `[get]`
	Wave polarization. Used with the VHF/UHF model.

double	Frequency `[get]`
	Carrier wave frequency in MHz.

double	RxHeight `[get]`
	Rx antenna height in meters AGL.

double	TxHeight `[get]`
	Tx antenna height in maters AGL.

double	TxPower `[get]`
	Tx power in Watts.

IAntenna	Antenna `[get]`
	Antenna with specific gain distribution.

double	TxGain `[get]`
	Nominal Tx antenna gain in dBm. Ignored if Antenna is present.

double	RxGain `[get]`
	Nominal Rx antenna gain in dBm.

double	MinSignal `[get]`
	Minimum acceptable signal strength in dBm.

double	SNRatio `[get]`
	Max acceptable signal-to-noice ratio in dB.

Events
EventHandler	CalculationStarted
	Coverage calculation started event.

EventHandler	CalculationComplete
	Coverage calculation complete event.

EventHandler	CalculationCancelled
	Coverage calculation cancelled event.

Detailed Description

Transmitter-receiver unit with individual characteristics, coverage area and coverage result.

Member Function Documentation

◆ AddAntennaEffects()

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.AddAntennaEffects	(	CoverageMatrix	pAcc,
		bool	bAttached
	)

Add antenna effects to a specific coverage matrix, based on antenna characteristics and effective azimuth and elevation values for the matrix' elements. Internal ues only.

Parameters

pAcc	Coverage matrix
bAttached	true if pAcc is attched to global coverage. False if newly calculated or if global coverage is locked

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Calculate()

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Calculate ( )

Caculate or recalculate coverage according currently assigned properties.

Returns: True if calculation initiated successfully

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Cancel()

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Cancel ( )

Cancels an ongoing coverage calculation.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ FromStream()

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.FromStream ( Stream ist )

Load unit parameters and coverage data from stream.

Parameters

ist

Returns

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ GetValue()

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.GetValue	(	GeoPos	gp,
		ref double	value
	)

Get coverage value (meaning depends on model) at given position.

Parameters

gp	position
value	coverage value

Returns: True if value is available at given point

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ SetBoost()

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.SetBoost	(	bool	bBoost,
		double	rxGain
	)

Boost coverage with supplied receiver gain.

Internal use

Parameters

bBoost
rxGain

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ SetCoverageArea() [1/4]

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.SetCoverageArea	(	GeoPos	pos,
		double	radius
	)

Move unit to a position, and set its assigned coverage area to be neighborhood with given radius around that position.

If the position is the current one, the effect is to adjust the radius of the assigned coverage area

Parameters

pos	unit position
radius	radius of assigned coverage area in meters

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ SetCoverageArea() [2/4]

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.SetCoverageArea ( GeoPos3D[] airroute )

Set coverage area to trace a route with elevation.

Parameters

route Array of waypoints

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ SetCoverageArea() [3/4]

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.SetCoverageArea ( GeoPos[] route )

Set coverage area to trace a route.

Parameters

route Array of waypoints

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ SetCoverageArea() [4/4]

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.SetCoverageArea ( GeoRect r )

Set coverage area as a GeoRect.

This kind of area is not required to contain the unit position, and will not move along with the unit position

<remark>The same area may be assigned to several units for coverage comparisions</remark>

Parameters

r

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ ToStream()

void TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.ToStream ( Stream ost )

Save unit along with parameters and coverage data to stream.

Parameters

ost

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

Property Documentation

◆ Antenna

new IAntenna TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Antenna

getset

Antenna with specific gain distribution.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ AutoRecalcCoverage

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.AutoRecalcCoverage

getset

Gets or sets if recalculation of coverage should be attempted automatically when position or coverage area are changed by tools. Default is true.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Coverage

CoverageData TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Coverage

get

Get the coverage data, if available.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ CoverageArea

CoverageArea TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.CoverageArea

get

Get the currently assigned coverage area.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Frequency

new double TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Frequency

getset

Carrier frequency in MHz, preferably within the VHF-UHF ranges.

NB! The 'get' method returns the layer frequency unless the individual unit frequency is explicitly set to a positive value. The layer frequency is the one used for coverage calculations for all units within the layer.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Id

Guid TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Id

get

Get unique id.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ IsAreaSizeToolEnabled

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.IsAreaSizeToolEnabled

getset

Enable or disable area size tool.

Only applies to GeoRect coverage area type.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ IsMoveToolEnabled

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.IsMoveToolEnabled

getset

Enable or disable range tool.

Only applies to circle coverage area type.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ IsRangeToolEnabled

bool TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.IsRangeToolEnabled

getset

Enable or disable range tool.

Only applies to circle coverage area type.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Layer

IRadioPropagationLayer TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Layer

getset

Get or set the RadioPropagationLayer owning the unit.

The set method is for internal use

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ MinSignal

new double TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.MinSignal

getset

Set or get the minimum signal strength in dBm for successful connectivity receptions.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Model

new RadioPropagationModelInfo TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Model

get

Get active propagation model.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ NumberOfKnifeEdges

new int TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.NumberOfKnifeEdges

get

Get number of diffraction knife edges in currently assigned model

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Polarization

new int TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Polarization

get

Get active wave polarization.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Position

new GeoPos TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Position

getset

Set or get the unit position.

If the assigned coverage area is a neighborhood of given radius around the unit position, that area will move along with position change.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Refraction

new double TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Refraction

get

Get active refraction value.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ Role

new NetworkUnitRole TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.Role

getset

Set or get the unit role as member of a connectivity network.

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ RxGain

new double TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.RxGain

getset

Set antenna receiver gain.

For coverage, for comparision between units, a value common throughout the RadioPropagation layer will be employed rather than the indiviual gain

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.

◆ RxHeight

new double TPG.GeoFramework.RadioPropagation.Provider.Contracts.ITransmitterReceiver.RxHeight

getset

Set or get receiver antenna height, in meters AGL.

For coverage, for comparision between units, a value common throughout the RadioPropagation layer will be employed rather than the indiviual rx antenna height

Implements TPG.GeoFramework.RadioPropagation.Data.INetworkUnit.

Implemented in TPG.GeoFramework.RadioPropagation.Provider.TransmitterReceiver.