Provides convenience methods for updating collections in responses to securities changed events More...

Static Public Member Functions
static void	UpdateCollection (ICollection< Security > securities, SecurityChanges changes)
	Adds and removes the security changes to/from the collection More...

static void	UpdateCollection< TValue > (ICollection< TValue > securities, SecurityChanges changes, Func< Security, TValue > valueFactory)
	Adds and removes the security changes to/from the collection More...

static void	UpdateDictionary< TValue > (IDictionary< Security, TValue > dictionary, SecurityChanges changes, Func< Security, TValue > valueFactory)
	Adds and removes the security changes to/from the collection More...

static void	UpdateDictionary< TValue > (IDictionary< Symbol, TValue > dictionary, SecurityChanges changes, Func< Security, TValue > valueFactory)
	Adds and removes the security changes to/from the collection More...

static void	UpdateDictionary< TKey, TValue > (IDictionary< TKey, TValue > dictionary, SecurityChanges changes, Func< Security, TKey > keyFactory, Func< Security, TValue > valueFactory)
	Most generic form of UpdateCollection More...

static void	Update (SecurityChanges changes, Action< Security > add, Action< Security > remove)
	Invokes the provided add and remove functions for each More...

Detailed Description

Provides convenience methods for updating collections in responses to securities changed events

Definition at line 27 of file NotifiedSecurityChanges.cs.

Member Function Documentation

◆ UpdateCollection()

static void QuantConnect.Algorithm.Framework.NotifiedSecurityChanges.UpdateCollection	(	ICollection< Security >	securities,
		SecurityChanges	changes
	)

static

Adds and removes the security changes to/from the collection

Parameters

securities	The securities collection to be updated with the changes
changes	The changes to be applied to the securities collection

Definition at line 34 of file NotifiedSecurityChanges.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateCollection< TValue >()

static void QuantConnect.Algorithm.Framework.NotifiedSecurityChanges.UpdateCollection< TValue >	(	ICollection< TValue >	securities,
		SecurityChanges	changes,
		Func< Security, TValue >	valueFactory
	)

static

Adds and removes the security changes to/from the collection

Parameters

securities	The securities collection to be updated with the changes
changes	The changes to be applied to the securities collection
valueFactory	Delegate used to create instances of TValue from a Security object

Definition at line 45 of file NotifiedSecurityChanges.cs.

Here is the call graph for this function:

◆ UpdateDictionary< TValue >() [1/2]

static void QuantConnect.Algorithm.Framework.NotifiedSecurityChanges.UpdateDictionary< TValue >	(	IDictionary< Security, TValue >	dictionary,
		SecurityChanges	changes,
		Func< Security, TValue >	valueFactory
	)

static

Adds and removes the security changes to/from the collection

Parameters

dictionary	The securities collection to be updated with the changes
changes	The changes to be applied to the securities collection
valueFactory	Factory for creating dictonary values for a key

Definition at line 56 of file NotifiedSecurityChanges.cs.

◆ UpdateDictionary< TValue >() [2/2]

static void QuantConnect.Algorithm.Framework.NotifiedSecurityChanges.UpdateDictionary< TValue >	(	IDictionary< Symbol, TValue >	dictionary,
		SecurityChanges	changes,
		Func< Security, TValue >	valueFactory
	)

static

Adds and removes the security changes to/from the collection

Parameters

dictionary	The securities collection to be updated with the changes
changes	The changes to be applied to the securities collection
valueFactory	Factory for creating dictonary values for a key

Definition at line 71 of file NotifiedSecurityChanges.cs.

◆ UpdateDictionary< TKey, TValue >()

static void QuantConnect.Algorithm.Framework.NotifiedSecurityChanges.UpdateDictionary< TKey, TValue >	(	IDictionary< TKey, TValue >	dictionary,
		SecurityChanges	changes,
		Func< Security, TKey >	keyFactory,
		Func< Security, TValue >	valueFactory
	)

static

Most generic form of UpdateCollection

Template Parameters

TKey	The dictionary's key type
TValue	The dictionary's value type

Parameters

dictionary	The dictionary to update
changes	The See also SecurityChanges to apply to the dictionary
keyFactory	Selector pulling TKey from a See also Security
valueFactory	Selector pulling TValue from a See also Security

Definition at line 89 of file NotifiedSecurityChanges.cs.

Here is the call graph for this function:

◆ Update()

static void QuantConnect.Algorithm.Framework.NotifiedSecurityChanges.Update	(	SecurityChanges	changes,
		Action< Security >	add,
		Action< Security >	remove
	)

static

Invokes the provided add and remove functions for each

Parameters

changes	The security changes to process
add	Function called for each added security
remove	Function called for each removed security

Definition at line 116 of file NotifiedSecurityChanges.cs.

Here is the caller graph for this function:

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

Algorithm.Framework/NotifiedSecurityChanges.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ UpdateCollection()

◆ UpdateCollection< TValue >()

◆ UpdateDictionary< TValue >() [1/2]

◆ UpdateDictionary< TValue >() [2/2]

◆ UpdateDictionary< TKey, TValue >()

◆ Update()