QuantConnect.Algorithm.Framework.Alphas.InsightScore Class Reference

Defines the scores given to a particular insight More...

Public Member Functions
	InsightScore ()
	Initializes a new, default instance of the InsightScore class More...
	InsightScore (double direction, double magnitude, DateTime updatedTimeUtc)
	Initializes a new instance of the InsightScore class More...
void	SetScore (InsightScoreType type, double value, DateTime algorithmUtcTime)
	Sets the specified score type with the value More...
void	Finalize (DateTime algorithmUtcTime)
	Marks the score as finalized, preventing any further updates. More...
double	GetScore (InsightScoreType type)
	Gets the specified score More...
override string	ToString ()
	Returns a string that represents the current object. More...

Properties
DateTime	UpdatedTimeUtc [get]
	Gets the time these scores were last updated More...
double	Direction [get]
	Gets the direction score More...
double	Magnitude [get]
	Gets the magnitude score More...
bool	IsFinalScore [get]
	Gets whether or not this is the insight's final score More...

Detailed Description

Defines the scores given to a particular insight

Definition at line 25 of file InsightScore.cs.

Constructor & Destructor Documentation

InsightScore() [1/2]

QuantConnect.Algorithm.Framework.Alphas.InsightScore.InsightScore

(

)

Initializes a new, default instance of the InsightScore class

Definition at line 54 of file InsightScore.cs.

InsightScore() [2/2]

QuantConnect.Algorithm.Framework.Alphas.InsightScore.InsightScore	(	double	direction,
		double	magnitude,
		DateTime	updatedTimeUtc
	)

Initializes a new instance of the InsightScore class

Parameters

direction	The insight direction score
magnitude	The insight percent change score
updatedTimeUtc	The algorithm utc time these scores were computed

Definition at line 64 of file InsightScore.cs.

Member Function Documentation

SetScore()

void QuantConnect.Algorithm.Framework.Alphas.InsightScore.SetScore	(	InsightScoreType	type,
		double	value,
		DateTime	algorithmUtcTime
	)

Sets the specified score type with the value

Parameters

type	The score type to be set, Direction/Magnitude
value	The new value for the score
algorithmUtcTime	The algorithm's utc time at which time the new score was computed

Definition at line 77 of file InsightScore.cs.

Finalize()

void QuantConnect.Algorithm.Framework.Alphas.InsightScore.Finalize

(

DateTime

algorithmUtcTime

)

Marks the score as finalized, preventing any further updates.

Parameters

algorithmUtcTime

The algorithm's utc time at which time these scores were finalized

Definition at line 102 of file InsightScore.cs.

GetScore()

double QuantConnect.Algorithm.Framework.Alphas.InsightScore.GetScore

(

InsightScoreType

type

)

Gets the specified score

Parameters

type	The type of score to get, Direction/Magnitude

Returns

The requested score

Definition at line 113 of file InsightScore.cs.

ToString()

override string QuantConnect.Algorithm.Framework.Alphas.InsightScore.ToString

(

)

Returns a string that represents the current object.

Returns

A string that represents the current object.

<filterpriority>2</filterpriority>

Definition at line 131 of file InsightScore.cs.

Property Documentation

UpdatedTimeUtc

DateTime QuantConnect.Algorithm.Framework.Alphas.InsightScore.UpdatedTimeUtc

get

Gets the time these scores were last updated

Definition at line 31 of file InsightScore.cs.

Direction

double QuantConnect.Algorithm.Framework.Alphas.InsightScore.Direction

get

Gets the direction score

Definition at line 37 of file InsightScore.cs.

Magnitude

double QuantConnect.Algorithm.Framework.Alphas.InsightScore.Magnitude

get

Gets the magnitude score

Definition at line 43 of file InsightScore.cs.

IsFinalScore

bool QuantConnect.Algorithm.Framework.Alphas.InsightScore.IsFinalScore

get

Gets whether or not this is the insight's final score

Definition at line 49 of file InsightScore.cs.

---

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

• Common/Algorithm/Framework/Alphas/InsightScore.cs