TDIResult: TDIResult (R6 class constructor)

In n0Trader/TDI: R Trading Data Interface

TDIResult (R6 class constructor)

Description

Generic base class for TDI result(s) sub-classes (e.g. TDIInstrument).

Details

The TDI result(s) base class provides generic methods for results. Validation methods allow for a quick check of API implementation classes. These are recommended to be included in the tests for each API. The validation check assumes that properties with NA are optional.

Super class

TDI::baseTDI -> TDIResult

Methods

Public methods

• TDIResult$fields()

• TDIResult$validate()

• TDIResult$isValid()

Inherited methods

• TDI::baseTDI$initialize()

---

Method fields()

Return the properties of the object as a list.

Usage

TDIResult$fields(prop = NULL)

Arguments

prop

Optional property in recursive call.

Returns

List of object properties.

---

Method validate()

Validate the properties of the object. It is assumed that all NA properties are optional.

Usage

TDIResult$validate(prop)

Arguments

prop

Optional property in recursive call.

Returns

Vector with validation result.

---

Method isValid()

Check if the object properties are valid. A simple validation to check API implementation.

Usage

TDIResult$isValid()

Returns

Boolean as validation result.

n0Trader/TDI documentation built on July 30, 2023, 7:48 p.m.