Dividend event from a security More...

Inheritance diagram for QuantConnect.Data.Market.Dividend:

Public Member Functions
	Dividend ()
	Initializes a new instance of the Dividend class More...

	Dividend (Symbol symbol, DateTime date, decimal distribution, decimal referencePrice)
	Initializes a new instance of the Dividend class More...

override BaseData	Reader (SubscriptionDataConfig config, string line, DateTime date, bool isLiveMode)
	Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called. More...

override SubscriptionDataSource	GetSource (SubscriptionDataConfig config, DateTime date, bool isLiveMode)
	Return the URL string source of the file. This will be converted to a stream More...

override BaseData	Clone ()
	Return a new instance clone of this object, used in fill forward More...

override string	ToString ()
	Formats a string with the symbol and value. More...

Public Member Functions inherited from QuantConnect.Data.BaseData
	BaseData ()
	Constructor for initialising the dase data class More...

virtual BaseData	Reader (SubscriptionDataConfig config, StreamReader stream, DateTime date, bool isLiveMode)
	Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called. The returned object is assumed to be time stamped in the config.ExchangeTimeZone. More...

virtual bool	RequiresMapping ()
	Indicates if there is support for mapping More...

virtual bool	IsSparseData ()
	Indicates that the data set is expected to be sparse More...

virtual bool	ShouldCacheToSecurity ()
	Indicates whether this contains data that should be stored in the security cache More...

virtual Resolution	DefaultResolution ()
	Gets the default resolution for this data and security type More...

virtual List< Resolution >	SupportedResolutions ()
	Gets the supported resolution for this data and security type More...

virtual DateTimeZone	DataTimeZone ()
	Specifies the data time zone for this data type. This is useful for custom data types More...

void	UpdateTrade (decimal lastTrade, decimal tradeSize)
	Updates this base data with a new trade More...

void	UpdateQuote (decimal bidPrice, decimal bidSize, decimal askPrice, decimal askSize)
	Updates this base data with new quote information More...

void	UpdateBid (decimal bidPrice, decimal bidSize)
	Updates this base data with the new quote bid information More...

void	UpdateAsk (decimal askPrice, decimal askSize)
	Updates this base data with the new quote ask information More...

virtual void	Update (decimal lastTrade, decimal bidPrice, decimal askPrice, decimal volume, decimal bidSize, decimal askSize)
	Update routine to build a bar/tick from a data update. More...

virtual BaseData	Clone (bool fillForward)
	Return a new instance clone of this object, used in fill forward More...

override string	ToString ()
	Formats a string with the symbol and value. More...

virtual BaseData	Reader (SubscriptionDataConfig config, string line, DateTime date, DataFeedEndpoint datafeed)
	Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called. More...

virtual string	GetSource (SubscriptionDataConfig config, DateTime date, DataFeedEndpoint datafeed)
	Return the URL string source of the file. This will be converted to a stream More...

Static Public Member Functions
static Dividend	Create (Symbol symbol, DateTime date, decimal referencePrice, decimal priceFactorRatio, int decimalPlaces=2)
	Initializes a new instance of the Dividend class More...

static decimal	ComputeDistribution (decimal close, decimal priceFactorRatio, int decimalPlaces)
	Computes the price factor ratio given the previous day's closing price and the p More...

Static Public Member Functions inherited from QuantConnect.Data.BaseData
static IEnumerable< BaseData >	DeserializeMessage (string serialized)
	Deserialize the message from the data server More...

Properties
decimal	Distribution `[get, set]`
	Gets the dividend payment More...

decimal	ReferencePrice `[get, set]`
	Gets the price at which the dividend occurred. This is typically the previous day's closing price More...

Properties inherited from QuantConnect.Data.BaseData
MarketDataType	DataType = MarketDataType.Base `[get, set]`
	Market Data Type of this data - does it come in individual price packets or is it grouped into OHLC. More...

bool	IsFillForward `[get]`
	True if this is a fill forward piece of data More...

DateTime	Time `[get, set]`
	Current time marker of this data packet. More...

virtual DateTime	EndTime `[get, set]`
	The end time of this data. Some data covers spans (trade bars) and as such we want to know the entire time span covered More...

Symbol	Symbol = Symbol.Empty `[get, set]`
	Symbol representation for underlying Security More...

virtual decimal	Value `[get, set]`
	Value representation of this data packet. All data requires a representative value for this moment in time. For streams of data this is the price now, for OHLC packets this is the closing price. More...

Properties inherited from QuantConnect.Data.IBaseData
MarketDataType	DataType `[get, set]`
	Market Data Type of this data - does it come in individual price packets or is it grouped into OHLC. More...

DateTime	Time `[get, set]`
	Time keeper of data – all data is timeseries based. More...

DateTime	EndTime `[get, set]`
	End time of data More...

Symbol	Symbol `[get, set]`
	Symbol for underlying Security More...

decimal	Value `[get, set]`
	All timeseries data is a time-value pair: More...

decimal	Price `[get]`
	Alias of Value. More...

Additional Inherited Members
Public Attributes inherited from QuantConnect.Data.BaseData
virtual decimal	Price => Value
	As this is a backtesting platform we'll provide an alias of value as price. More...

Static Protected Attributes inherited from QuantConnect.Data.BaseData
static readonly List< Resolution >	AllResolutions
	A list of all Resolution More...

static readonly List< Resolution >	DailyResolution = new List<Resolution> { Resolution.Daily }
	A list of Resolution.Daily More...

static readonly List< Resolution >	MinuteResolution = new List<Resolution> { Resolution.Minute }
	A list of Resolution.Minute More...

static readonly List< Resolution >	HighResolution = new List<Resolution> { Resolution.Minute, Resolution.Second, Resolution.Tick }
	A list of high Resolution, including minute, second, and tick. More...

static readonly List< Resolution >	OptionResolutions = new List<Resolution> { Resolution.Daily, Resolution.Hour, Resolution.Minute }
	A list of resolutions support by Options More...

Detailed Description

Dividend event from a security

Definition at line 27 of file Dividend.cs.

Constructor & Destructor Documentation

◆ Dividend() [1/2]

QuantConnect.Data.Market.Dividend.Dividend ( )

Initializes a new instance of the Dividend class

Definition at line 53 of file Dividend.cs.

Here is the caller graph for this function:

◆ Dividend() [2/2]

QuantConnect.Data.Market.Dividend.Dividend	(	Symbol	symbol,
		DateTime	date,
		decimal	distribution,
		decimal	referencePrice
	)

Initializes a new instance of the Dividend class

Parameters

symbol	The symbol
date	The date
distribution	The dividend amount
referencePrice	The previous day's closing price

Definition at line 65 of file Dividend.cs.

Member Function Documentation

◆ Create()

static Dividend QuantConnect.Data.Market.Dividend.Create	(	Symbol	symbol,
		DateTime	date,
		decimal	referencePrice,
		decimal	priceFactorRatio,
		int	decimalPlaces = `2`
	)

static

Initializes a new instance of the Dividend class

Parameters

symbol	The symbol
date	The date
referencePrice	The previous day's closing price
priceFactorRatio	The ratio of the price factors, pf_i/pf_i+1
decimalPlaces	The number of decimal places to round the dividend's distribution to, defaulting to 2

Definition at line 82 of file Dividend.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ComputeDistribution()

static decimal QuantConnect.Data.Market.Dividend.ComputeDistribution	(	decimal	close,
		decimal	priceFactorRatio,
		int	decimalPlaces
	)

static

Computes the price factor ratio given the previous day's closing price and the p

Parameters

close	Previous day's closing price
priceFactorRatio	Price factor ratio pf_i/pf_i+1
decimalPlaces	The number of decimal places to round the result to, defaulting to 2

Returns: The distribution rounded to the specified number of decimal places, defaulting to 2

Definition at line 95 of file Dividend.cs.

Here is the caller graph for this function:

◆ Reader()

override BaseData QuantConnect.Data.Market.Dividend.Reader	(	SubscriptionDataConfig	config,
		string	line,
		DateTime	date,
		bool	isLiveMode
	)

virtual

Reader converts each line of the data source into BaseData objects. Each data type creates its own factory method, and returns a new instance of the object each time it is called.

Parameters

config	Subscription data config setup object
line	Line of the source document
date	Date of the requested data
isLiveMode	true if we're in live mode, false for backtesting mode

Returns: Instance of the T:BaseData object generated by this line of the CSV

Reimplemented from QuantConnect.Data.BaseData.

Definition at line 109 of file Dividend.cs.

◆ GetSource()

override SubscriptionDataSource QuantConnect.Data.Market.Dividend.GetSource	(	SubscriptionDataConfig	config,
		DateTime	date,
		bool	isLiveMode
	)

virtual

Return the URL string source of the file. This will be converted to a stream

Parameters

config	Configuration object
date	Date of this source file
isLiveMode	true if we're in live mode, false for backtesting mode

Returns: String URL of source file.

Reimplemented from QuantConnect.Data.BaseData.

Definition at line 122 of file Dividend.cs.

◆ Clone()

override BaseData QuantConnect.Data.Market.Dividend.Clone ( )

virtual

Return a new instance clone of this object, used in fill forward

This base implementation uses reflection to copy all public fields and properties

Returns: A clone of the current object

Reimplemented from QuantConnect.Data.BaseData.

Definition at line 135 of file Dividend.cs.

◆ ToString()

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

Formats a string with the symbol and value.

Returns: string - a string formatted as SPY: 167.753

Definition at line 153 of file Dividend.cs.

Property Documentation

◆ Distribution

decimal QuantConnect.Data.Market.Dividend.Distribution

getset

Gets the dividend payment

Definition at line 34 of file Dividend.cs.

◆ ReferencePrice

decimal QuantConnect.Data.Market.Dividend.ReferencePrice

getset

Gets the price at which the dividend occurred. This is typically the previous day's closing price

Definition at line 45 of file Dividend.cs.

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

Common/Data/Market/Dividend.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Dividend() [1/2]

◆ Dividend() [2/2]

Member Function Documentation

◆ Create()

◆ ComputeDistribution()

◆ Reader()

◆ GetSource()

◆ Clone()

◆ ToString()

Property Documentation

◆ Distribution

◆ ReferencePrice