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

External test plan parameters. More...

Public Member Functions

 ExternalParameters (TestPlan plan)
 Constructor for the ExternalParameters. More...
 
ExternalParameter Add (ITestStep step, IMemberData setting, string Name=null)
 Adds a step property to the external test plan parameters. More...
 
void Remove (ITestStep step, IMemberData propertyInfo, string name=null)
 Removes a step property from the external parameters. More...
 
void Clean ()
 Ensures that each entry test step is also present the test plan.
 
ExternalParameter Get (string externalParameterName)
 Gets an entry by name. More...
 
ExternalParameter Find (ITestStep step, IMemberData property)
 Finds the external parameter that is defined by 'step' and 'property'. If no external parameter is found null is returned. More...
 

Properties

IReadOnlyList< ExternalParameterEntries [get]
 Gets the list of external test plan parameters.
 

Detailed Description

External test plan parameters.

Constructor & Destructor Documentation

◆ ExternalParameters()

OpenTap.ExternalParameters.ExternalParameters ( TestPlan  plan)
inline

Constructor for the ExternalParameters.

Parameters
plan

Member Function Documentation

◆ Add()

ExternalParameter OpenTap.ExternalParameters.Add ( ITestStep  step,
IMemberData  setting,
string  Name = null 
)
inline

Adds a step property to the external test plan parameters.

Parameters
step
setting
Name

◆ Find()

ExternalParameter OpenTap.ExternalParameters.Find ( ITestStep  step,
IMemberData  property 
)
inline

Finds the external parameter that is defined by 'step' and 'property'. If no external parameter is found null is returned.

Parameters
step
property
Returns

◆ Get()

ExternalParameter OpenTap.ExternalParameters.Get ( string  externalParameterName)
inline

Gets an entry by name.

Parameters
externalParameterName
Returns

◆ Remove()

void OpenTap.ExternalParameters.Remove ( ITestStep  step,
IMemberData  propertyInfo,
string  name = null 
)
inline

Removes a step property from the external parameters.

Parameters
stepThe step owning the property.
propertyInfoThe property to remove.
nameUn-used parameter.

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