OpenTAP 9.24
API Reference
Public Member Functions | Public Attributes | Properties | List of all members
OpenTap.ResultParameter Class Reference

Represents a result parameter. More...

Inheritance diagram for OpenTap.ResultParameter:
OpenTap.IParameter OpenTap.IAttributedObject

Public Member Functions

 ResultParameter (string name, IConvertible value)
 Creates a result parameter with default group.
 
 ResultParameter (string group, string name, IConvertible value, MetaDataAttribute metadata=null, int parentLevel=0)
 Initializes a new instance of ResultParameter.
 
 ResultParameter (string group, string name, IConvertible value, string macroName)
 Creates a new ResultParameter. More...
 
override bool Equals (object obj)
 Determines whether the specified object is equal to the current object. More...
 
override int GetHashCode ()
 Calculates a hash code for the current object. More...
 

Public Attributes

readonly string Name
 Name of parameter.
 
readonly string Group
 Group name of the parameter.
 
readonly IConvertible Value
 Value of the parameter. If null, the value is the string "NULL".

 
readonly int ParentLevel
 Indicates the parameter came from a test step in a parent level above the initial object.

 
readonly string MacroName
 null or the macro name representation of the ResultParameter. This will make it possible to insert the parameter value into a string. MacroString
 

Properties

bool IsMetaData [get]
 Gets if this result is metadata.
 
- Properties inherited from OpenTap.IParameter
string Group [get]
 Optional name of the group of parameters to which this parameter belongs.

 
IConvertible Value [get]
 Value of this parameter.

 
- Properties inherited from OpenTap.IAttributedObject
string Name [get]
 Name of this object.

 
string ObjectType [get]
 String describing this object.

 

Detailed Description

Represents a result parameter.

Constructor & Destructor Documentation

◆ ResultParameter()

OpenTap.ResultParameter.ResultParameter ( string  group,
string  name,
IConvertible  value,
string  macroName 
)
inline

Creates a new ResultParameter.

Parameters
group
name
value
macroName

Member Function Documentation

◆ Equals()

override bool OpenTap.ResultParameter.Equals ( object  obj)
inline

Determines whether the specified object is equal to the current object.

Parameters
obj
Returns

◆ GetHashCode()

override int OpenTap.ResultParameter.GetHashCode ( )
inline

Calculates a hash code for the current object.

Returns

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