Lean  $LEAN_TAG$
QuantConnect.Data.Consolidators.CalendarInfo Struct Reference

Calendar Info for storing information related to the start and period of a consolidator More...

Public Member Functions

 CalendarInfo (DateTime start, TimeSpan period)
 Constructor for CalendarInfo; used for consolidation calendar More...
 
override string ToString ()
 Returns a string containing the Calendar start and the consolidation period More...
 
override bool Equals (object obj)
 Indicates whether the given object is equal to this object, this is, the Calendar start and consolidation period is the same for both More...
 
override int GetHashCode ()
 Returns the hash code for this object as an integer More...
 

Static Public Member Functions

static bool operator== (CalendarInfo left, CalendarInfo right)
 Indicates whether the given object is equal to this object, this is, the Calendar start and consolidation period is the same for both More...
 
static bool operator!= (CalendarInfo left, CalendarInfo right)
 Indicates whether the given object is equal to this object, this is, the Calendar start and consolidation period is the same for both More...
 

Public Attributes

readonly DateTime End => Start + Period
 Calendar End More...
 

Properties

DateTime Start [get]
 Calendar Start More...
 
TimeSpan Period [get]
 Consolidation Period More...
 

Detailed Description

Calendar Info for storing information related to the start and period of a consolidator

Definition at line 94 of file Calendar.cs.

Constructor & Destructor Documentation

◆ CalendarInfo()

QuantConnect.Data.Consolidators.CalendarInfo.CalendarInfo ( DateTime  start,
TimeSpan  period 
)

Constructor for CalendarInfo; used for consolidation calendar

Parameters
startCalendar Start
periodConsolidation Period

Definition at line 116 of file Calendar.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.Data.Consolidators.CalendarInfo.ToString ( )

Returns a string containing the Calendar start and the consolidation period

Definition at line 125 of file Calendar.cs.

◆ Equals()

override bool QuantConnect.Data.Consolidators.CalendarInfo.Equals ( object  obj)

Indicates whether the given object is equal to this object, this is, the Calendar start and consolidation period is the same for both

Definition at line 134 of file Calendar.cs.

Here is the caller graph for this function:

◆ GetHashCode()

override int QuantConnect.Data.Consolidators.CalendarInfo.GetHashCode ( )

Returns the hash code for this object as an integer

Definition at line 146 of file Calendar.cs.

◆ operator==()

static bool QuantConnect.Data.Consolidators.CalendarInfo.operator== ( CalendarInfo  left,
CalendarInfo  right 
)
static

Indicates whether the given object is equal to this object, this is, the Calendar start and consolidation period is the same for both

Definition at line 159 of file Calendar.cs.

Here is the call graph for this function:

◆ operator!=()

static bool QuantConnect.Data.Consolidators.CalendarInfo.operator!= ( CalendarInfo  left,
CalendarInfo  right 
)
static

Indicates whether the given object is equal to this object, this is, the Calendar start and consolidation period is the same for both

Definition at line 168 of file Calendar.cs.

Member Data Documentation

◆ End

readonly DateTime QuantConnect.Data.Consolidators.CalendarInfo.End => Start + Period

Calendar End

Definition at line 109 of file Calendar.cs.

Property Documentation

◆ Start

DateTime QuantConnect.Data.Consolidators.CalendarInfo.Start
get

Calendar Start

Definition at line 99 of file Calendar.cs.

◆ Period

TimeSpan QuantConnect.Data.Consolidators.CalendarInfo.Period
get

Consolidation Period

Definition at line 104 of file Calendar.cs.


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