OpenTAP 9.24
API Reference
Public Member Functions | Static Public Member Functions | Properties | List of all members
OpenTap.Input< T > Class Template Reference


A generic type that specifies input properties for a TestStep. The user can link this property to properties on other TestSteps that are marked with the OutputAttribute When used in a TestStep, Input value should always be set in the constructor. More...

Inheritance diagram for OpenTap.Input< T >:
OpenTap.IInput OpenTap.IInputTypeRestriction OpenTap.IInput

Public Member Functions

override string ToString ()
 Converts the value of this instance to its equivalent string representation. More...
 
override bool Equals (object obj)
 Compares one Input to another. More...
 
override int GetHashCode ()
 Gets the hash code. More...
 
virtual bool SupportsType (ITypeData concreteType)
 Returns true if this input supports the concrete type. More...
 

Static Public Member Functions

static bool operator== (Input< T > a, Input< T > b)
 Compares two Input for equality. More...
 
static bool operator!= (Input< T > a, Input< T > b)
 Compares two Input for inequality. More...
 

Properties

IMemberData Property [getset]
 Describes the output property on the Step to which this Input is connected.

 
string? PropertyName [getset]
 Gets or sets the name of the property to which this Input is connected. Used for serialization.
 
ITestStep Step [getset]
 Gets or sets the TestStep that has the output property to which this Input is connected.
 
Value [get]
 Gets the value of the connected output property. More...
 
- Properties inherited from OpenTap.IInput
ITestStep Step [getset]
 Gets or sets the TestStep that has the output property to which this Input is connected.
 
IMemberData Property [getset]
 Describes the OutputAttribute property on the Step to which this Input is connected.
 

Detailed Description


A generic type that specifies input properties for a TestStep. The user can link this property to properties on other TestSteps that are marked with the OutputAttribute When used in a TestStep, Input value should always be set in the constructor.

Template Parameters
TGeneric type parameter.

Member Function Documentation

◆ Equals()

override bool OpenTap.Input< T >.Equals ( object  obj)
inline

Compares one Input to another.

Parameters
obj
Returns

◆ GetHashCode()

override int OpenTap.Input< T >.GetHashCode ( )
inline

Gets the hash code.

Returns

◆ operator!=()

static bool OpenTap.Input< T >.operator!= ( Input< T >  a,
Input< T >  b 
)
static

Compares two Input for inequality.

Returns

◆ operator==()

static bool OpenTap.Input< T >.operator== ( Input< T >  a,
Input< T >  b 
)
static

Compares two Input for equality.

Returns

◆ SupportsType()

virtual bool OpenTap.Input< T >.SupportsType ( ITypeData  concreteType)
inlinevirtual

Returns true if this input supports the concrete type.

Parameters
concreteType
Returns

Implements OpenTap.IInputTypeRestriction.

◆ ToString()

override string OpenTap.Input< T >.ToString ( )

Converts the value of this instance to its equivalent string representation.

Returns
The string representation of the value of this instance.

Property Documentation

◆ Value

T OpenTap.Input< T >.Value
get

Gets the value of the connected output property.

Exceptions
ExceptionThrown when this Input does not contain a reference to a TestStep output.

OpenTAP 9.24 API built Tue Apr 30 2024 13:44:41