Lean  $LEAN_TAG$
QuantConnect.Data.Market.Bar Class Reference

Base Bar Class: Open, High, Low, Close and Period. More...

Inheritance diagram for QuantConnect.Data.Market.Bar:
[legend]

Public Member Functions

 Bar ()
 Default initializer to setup an empty bar. More...
 
 Bar (decimal open, decimal high, decimal low, decimal close)
 Initializer to setup a bar with a given information. More...
 
void Update (decimal value)
 Updates the bar with a new value. This will aggregate the OHLC bar More...
 
void Update (ref decimal value)
 Updates the bar with a new value. This will aggregate the OHLC bar More...
 
Bar Clone ()
 Returns a clone of this bar More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Properties

virtual decimal Open [get, set]
 Opening price of the bar: Defined as the price at the start of the time period. More...
 
virtual decimal High [get, set]
 High price of the bar during the time period. More...
 
virtual decimal Low [get, set]
 Low price of the bar during the time period. More...
 
virtual decimal Close [get, set]
 Closing price of the bar. Defined as the price at Start Time + TimeSpan. More...
 
- Properties inherited from QuantConnect.Data.Market.IBar
decimal Open [get]
 Opening price of the bar: Defined as the price at the start of the time period. More...
 
decimal High [get]
 High price of the bar during the time period. More...
 
decimal Low [get]
 Low price of the bar during the time period. More...
 
decimal Close [get]
 Closing price of the bar. Defined as the price at Start Time + TimeSpan. More...
 

Detailed Description

Base Bar Class: Open, High, Low, Close and Period.

Definition at line 25 of file Bar.cs.

Constructor & Destructor Documentation

◆ Bar() [1/2]

QuantConnect.Data.Market.Bar.Bar ( )

Default initializer to setup an empty bar.

Definition at line 56 of file Bar.cs.

Here is the caller graph for this function:

◆ Bar() [2/2]

QuantConnect.Data.Market.Bar.Bar ( decimal  open,
decimal  high,
decimal  low,
decimal  close 
)

Initializer to setup a bar with a given information.

Parameters
openDecimal Opening Price
highDecimal High Price of this bar
lowDecimal Low Price of this bar
closeDecimal Close price of this bar

Definition at line 67 of file Bar.cs.

Member Function Documentation

◆ Update() [1/2]

void QuantConnect.Data.Market.Bar.Update ( decimal  value)

Updates the bar with a new value. This will aggregate the OHLC bar

Parameters
valueThe new value

Definition at line 81 of file Bar.cs.

Here is the caller graph for this function:

◆ Update() [2/2]

void QuantConnect.Data.Market.Bar.Update ( ref decimal  value)

Updates the bar with a new value. This will aggregate the OHLC bar

Parameters
valueThe new value

Definition at line 91 of file Bar.cs.

◆ Clone()

Bar QuantConnect.Data.Market.Bar.Clone ( )

Returns a clone of this bar

Definition at line 109 of file Bar.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ToString()

override string QuantConnect.Data.Market.Bar.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

<filterpriority>2</filterpriority>

Definition at line 117 of file Bar.cs.

Property Documentation

◆ Open

virtual decimal QuantConnect.Data.Market.Bar.Open
getset

Opening price of the bar: Defined as the price at the start of the time period.

Definition at line 33 of file Bar.cs.

◆ High

virtual decimal QuantConnect.Data.Market.Bar.High
getset

High price of the bar during the time period.

Definition at line 39 of file Bar.cs.

◆ Low

virtual decimal QuantConnect.Data.Market.Bar.Low
getset

Low price of the bar during the time period.

Definition at line 45 of file Bar.cs.

◆ Close

virtual decimal QuantConnect.Data.Market.Bar.Close
getset

Closing price of the bar. Defined as the price at Start Time + TimeSpan.

Definition at line 51 of file Bar.cs.


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