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

Base class representing a point through which a connection passes. There is a list of these in Connection.Via. These usually represent a state that a connection switch element/instrument can be in. Implementations include SwitchPosition and SwitchMatrixPath More...

Inheritance diagram for OpenTap.ViaPoint:
OpenTap.IConstResourceProperty OpenTap.SwitchMatrixPath OpenTap.SwitchPosition

Public Member Functions

override string ToString ()
 Returns a string describing this switch position (string.Format("{0}.{1}", this.Device.Name, this.Name)).
 
override int GetHashCode ()
 Serves as the default hash function.
 
override bool Equals (object obj)
 Determines whether the specified object is equal to the current object.
 
bool Equals (ViaPoint other)
 Determines whether the specified object is equal to the current object.
 

Properties

virtual string Name [getprotected set]
 The name of this state/mode/position in the switch. (Should be unique among ViaPoint objects on the same device/resource).
 
virtual bool IsActive [getset]
 Indicates whether the switch is currently in this position. Should be set by the Device implementation.
 
IResource Device [getset]
 The device (usually an Instrument) on which this switch position exists.
 
- Properties inherited from OpenTap.IConstResourceProperty
IResource Device [get]
 TDevice/resource to which this object belongs.
More...
 
string Name [get]
 Name of this object (should be unique among objects of the same type on the same device/resource).

 

Detailed Description

Base class representing a point through which a connection passes. There is a list of these in Connection.Via. These usually represent a state that a connection switch element/instrument can be in. Implementations include SwitchPosition and SwitchMatrixPath

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