Class ScalarDataVariable

Inheritance
object
ScalarDataVariable
Implements
Namespace: IVLab.ABREngine
Assembly: IVLab.ABREngine.Runtime.dll
Syntax
public class ScalarDataVariable : IDataVariable<float>, IABRInput, IHasDataset

Properties

| Improve this Doc View Source

CustomizedRange

Have this var's ranges been customized?

Declaration
public bool CustomizedRange { get; set; }
Property Value
Type Description
bool
| Improve this Doc View Source

Genre

"Genre" of the input - is it Data, a visual element, or something else?

Declaration
public ABRInputGenre Genre { get; }
Property Value
Type Description
ABRInputGenre
| Improve this Doc View Source

OriginalRange

Save the original range in case the user wants to reset it later.

Declaration
public DataRange<float> OriginalRange { get; set; }
Property Value
Type Description
DataRange<float>
| Improve this Doc View Source

Path

The DataPath that represents this variable

Declaration
public string Path { get; }
Property Value
Type Description
string
| Improve this Doc View Source

Range

Range is calculated by the DataManager when it imports a new dataset. Range is calculated from the smallest/largest values encountered across every instance of this variable, across all datasets.

Declaration
public DataRange<float> Range { get; set; }
Property Value
Type Description
DataRange<float>
| Improve this Doc View Source

SpecificRanges

Dictionary of keyData paths that have specific ranges for this variable

Declaration
public Dictionary<string, DataRange<float>> SpecificRanges { get; set; }
Property Value
Type Description
Dictionary<string, DataRange<float>>

Methods

| Improve this Doc View Source

GetArray(KeyData)

Get the actual data values in the context of this particular Key Data object

Declaration
public float[] GetArray(KeyData keyData)
Parameters
Type Name Description
KeyData keyData
Returns
Type Description
float[]
| Improve this Doc View Source

GetDataset()

Declaration
public Dataset GetDataset()
Returns
Type Description
Dataset
| Improve this Doc View Source

GetRawABRInput()

Get the "raw" ABR input - the one that is represented in the state JSON

Declaration
public RawABRInput GetRawABRInput()
Returns
Type Description
RawABRInput
| Improve this Doc View Source

IsPartOf(KeyData)

Determine if this variable is a part of the key data

Declaration
public bool IsPartOf(KeyData keyData)
Parameters
Type Name Description
KeyData keyData
Returns
Type Description
bool

Implements