Class ExoticCandleSeriesTimeFrame

Namespace

ATAS.Indicators

Assembly

ATAS.Indicators.dll

An exotic candle series timeframe. Create instances via the factory methods. Kept separate from CandleSeriesTimeFrame: these types carry extra parameters, and the common struct stays two-field forever.

Added in ATAS 8.0.15.

public sealed class ExoticCandleSeriesTimeFrame

Inheritance

object

ExoticCandleSeriesTimeFrame

Extension Methods

Extensions.ConvertToMyTrade<T>(T, Portfolio, Security, Action<MyTrade, T>)

LoggerHelper.DisposeLogger(object)

LoggerHelper.LogDebug(object, string, params object?[])

LoggerHelper.LogError(object, string, Exception, bool)

LoggerHelper.LogError(object, string, params object?[])

LoggerHelper.LogFatal(object, string, Exception, bool)

LoggerHelper.LogInfo(object, string, params object?[])

LoggerHelper.LogWarn(object, string, params object?[])

Properties

Probe

ReversalX probe value.

public int Probe { get; }

Property Value

int

TickReversal

RangeUS tick reversal.

public int TickReversal { get; }

Property Value

int

TickTrend

RangeUS tick trend.

public int TickTrend { get; }

Property Value

int

Type

The aggregation type.

public CandleSeriesExoticType Type { get; }

Property Value

CandleSeriesExoticType

Value

The primary parameter: range ticks for RangeX/XV/Z, open offset for RangeUS, reversal value for ReversalX.

public int Value { get; }

Property Value

int

Methods

RangeUS(int, int, int)

Creates a RangeUS timeframe.

public static ExoticCandleSeriesTimeFrame RangeUS(int openOffset, int tickTrend, int tickReversal)

Parameters

openOffset int

The open offset in ticks: after a session break the first candle opens at a price (in ticks) that is a multiple of this value; 0 opens at the first trade. Must not be negative.

tickTrend int

The move in ticks beyond the previous close, in the previous candle's direction, that closes a candle; must be positive.

tickReversal int

The move in ticks beyond the previous close, against the previous candle's direction, that closes a candle; must be positive.

Returns

ExoticCandleSeriesTimeFrame

The timeframe.

Exceptions

ArgumentOutOfRangeException

openOffset is negative, or tickTrend or tickReversal is zero or negative.

RangeX(int)

Creates a RangeX timeframe.

public static ExoticCandleSeriesTimeFrame RangeX(int ticks)

Parameters

ticks int

The range in ticks; must be positive.

Returns

ExoticCandleSeriesTimeFrame

The timeframe.

Exceptions

ArgumentOutOfRangeException

ticks is zero or negative.

RangeXV(int)

Creates a RangeXV timeframe.

public static ExoticCandleSeriesTimeFrame RangeXV(int ticks)

Parameters

ticks int

The range in ticks; must be positive.

Returns

ExoticCandleSeriesTimeFrame

The timeframe.

Exceptions

ArgumentOutOfRangeException

ticks is zero or negative.

RangeZ(int)

Creates a RangeZ timeframe.

public static ExoticCandleSeriesTimeFrame RangeZ(int ticks)

Parameters

ticks int

The range in ticks; must be positive.

Returns

ExoticCandleSeriesTimeFrame

The timeframe.

Exceptions

ArgumentOutOfRangeException

ticks is zero or negative.

ReversalX(int, int)

Creates a ReversalX timeframe.

public static ExoticCandleSeriesTimeFrame ReversalX(int value, int probe)

Parameters

value int

The reversal in ticks: a candle closes when price retraces this many ticks from its high (rising candle) or low (falling candle). Must be positive.

probe int

The minimum high-low range in ticks a candle must reach before it can close on a reversal; must not be negative.

Returns

ExoticCandleSeriesTimeFrame

The timeframe.

Exceptions

ArgumentOutOfRangeException

value is zero or negative, or probe is negative.

ToString()

Returns a short display name of the timeframe.

public override string ToString()

Returns

string

The type and its parameters, e.g. RangeX 10, RangeUS 4/2/6 (open offset/tick trend/tick reversal) or ReversalX 10/7 (value/probe).