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

A class to store a column of data for a ResultTable. More...

Inheritance diagram for OpenTap.ResultColumn:
OpenTap.IResultColumn OpenTap.IData OpenTap.IAttributedObject OpenTap.IAttributedObject

Public Member Functions

GetValue< T > (int Index)
 Helper to access a strongly typed value in the Data array. More...
 
 ResultColumn (string name, Array data)
 Creates a new populated result column. More...
 
 ResultColumn (string name, Array data, params IParameter[] parameters)
 Creates a new result column with parameters attached.
 
ResultColumn AddParameters (params IParameter[] additionalParameters)
 Create a result column clone with additional parameters.
 

Properties

string Name [get]
 The name of the column.
 
Array Data [get]
 The data in the column.
 
TypeCode TypeCode [get]
 The TypeCode of data in the column.
 
string ObjectType [get]
 String describing the column.
 
IData Parent [get]
 The parent object of this column. Usually a Result Table. This value will get assigned during ResultProxy.Publish.
 
IParameters Parameters [get]
 The parameters attached to this column.
 
- Properties inherited from OpenTap.IResultColumn
Array Data [get]
 Data in the column.

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

 
string ObjectType [get]
 String describing this object.

 
- Properties inherited from OpenTap.IData
IData Parent [get]
 Parent of this object.
 
IParameters Parameters [get]
 All parameters that describes this object.
 

Detailed Description

A class to store a column of data for a ResultTable.

Constructor & Destructor Documentation

◆ ResultColumn()

OpenTap.ResultColumn.ResultColumn ( string  name,
Array  data 
)
inline

Creates a new populated result column.

Parameters
nameThe name of the column.
dataThe data of the column.

Member Function Documentation

◆ GetValue&lt; T &gt;()

T OpenTap.ResultColumn.GetValue< T > ( int  Index)
inline

Helper to access a strongly typed value in the Data array.

Template Parameters
T
Parameters
IndexIndex in the array.
Returns
Type Constraints
T :IConvertible 

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