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

A collection of parameters related to the results. More...

Inherits IReadOnlyList< ResultParameter >.

Public Member Functions

ResultParameter Find (string name)
 Gets a ResultParameter by name.
 
ResultParameter Find (string name, string group)
 Gets a ResultParameter by name.
 
ResultParameter Find ((string name, string group) key)
 Gets a ResultParameter by name.
 
 ResultParameters ()
 Initializes a new instance of the ResultParameters class.
 
 ResultParameters (IEnumerable< ResultParameter > items)
 Initializes a new instance of the ResultParameters class.
 
Dictionary< string, object > ToDictionary ()
 Returns a dictionary containing all the values in this list indexed by their ResultParameter.Name. More...
 
void Add (ResultParameter parameter)
 Adds a new element to the parameters. (synchronized).
 
void AddRange (IEnumerable< ResultParameter > parameters)
 Adds a range of result parameters (synchronized). More...
 
void Add (string group, string name, IConvertible value, MetaDataAttribute metaDataAttribute)
 Adds a new result parameter.
 

Static Public Member Functions

static ResultParameters GetMetadataFromObject (object res)
 Returns a ResultParameters list with one entry for every property on the inputted object decorated with MetaDataAttribute.
 
static ResultParameters GetComponentSettingsMetadata (bool expandComponentSettings=false)
 Returns a ResultParameters list with one entry for every property on every ComponentSettings implementation decorated with MetaDataAttribute.
 

Properties

ResultParameter this[int index] [get]
 Gets the parameter with the given index.
 
IConvertible? this[string name, string group] [getset]
 Gets the parameter with the key name.
 
IConvertible this[string name] [getset]
 Gets a named parameter specifying only name. This assumes that the empty group is being used. So it is the same as calling [name, ""]..
 
int Count [get]
 Returns the number of result parameters.
 

Detailed Description

A collection of parameters related to the results.

Member Function Documentation

◆ AddRange()

void OpenTap.ResultParameters.AddRange ( IEnumerable< ResultParameter parameters)
inline

Adds a range of result parameters (synchronized).

Parameters
parameters

◆ ToDictionary()

Dictionary< string, object > OpenTap.ResultParameters.ToDictionary ( )
inline

Returns a dictionary containing all the values in this list indexed by their ResultParameter.Name.

Returns

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