OpenTAP 9.25
API Reference
Classes | Public Member Functions | Properties | List of all members
OpenTap.RfConnection Class Reference

A Connection that has an RF cable loss parameter. More...

Inheritance diagram for OpenTap.RfConnection:
OpenTap.Connection OpenTap.ValidatingObject OpenTap.ITapPlugin OpenTap.IValidatingObject OpenTap.DirectionalRfConnection

Classes

class  CableLossPoint
 Represents a point in a frequency/loss table. More...
 

Public Member Functions

 RfConnection ()
 Initializes a new instance of the RfConnection class.
 
double GetInterpolatedCableLoss (double frequency)
 Given a particular frequency, an interpolated CableLoss value is returned, based on CableLoss values at the two closest frequencies. If exact frequency is defined, that CableLoss value will be returned. More...
 
- Public Member Functions inherited from OpenTap.Connection
 Connection ()
 Initializes a new instance of the Connection class.
 
Port GetOtherPort (Port p)
 Returns the other port when given either Port1 or Port2.
 
override string ToString ()
 Returns a string representation of this connection which names the ports in each end.
 
- Public Member Functions inherited from OpenTap.ValidatingObject
void OnPropertyChanged (string propertyName)
 Triggers the PropertyChanged event. More...
 

Properties

List< CableLossPointCableLoss [getset]
 The cable loss in dB between the two ports.
 
- Properties inherited from OpenTap.Connection
string Name [getset]
 A name for the connection to be displayed in the user interface.
 
Port Port1 [getset]
 The port at the first end of the connection.
 
Port Port2 [getset]
 The port at the second end of the connection.
 
List< ViaPointVia [getset]
 Gets the list of ViaPoints that this connection goes through.
 
bool IsActive [get]
 Returns true when a connection going through one or more switches (set using the Via property) is "Active" (all switches are in the correct position).
 
- Properties inherited from OpenTap.ValidatingObject
ValidationRuleCollection Rules [get]
 All the validation rules. Add new rules to this in order to get runtime value validation.
 
string Error [get]
 Gets the error messages for each invalid rule and joins them with a newline.
 
- Properties inherited from OpenTap.IValidatingObject
ValidationRuleCollection Rules [get]
 A collection of all the currently defined validation rules. Add new rules here in order to get runtime value validation.
 

Additional Inherited Members

- Protected Member Functions inherited from OpenTap.ValidatingObject
virtual string GetError (string propertyName=null)
 Return the error for a given property
 
void ThrowOnValidationError (bool ignoreDisabledProperties)
 Checks all validation rules on this object (Rules) and throws an AggregateException on errors. More...
 
- Events inherited from OpenTap.ValidatingObject
PropertyChangedEventHandler PropertyChanged
 Standard PropertyChanged event object.
 

Detailed Description

A Connection that has an RF cable loss parameter.

Member Function Documentation

◆ GetInterpolatedCableLoss()

double OpenTap.RfConnection.GetInterpolatedCableLoss ( double  frequency)
inline

Given a particular frequency, an interpolated CableLoss value is returned, based on CableLoss values at the two closest frequencies. If exact frequency is defined, that CableLoss value will be returned.

Parameters
frequency
Returns

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:24