ATAS.Indicators.CandleSeriesTimeFrame Struct Reference

A candle series timeframe: aggregation type plus its numeric parameter (minutes, seconds, ticks, lots or price-range ticks depending on the type). Create instances via the factory methods. More...

Public Member Functions
override string	ToString ()

Static Public Member Functions
static CandleSeriesTimeFrame	Minutes (int minutes)
static CandleSeriesTimeFrame	Hours (int hours)
static CandleSeriesTimeFrame	Seconds (int seconds)
static CandleSeriesTimeFrame	Ticks (int ticks)
static CandleSeriesTimeFrame	Volume (int volume)
static CandleSeriesTimeFrame	Delta (int delta)
static CandleSeriesTimeFrame	Range (int ticks)
static CandleSeriesTimeFrame	Renko (int ticks)
static CandleSeriesTimeFrame	Daily ()
static CandleSeriesTimeFrame	Weekly ()

Properties
CandleSeriesPeriodType	PeriodType [get]
	The aggregation type.
int	Value [get]
	The aggregation parameter: minutes, seconds, ticks, lots or range/renko ticks. 1 for CandleSeriesPeriodType.Daily and CandleSeriesPeriodType.Weekly.
bool	IsChart [get]
	True for the "same as chart" sentinel (Chart, the default value): no fixed timeframe of its own, the consumer substitutes the chart's series.
TimeSpan?	TimeBasedDuration [get]
	The bar duration for time-based aggregation types (Minutes, Seconds, Daily, Weekly); null for the Chart sentinel and for event-based types (ticks, volume, delta, range, renko), whose bar duration is not fixed.
static CandleSeriesTimeFrame	Chart [get]
	The "same as chart" sentinel used by Indicator.CalculationTimeFrame: the indicator calculates on the chart's own series (default behavior).

Detailed Description

A candle series timeframe: aggregation type plus its numeric parameter (minutes, seconds, ticks, lots or price-range ticks depending on the type). Create instances via the factory methods.

Member Function Documentation

Daily()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Daily ( )

static

Delta()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Delta ( int  delta )

static

Hours()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Hours ( int  hours )

static

Minutes()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Minutes ( int  minutes )

static

Range()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Range ( int  ticks )

static

Renko()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Renko ( int  ticks )

static

Seconds()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Seconds ( int  seconds )

static

Ticks()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Ticks ( int  ticks )

static

ToString()

override string ATAS.Indicators.CandleSeriesTimeFrame.ToString

(

)

Volume()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Volume ( int  volume )

static

Weekly()

static CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Weekly ( )

static

Property Documentation

Chart

CandleSeriesTimeFrame ATAS.Indicators.CandleSeriesTimeFrame.Chart

staticget

The "same as chart" sentinel used by Indicator.CalculationTimeFrame: the indicator calculates on the chart's own series (default behavior).

IsChart

bool ATAS.Indicators.CandleSeriesTimeFrame.IsChart

get

True for the "same as chart" sentinel (Chart, the default value): no fixed timeframe of its own, the consumer substitutes the chart's series.

PeriodType

CandleSeriesPeriodType ATAS.Indicators.CandleSeriesTimeFrame.PeriodType

get

The aggregation type.

TimeBasedDuration

TimeSpan? ATAS.Indicators.CandleSeriesTimeFrame.TimeBasedDuration

get

The bar duration for time-based aggregation types (Minutes, Seconds, Daily, Weekly); null for the Chart sentinel and for event-based types (ticks, volume, delta, range, renko), whose bar duration is not fixed.

Value

int ATAS.Indicators.CandleSeriesTimeFrame.Value

get

The aggregation parameter: minutes, seconds, ticks, lots or range/renko ticks. 1 for CandleSeriesPeriodType.Daily and CandleSeriesPeriodType.Weekly.

---

The documentation for this struct was generated from the following file:

• CandleSeriesTimeFrame.cs