Lean  $LEAN_TAG$
QuantConnect.Data.UniverseSelection.FineFundamentalUniverse Class Reference

Defines a universe that reads fine us equity data More...

Inheritance diagram for QuantConnect.Data.UniverseSelection.FineFundamentalUniverse:
[legend]

Public Member Functions

 FineFundamentalUniverse (UniverseSettings universeSettings, Func< IEnumerable< FineFundamental >, IEnumerable< Symbol >> selector)
 Initializes a new instance of the FineFundamentalUniverse class More...
 
 FineFundamentalUniverse (Symbol symbol, UniverseSettings universeSettings, Func< IEnumerable< FineFundamental >, IEnumerable< Symbol >> selector)
 Initializes a new instance of the FineFundamentalUniverse class More...
 
override IEnumerable< SymbolSelectSymbols (DateTime utcTime, BaseDataCollection data)
 Performs universe selection using the data specified More...
 
- Public Member Functions inherited from QuantConnect.Data.UniverseSelection.Universe
virtual bool CanRemoveMember (DateTime utcTime, Security security)
 Determines whether or not the specified security can be removed from this universe. This is useful to prevent securities from being taken out of a universe before the algorithm has had enough time to make decisions on the security More...
 
IEnumerable< SymbolPerformSelection (DateTime utcTime, BaseDataCollection data)
 Performs universe selection using the data specified More...
 
virtual Security CreateSecurity (Symbol symbol, IAlgorithm algorithm, MarketHoursDatabase marketHoursDatabase, SymbolPropertiesDatabase symbolPropertiesDatabase)
 Creates and configures a security for the specified symbol More...
 
virtual IEnumerable< SubscriptionRequestGetSubscriptionRequests (Security security, DateTime currentTimeUtc, DateTime maximumEndTimeUtc)
 Gets the subscription requests to be added for the specified security More...
 
virtual IEnumerable< SubscriptionRequestGetSubscriptionRequests (Security security, DateTime currentTimeUtc, DateTime maximumEndTimeUtc, ISubscriptionDataConfigService subscriptionService)
 Gets the subscription requests to be added for the specified security More...
 
bool ContainsMember (Symbol symbol)
 Determines whether or not the specified symbol is currently a member of this universe More...
 
virtual void Dispose ()
 Marks this universe as disposed and ready to remove all child subscriptions More...
 

Static Public Member Functions

static SubscriptionDataConfig CreateConfiguration (Symbol symbol)
 Creates a FineFundamental subscription configuration for the US-equity market More...
 

Additional Inherited Members

- Public Attributes inherited from QuantConnect.Data.UniverseSelection.Universe
SecurityType SecurityType => Configuration.SecurityType
 Gets the security type of this universe More...
 
string Market => Configuration.Market
 Gets the market of this universe More...
 
Symbol Symbol => Configuration.Symbol
 Gets the symbol of this universe More...
 
Type DataType => Configuration.Type
 Gets the data type of this universe More...
 
- Static Public Attributes inherited from QuantConnect.Data.UniverseSelection.Universe
static readonly UnchangedUniverse Unchanged = UnchangedUniverse.Instance
 Gets a value indicating that no change to the universe should be made More...
 
- Protected Member Functions inherited from QuantConnect.Data.UniverseSelection.Universe
 Universe (SubscriptionDataConfig config)
 Initializes a new instance of the Universe class More...
 
void OnSelectionChanged (HashSet< Symbol > selection=null)
 Event invocator for the SelectionChanged event More...
 
- Properties inherited from QuantConnect.Data.UniverseSelection.Universe
virtual ConcurrentDictionary< Symbol, MemberSecurities [get]
 Gets the internal security collection used to define membership in this universe More...
 
HashSet< SymbolSelected [get, set]
 The currently selected symbol set More...
 
virtual bool Asynchronous [get, set]
 True if this universe filter can run async in the data stack More...
 
virtual bool DisposeRequested [get, protected set]
 Flag indicating if disposal of this universe has been requested More...
 
virtual UniverseSettings UniverseSettings [get, set]
 Gets the settings used for subscriptions added for this universe More...
 
virtual SubscriptionDataConfig Configuration [get]
 Gets the configuration used to get universe data More...
 
Dictionary< Symbol, SecurityMembers [get]
 Gets the current listing of members in this universe. Modifications to this dictionary do not change universe membership. More...
 
- Events inherited from QuantConnect.Data.UniverseSelection.Universe
EventHandler SelectionChanged
 Event fired when the universe selection has changed More...
 

Detailed Description

Defines a universe that reads fine us equity data

Definition at line 26 of file FineFundamentalUniverse.cs.

Constructor & Destructor Documentation

◆ FineFundamentalUniverse() [1/2]

QuantConnect.Data.UniverseSelection.FineFundamentalUniverse.FineFundamentalUniverse ( UniverseSettings  universeSettings,
Func< IEnumerable< FineFundamental >, IEnumerable< Symbol >>  selector 
)

Initializes a new instance of the FineFundamentalUniverse class

Parameters
universeSettingsThe settings used for new subscriptions generated by this universe
selectorReturns the symbols that should be included in the universe

Definition at line 35 of file FineFundamentalUniverse.cs.

◆ FineFundamentalUniverse() [2/2]

QuantConnect.Data.UniverseSelection.FineFundamentalUniverse.FineFundamentalUniverse ( Symbol  symbol,
UniverseSettings  universeSettings,
Func< IEnumerable< FineFundamental >, IEnumerable< Symbol >>  selector 
)

Initializes a new instance of the FineFundamentalUniverse class

Parameters
symbolDefines the symbol to use for this universe
universeSettingsThe settings used for new subscriptions generated by this universe
selectorReturns the symbols that should be included in the universe

Definition at line 48 of file FineFundamentalUniverse.cs.

Member Function Documentation

◆ SelectSymbols()

override IEnumerable<Symbol> QuantConnect.Data.UniverseSelection.FineFundamentalUniverse.SelectSymbols ( DateTime  utcTime,
BaseDataCollection  data 
)
virtual

Performs universe selection using the data specified

Parameters
utcTimeThe current utc time
dataThe symbols to remain in the universe
Returns
The data that passes the filter

Implements QuantConnect.Data.UniverseSelection.Universe.

Definition at line 61 of file FineFundamentalUniverse.cs.

◆ CreateConfiguration()

static SubscriptionDataConfig QuantConnect.Data.UniverseSelection.FineFundamentalUniverse.CreateConfiguration ( Symbol  symbol)
static

Creates a FineFundamental subscription configuration for the US-equity market

Parameters
symbolThe symbol used in the returned configuration
Returns
A fine fundamental subscription configuration with the specified symbol

Definition at line 71 of file FineFundamentalUniverse.cs.

Here is the call graph for this function:

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