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

A member that represents a parameter. The parameter controls the value of a set of parameterized members. Parameterized members can be added/removed using IMemberData.Parameterize() and IMemberData.Unparameterize() More...

Inheritance diagram for OpenTap.ParameterMemberData:
OpenTap.IParameterMemberData OpenTap.IDynamicMemberData OpenTap.IMemberData OpenTap.IMemberData OpenTap.IReflectionData OpenTap.IReflectionData

Public Member Functions

object GetValue (object owner)
 Gets the value of this member.
 
void SetValue (object owner, object value)
 Sets the value of this member on the owner.
 
void Remove ()
 Completely removes the parameter from a type.
 

Properties

IEnumerable< object > Attributes [get]
 Gets the attributes on this member.
 
IEnumerable<(object Source, IMemberData Member)> ParameterizedMembers [get]
 The members and objects that make up the aggregation of this parameter.
 
ITypeData DeclaringType [get]
 The target object type.
 
ITypeData TypeDescriptor [get]
 The declared type of this property. This is the type of the first member added to the parameter. Subsequent members does not need to have the same type, but they should be conversion compatible. e.g if the first member is an int, subsequent members can be other numeric types or string as well.
 
bool Writable [get]
 If this member is writable. Usually true for parameters.
 
bool Readable [get]
 If this member is readable. Usually true for parameters.
 
string Name [get]
 The declared name of this parameter. This parameter can be referred to by this name. It may contain spaces etc.
 
- Properties inherited from OpenTap.IParameterMemberData
IEnumerable<(object Source, IMemberData Member)> ParameterizedMembers [get]
 The members controlled by this parameter.
 
- Properties inherited from OpenTap.IMemberData
ITypeData DeclaringType [get]
 The type on which this member is declared.
 
ITypeData TypeDescriptor [get]
 The underlying type of this member.
 
bool Writable [get]
 Gets if this member is writable.
 
bool Readable [get]
 Gets if this member is readable.
 
- Properties inherited from OpenTap.IReflectionData
IEnumerable< object > Attributes [get]
 The attributes of it.
 
string Name [get]
 The name of it.
 
- Properties inherited from OpenTap.IDynamicMemberData
bool IsDisposed [get]
 Returns true once the member can be safely ignored.
 

Detailed Description

A member that represents a parameter. The parameter controls the value of a set of parameterized members. Parameterized members can be added/removed using IMemberData.Parameterize() and IMemberData.Unparameterize()

The first member have special meaning since it decides which attributes the parameter will have. If the member is later removed from the parameter (unparameterized), the first additional member will take its place.

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