QuantConnect.Commands.Command Class Reference

Base generic dynamic command class More...

Inheritance diagram for QuantConnect.Commands.Command:

Public Member Functions
sealed override DynamicMetaObject	GetMetaObject (Expression parameter)
	Get the metaObject required for Dynamism. More...
object	SetProperty (string name, object value)
	Sets the property with the specified name to the value. This is a case-insensitve search. More...
object	GetProperty (string name)
	Gets the property's value with the specified name. This is a case-insensitve search. More...
virtual ? bool	Run (IAlgorithm algorithm)
	Run this command using the target algorithm More...
override string	ToString ()
	The string representation of this command More...

Properties
string	PayloadData [get, set]
	Useful to string representation in python More...

Detailed Description

Base generic dynamic command class

Definition at line 32 of file Command.cs.

Member Function Documentation

GetMetaObject()

sealed override DynamicMetaObject QuantConnect.Commands.Command.GetMetaObject

(

Expression

parameter

)

Get the metaObject required for Dynamism.

Definition at line 47 of file Command.cs.

SetProperty()

object QuantConnect.Commands.Command.SetProperty	(	string	name,
		object	value
	)

Sets the property with the specified name to the value. This is a case-insensitve search.

Parameters

name	The property name to set
value	The new property value

Returns

Returns the input value back to the caller

Definition at line 58 of file Command.cs.

GetProperty()

object QuantConnect.Commands.Command.GetProperty

(

string

name

)

Gets the property's value with the specified name. This is a case-insensitve search.

Parameters

name	The property name to access

Returns

object value of BaseData

Definition at line 79 of file Command.cs.

Run()

virtual ? bool QuantConnect.Commands.Command.Run ( IAlgorithm  algorithm )

virtual

Run this command using the target algorithm

Parameters

algorithm

The algorithm instance

Returns

True if success, false otherwise. Returning null will disable command feedback

Definition at line 107 of file Command.cs.

ToString()

override string QuantConnect.Commands.Command.ToString

(

)

The string representation of this command

Definition at line 115 of file Command.cs.

Property Documentation

PayloadData

string QuantConnect.Commands.Command.PayloadData

getsetprotected

Useful to string representation in python

Definition at line 42 of file Command.cs.

---

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

• Common/Commands/Command.cs