OpenTAP 9.27
API Reference
Public Types | Public Member Functions | Properties | List of all members
OpenTap.DirectionalRfConnection Class Reference

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

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

Public Types

enum  PortDirectionEnum { FROM_1_TO_2 , FROM_2_TO_1 }
 Specifies the direction of a connection. More...
 

Public Member Functions

 DirectionalRfConnection ()
 Initializes a new instance of the DirectionalRfConnection class.
 
- Public Member Functions inherited from OpenTap.RfConnection
 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.
 
- 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

PortDirectionEnum PortDirection [getset]
 Direction of RF connection.
 
- Properties inherited from OpenTap.RfConnection
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 directional Connection that has an RF cable loss parameter.

Member Enumeration Documentation

◆ PortDirectionEnum

Specifies the direction of a connection.

Enumerator
FROM_1_TO_2 

Directional RF connection from Port1 to Port2.

FROM_2_TO_1 

Directional RF connection from Port2 to Port1.

OpenTAP 9.27 API built Wed Nov 27 2024 13:14:45